Informe de Entrega SMS (DLR)

POST

El evento ‘sms.delivery’ se activa cuando se producen cambios en el dlr_code. Esto te permite saber si un SMS se ha entregado correctamente, ha sido rechazado o aún se está entregando.

Cada SMS tiene un código de informe de entrega Tipos de transporte de acontecimientos

Authorizations

• token

Request Body ^required

Media type application/json

object

id

UUID único de entidad

string

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

api_version

Versión de la estructura de datos de notificación

string

name

Nombre del evento de Webhook

string

created_at

Fecha en la que se añadió la entidad al sistema por el usuario

integer

attempt_total

Número total de intentos de entrega de webhooks de notificación

integer

>= 1 <= 4

attempt_number

Número de intento de notificación webhook actual

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

UUID único de entidad

string

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

key_id

Identificador de clave API

integer

>= 1

dlr_code

Status of the SMS delivery desde gateway

integer

Allowed values: 0 1 2 4 8 16

status_code

Estado del SMS. Para más información, consulte SMS status codes

integer

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

callback_data

Valor (String) que se envía de vuelta a su endpoint. Por ejemplo, puede pasar su propio ID de esta forma y recibirlo de vuelta con el informe de entrega (DLR).

string | null

<= 36 characters

Examples

Evento de Entrega SMS

Evento enviado cuando cambia el estado de entrega del SMS

{
  "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 cuando expira la entrega del SMS

{
  "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 recibido

400

Estructura del cuerpo de la solicitud de webhook no válida

401

Solicitud de webhook no autorizada

403

Acceso Webhook prohibido

404

No se ha encontrado el punto final del webhook

500

Error del servidor