Skip to main content
GET
Consultar mensagem

Authorizations

Authorization
string
header
required

Chave de API da Arara (ara_live_...), enviada no header Authorization: Bearer ara_live_.... Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação.

Path Parameters

id
string
required

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

Example:

"ara_msg_k9Bf2Xq"

Response

Mensagem

status
enum<string>
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.

Available options:
PENDING,
SCHEDULED,
PROCESSING,
SENT,
DELIVERED,
READ,
FAILED,
CANCELED
mode
enum<string>
required

Todo envio por chave de API é LIVE.

Available options:
LIVE
sender
string
required

Número que enviou.

receiver
string
required

Número do destinatário.

id
string | null

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

Example:

"ara_msg_k9Bf2Xq"

body
string | null

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

cost
number | null

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

reason
string | null

Motivo da falha quando status é FAILED.