Sign in
v1Messages

Send a message

Queues a message to a phone number through one of the workspace channels. Official WhatsApp channels (with waba_id) require a template for contacts outside the 24h window. Use the returned id with GET /v1/messages/queue/{id} to track delivery.

post/v1/messages/send

Request body

channelIdnumber required

Id do canal de envio

tostring required

Telefone no formato DDI+DDD+NUMERO (apenas dígitos). Caracteres não numéricos são removidos.

messagestring

Texto da mensagem. Obrigatório quando não há template nem callOptions.

hiddenboolean

Quando true, a conversa não é aberta para os atendentes (fica oculta/resolvida).

isMediaboolean

Quando true, message é tratada como URL de mídia.

executeAtstring

Agenda o envio para a data informada (ISO 8601).

externalIdstring

Identificador externo idempotente. Uma segunda chamada com o mesmo valor retorna 409.

Example request

{
  "channelId": 103,
  "to": "5585988887777",
  "message": "mensagem de teste",
  "callOptions": {
    "setGroupId": 10,
    "execAutoAttributionId": 8,
    "execBotId": 123,
    "contact": {
      "name": "Fulano",
      "email": "fulano@gmail.com"
    }
  },
  "template": {
    "id": "712287883441111",
    "name": "disparo_cnc",
    "language": "pt_BR",
    "bodyFields": [
      "Fulano",
      "10/10/2026"
    ]
  },
  "executeAt": "2020-01-01T15:04:41.004Z"
}

Response

idnumber required

Id da mensagem na fila. Use em GET /v1/messages/queue/{id}.

queuedboolean required

Example response

{
  "id": 123456,
  "queued": true
}

Changes

Changed in 1 of the 18 revisions of this API.1