ARararahq
Mensagens

Consultar mensagem

Devolve a mensagem no mesmo formato do envio, com status e reason atualizados. Em produção, prefira o webhook message.status_updated a consultar em laço.

Só devolve mensagens enviadas pelo mesmo usuário dono da chave. Mensagem de outro membro da organização responde 403 sem corpo, e ID inexistente responde 404 sem corpo. Para qualquer mensagem da organização, use GET /dashboard/messages/{id}.

Permissão: READ.

get/v1/messages/{id}

Request

Path parameters

idstring required
Example:ara_msg_k9Bf2Xq

ID da mensagem, como veio no campo id do envio (ex. ara_msg_k9Bf2Xq).

Response

Mensagem

idstring nullable

ID público da mensagem. Use para consultar e para casar com o webhook.

status'PENDING' | 'SCHEDULED' | 'PROCESSING' | 'SENT' | 'DELIVERED' | 'READ' | 'FAILED' | 'CANCELED' required

Estado atual, sempre em maiúsculas:

  • PENDING: criada, na fila.
  • SCHEDULED: agendada.
  • PROCESSING: em processamento.
  • SENT: aceita pelo provedor.
  • DELIVERED: entregue no aparelho.
  • READ: lida.
  • FAILED: falhou. Veja reason.
  • CANCELED: cancelada antes do envio.

O webhook message.status_updated usa os mesmos estados em minúsculas, com PENDING virando queued.

mode'LIVE' required

Todo envio por chave de API é LIVE.

senderstring required

Número que enviou.

receiverstring required

Número do destinatário.

bodystring nullable

Conteúdo final enviado, com as variáveis aplicadas. Pode vir null.

costnumber nullable

Custo em reais. Pode vir null. Os valores dos exemplos são ilustrativos.

reasonstring nullable

Motivo da falha quando status é FAILED.

Example response

{
  "id": "ara_msg_k9Bf2Xq",
  "status": "PENDING",
  "mode": "LIVE",
  "sender": "whatsapp:+5511888888888",
  "receiver": "whatsapp:+5511999999999",
  "body": "Oi João, seu pedido 12345 foi confirmado!",
  "cost": 0.068,
  "reason": null
}

Changes

No recorded changes to this operation across all 6 revisions of this API.