Webhooks

Use webhooks to receive message events immediately in your system.

Two webhook types are available:

1. Delivery status webhook for outgoing messages.
2. Incoming message webhook for SMS and other supported channels.

1. Delivery status webhook

Configure this webhook in device settings to receive status updates without polling the API.

{
  "sms_id": int,
  "status_id": int,
  "status_message": string,
  "sendto": string,
  "senttime": datetime,
  "channel_id": int,
  "device_id": int
}

• 1 - Pendente por SMS
• 2 - SMS usado pelo telefone
• 3 - Enfileirado para envio. Certainly, it would have been more logical to place the status "queued for sending" before "SMS taken by phone," but for backward compatibility, the statuses are in the following order: 1, 3, 2."
• 5 - SMS de entrada
• 6 - SMS enviado por telefone
• 7 - O SMS foi entregue
• 8 - O SMS NÃO foi entregue
• 9 - O SMS não foi enviado - Falha genérica. (Leia o que fazer com esse erro Aqui)
• Outros erros menos comuns:
• 10 - SMS não enviado - No Service
• 11 - SMS não enviado - Null PDU
• 12 - SMS não enviado - Radio Off
• 100, 101 - SMS não enviado - NOT ALLOWED. (As permissões para o envio de SMS no aplicativo não foram concedidas)

2. Incoming message webhook

Configure this webhook to forward incoming messages to your CRM, helpdesk or backend.

{
  "address": string,
  "date": datetime,
  "date_sent": datetime,
  "body": string,
  "internal_id": int,
  "channel_id": int,
  "sms_id": int,
  "device_id": int,
  "device_name": string
}