Entrega, reintentos y estados

Esta página describe el comportamiento común a las dos modalidades: cómo se entregan las notificaciones, qué debe responder tu endpoint receptor y cómo interpretar los objetos status y error.

Cómo se entregan las notificaciones

Qué debe responder tu endpoint receptor

Tu endpoint debe responder con un código HTTP de la familia 2xx. El cuerpo de la respuesta no se interpreta, pero sí se registra.

Recomendaciones para tu endpoint

• Responde rápido. Acusa recibo con 2xx y procesa después; no bloquees la respuesta esperando a tu propia lógica de negocio.
• Sé idempotente. Usa la combinación de transactionNumber y to para descartar duplicados.
• No asumas orden. Las notificaciones de una misma transacción pueden llegar desordenadas.

El objeto status

Indica el resultado del mensaje. Solo tiene dos formas posibles.

Mensaje exitoso:

"status": {
  "groupId": 3,
  "groupName": "DELIVERED",
  "id": 1,
  "name": "DELIVERED_TO_HANDSET",
  "description": "Message delivered to handset"
}

Mensaje no exitoso:

"status": {
  "groupId": 0,
  "groupName": "Ok",
  "id": 0,
  "name": "NO_SUCCESS",
  "description": "No success"
}

El objeto error

Acompaña siempre a status. Cuando el mensaje fue exitoso, viene relleno con valores neutros.

Mensaje exitoso:

"error": {
  "groupId": 0,
  "groupName": "Ok",
  "id": 0,
  "name": "NO_ERROR",
  "description": "No Error",
  "permanent": false
}

Mensaje no exitoso:

"error": {
  "groupId": 3,
  "groupName": "ERROR",
  "id": 1993,
  "name": "NumberDestinationOff",
  "description": "NumberDestinationOff",
  "permanent": false
}

Catálogo de estados

Los campos error.id y error.name corresponden a este catálogo. Es el catálogo general de la plataforma, por lo que no todos los valores pueden aparecer en una notificación de SMS saliente; los más frecuentes están marcados con ★.