Relatório de Entrega SMS (DLR)

POST

O evento ‘sms.delivery’ envia alterações no dlr_code. Isso permite que você descubra se uma mensagem SMS foi entregue com sucesso, rejeitada ou ainda está sendo entregue.

Cada SMS tem um código de relatório de entrega Notificações de webhook

Authorizations

• token

Request Body ^required

Media type application/json

object

id

Unique entity UUID

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

api_version

Versão da estrutura de dados do webhook de notificação

string

name

Nome do evento do Webhook

string

created_at

Timestamp when the entity was added to the system by the user

integer

attempt_total

Número total de tentativas de entrega de webhooks de notificação

integer

>= 1 <= 4

attempt_number

Número atual da tentativa de notificação do webhook

integer

>= 1

notification_task_id

Notification task identifier (request identifier)

string format: uuid

name

Allowed values: sms.delivery

data

Data for sms.delivery and sms.delivery.dryrun events

object

id

Unique entity UUID

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

key_id

Identificador da chave API

integer

>= 1

dlr_code

Status of the SMS delivery from gateway

integer

Allowed values: 0 1 2 4 8 16

status_code

Status of the sms. For more info see SMS status codes

integer

Allowed values: 0 100 208 400 410 2000 3000 5000 6000

callback_data

String which will be send back to your endpoint. E.g. it can be usable to pass your system message id.

string | null

<= 36 characters

Examples

Evento de Entrega SMS

Evento enviado quando o status de entrega do SMS muda

{
  "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8",
  "api_version": "2022-05-25",
  "name": "sms.delivery",
  "created_at": 1653378603,
  "attempt_total": 4,
  "attempt_number": 1,
  "data": {
    "id": "d6c12ac4-cc7d-11ec-b6da-525400bbb7dc",
    "key_id": 8207,
    "dlr_code": 1,
    "status_code": 100,
    "callback_data": "some data from user's request here"
  },
  "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641"
}

Evento de Entrega SMS Expirada

Evento enviado quando a entrega do SMS expira

{
  "id": "a3cd6e19-8af2-498d-ad07-c7840f1b4ac8",
  "api_version": "2022-05-25",
  "name": "sms.delivery",
  "created_at": 1653378603,
  "attempt_total": 4,
  "attempt_number": 1,
  "data": {
    "id": "d6c12ac4-cc7d-11ec-b6da-525400bbb7dc",
    "key_id": 8207,
    "dlr_code": 8,
    "status_code": 100,
    "callback_data": "order-12345"
  },
  "notification_task_id": "3378de83-de66-4de8-9d29-2b10d41bb641"
}

Responses

200

Webhook recebido

400

Estrutura do corpo do pedido de webhook inválido

401

Pedido de webhook não autorizado

403

Acesso proibido ao webhook

404

Acesso proibido ao webhook

500

Erro do servidor