Enviar mensagem

Envia texto, mídia ou template. Requer scope messages:send.

Idempotência obrigatória via client_message_id (único por organização). Retry com o mesmo id e mesmo body retorna 200 com deduplicated: true e não reenvia à Meta.

Informe thread_id ou to (resolve/cria contato + thread). O envio pela API não reabre conversa fechada nem altera atribuição.

POST https://api.aideskbr.com/api/public/v1/messages

cURL

text

curl --request POST \
  --url https://api.aideskbr.com/api/public/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_message_id": "crm-order-123-msg-1",
  "type": "text"
}
'

200

{
  "message_id": "26c1638a-949a-4e52-a8ea-228d325bc697",
  "thread_id": "11111111-1111-1111-1111-111111111111",
  "contact_id": "22222222-2222-2222-2222-222222222222",
  "delivery_state": "queued",
  "client_message_id": "crm-order-123-msg-1",
  "deduplicated": true
}

{
  "message_id": "26c1638a-949a-4e52-a8ea-228d325bc697",
  "thread_id": "11111111-1111-1111-1111-111111111111",
  "contact_id": "22222222-2222-2222-2222-222222222222",
  "delivery_state": "queued",
  "client_message_id": "crm-order-123-msg-1",
  "deduplicated": false
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "api_key_required",
    "message": "API key ausente"
  }
}

{
  "error": {
    "code": "missing_scope",
    "message": "Scope insuficiente"
  }
}

{
  "error": {
    "code": "idempotency_key_reused",
    "message": "client_message_id já usado com body diferente"
  }
}

{
  "error": {
    "code": "template_not_approved",
    "message": "Template não aprovado"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

Authorizations

bearerAuthapiKeyAuth

Authorization · string · header · required

Authorization: Bearer ak_live_

Body

application/json

client_message_id · string · required

Idempotência — único por organização

Required string length: 1 - 128

type · enum<string> · required

Available options: text, image, audio, video, document, template

channel_id · string<uuid>

UUID público do canal WhatsApp (recomendado)

thread_id · string<uuid>

UUID da conversa (um de thread_id ou to)

to · object

Hide child attributes

to. kind · enum<string> · required

Available options: whatsapp

to. handle · string · required

Número E.164 sem + (ex. 5511999998888)

Example:

"5511999998888"

text · object

Hide child attributes

text. body · string

media · object

Hide child attributes

media. s3_key · string

Preferencial — chave de upload prévio

media. url · string<uri>

URL pública HTTPS (anti-SSRF aplicado)

media. filename · string

Obrigatório/recomendado para document

media. mime_type · string

template · object

Hide child attributes

template. template_submission_id · string<uuid>

Preferencial — ID interno da submission

template. name · string

template. language · string

Example:

"pt_BR"

template. variables · object

Mapa de variáveis do template (ex. {"1":"Maria"})

Hide child attributes

template.variables. {key} · string

Response

200

application/json

Retry idempotente (deduplicado) ou re-enqueue stale

message_id · string<uuid> · required

thread_id · string<uuid> · required

contact_id · string<uuid> · required

delivery_state · string · required

Examples:

"queued"

"sent"

"delivered"

"read"

"failed"

client_message_id · string · required

deduplicated · boolean · required