Mensagens

Visão geral

O módulo de Mensagens permite que você envie mensagens de qualquer um dos seus números de WhatsApp conectados e recupere o histórico de mensagens. Todas as mensagens são registradas e podem ser consultadas por direção, status, remetente ou destinatário.

Tipos de mensagem

TipoCampo do payloadDescrição
texttext.bodyMensagem de texto simples
templatetemplateTemplate de mensagem aprovado pelo WhatsApp
imageimageImagem (por Media ID ou URL)
documentdocumentPDF, Word, etc.
audioaudioArquivo de áudio
videovideoArquivo de vídeo
locationlocationCoordenadas de latitude/longitude
interactiveinteractiveBotões, listas, etc.

Enviando uma mensagem

POST /api/messages/send

O corpo da requisição deve incluir number_id, to, type e um campo correspondente ao type:

1{
2 "number_id": "clxyz123...",
3 "to": "5511999990000",
4 "type": "text",
5 "text": {
6 "body": "Olá! Como posso ajudar você hoje?"
7 }
8}

Idempotência

Adicione um header Idempotency-Key para evitar envios duplicados:

1POST /api/messages/send
2Idempotency-Key: <string-única>

Se uma requisição com a mesma chave for recebida dentro de 24 horas, a resposta original é retornada sem enviar outra mensagem.

Direções de mensagem

DireçãoDescrição
OUTBOUNDMensagens enviadas por você via API
INBOUNDMensagens recebidas dos usuários finais

Status de mensagem

StatusDescrição
sentAceita pelos servidores da Meta
deliveredEntregue ao dispositivo do destinatário
readLida pelo destinatário
failedFalha na entrega

Atualizações de status são entregues via eventos de webhook.

Consultando mensagens

$# Listar mensagens recebidas para um número específico
$curl "https://dev.muchau.com.br/api/messages?number_id=clxyz123...&direction=INBOUND&limit=50" \
> -H "Authorization: Bearer $MUCHAW_API_KEY"