Mensagens

Envie mensagens para o hub do parceiro dos usuários finais.

Enviar uma mensagem

POST /api/v1/messages

Cria uma mensagem de hub independente (não uma conversa de suporte).

Cabeçalhos

Authorization: Bearer <api_key>
Content-Type: application/json

Parâmetros do corpo

Campo	Tipo	Obrigatório	Descrição
phone	string	yes	Destino E.164
body	string	*	Corpo de texto / legenda (obrigatório para text)
content_type	string	não	Valor padrão: text. Consulte os tipos de mídia
template_code	string	não	Renderizado com vars
vars	object	não	Variáveis do modelo
priority	string	não	otp · notification · chat · …
idempotency_key	string	não	Deduplicar novas tentativas
media_url	string	*	URL de um arquivo remoto para tipos de mídia
media_base64	string	*	Arquivo base64 em vez da URL
media_filename	string	não	Nome para exibição
media_mimetype	string	não	Tipo MIME
link_url / url	string	*	Para content_type=link
link_label / cta	string	não	Rótulo do botão
link_title	string	não	Título do cartão
link_description	string	não	Descrição do cartão
link_image_url	string	não	Imagem do cartão
html	string	*	Para content_type=html
subject	string	não	Título da newsletter (html)
preview	string	não	Prévia em texto simples (html)

Exemplo de texto

curl -X POST "$API/messages" \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "+228XXXXXXXX",
    "body": "Votre dossier est en cours de traitement.",
    "priority": "notification",
    "idempotency_key": "seed-dossier-1001"
  }'

Resposta 201

{
  "message_id": 142,
  "ref": "52c22ee01478…",
  "phone": "+228XXXXXXXX",
  "partner": "seed",
  "direction": "out",
  "content_type": "text",
  "body": "Votre dossier est en cours de traitement.",
  "state": "delivered",
  "priority": "notification",
  "created_at": "2026-07-21 07:10:00"
}

Obter uma mensagem

GET /api/v1/messages/{message_id}

Retorna a mensagem e as tentativas de entrega opcionais.

Listar as mensagens

GET /api/v1/messages

Query	Descrição
phone	Filtrar pelo telefone da conta
state	queued · delivered · read · …
q	Buscar no corpo / contato
limit	Tamanho da página

Marcar como lida / não lida (ferramentas para parceiros)

POST /api/v1/messages/{id}/read
POST /api/v1/messages/{id}/unread
POST /api/v1/messages/read

Envio de chat por um agente

POST /api/v1/agent/messages

Usado pelos agentes do Partner Hub. Pode ser associado a uma conversa de suporte aberta quando aplicável. Prefira /messages para notificações automatizadas do hub.