curl --request POST \
--url https://{host}/channel-api/messages/send \
--header 'Content-Type: application/json' \
--header 'x-channel-api-key: <api-key>' \
--data '
{
"contact": {
"value": "554396647639",
"name": "Cliente"
},
"message": {
"type": "text",
"text": {
"value": "Olá! Sua fatura foi gerada."
}
},
"metadata": {
"erpInvoiceId": "123456"
}
}
'{
"requestId": "3f2b4c1e-8a9d-4e2f-b1c3-9d8e7f6a5b4c"
}{
"statusCode": 400,
"message": "Base64 payload is required",
"error": "Bad Request"
}{
"statusCode": 404,
"message": "Invalid API token",
"error": "Not Found"
}Enviar mensagem
Enfileira o envio de uma mensagem de texto, template ou mídia pelo canal associado à chave de API. O envio é assíncrono: a resposta retorna imediatamente um requestId para correlação, e o processamento acontece em background. O status de cada envio pode ser acompanhado nos logs da aba API do canal.
curl --request POST \
--url https://{host}/channel-api/messages/send \
--header 'Content-Type: application/json' \
--header 'x-channel-api-key: <api-key>' \
--data '
{
"contact": {
"value": "554396647639",
"name": "Cliente"
},
"message": {
"type": "text",
"text": {
"value": "Olá! Sua fatura foi gerada."
}
},
"metadata": {
"erpInvoiceId": "123456"
}
}
'{
"requestId": "3f2b4c1e-8a9d-4e2f-b1c3-9d8e7f6a5b4c"
}{
"statusCode": 400,
"message": "Base64 payload is required",
"error": "Bad Request"
}{
"statusCode": 404,
"message": "Invalid API token",
"error": "Not Found"
}Authorizations
Chave de API do canal, gerada na aba API das configurações do canal (Dashboard → Suporte → Canais). A chave é exibida uma única vez ao ser gerada; gerar uma nova invalida a anterior.
Body
Show child attributes
Show child attributes
Mensagem a ser enviada. O objeto correspondente ao type escolhido (text, template ou media) é obrigatório.
Show child attributes
Show child attributes
Identificador opcional de fluxo para correlação externa.
"flow-123"
Se true, encerra a conversa aberta do contato nesse canal antes de enviar a nova mensagem.
Metadados livres de correlação externa (chave/valor em string). Ficam registrados no log da requisição.
Show child attributes
Show child attributes
{ "erpInvoiceId": "123456" }
Response
Mensagem enfileirada com sucesso.
Identificador único da requisição, usado para correlação nos logs da aba API do canal.
"3f2b4c1e-8a9d-4e2f-b1c3-9d8e7f6a5b4c"