El servicio Callback permite que al consumir el servicio API REST SMS de Inalambria, el cliente pueda enviar la Url donde desea recibir el reporte del estado de los mensajes, una vez procesados por nuestra plataforma. Para esto, el cliente expone un endpoint(Webhook), el cual Inalambria consume enviando datos(Payload) que describen el estado de la transacción y cada uno de los mensajes procesados.
Reglas y Requisitos
- Adicional a la configuración de la cuenta mencionada anteriormente en los otros tipos de envío, esta funcionalidad requiere ser solicitada previamente para su configuración y disponibilidad.
- Al ser un método de integración, requiere configuración tanto de parte del cliente, como de Inalambria.
- El objetivo de servicio de valor agregado, es permitir a los clientes de Inalambria el envío de información adicional en el payload al consumir nuestro servicio API REST SMS; esta información adicional, si bien no es requerida por ni hace parte del procesamiento del mensaje de texto, permite el envío de datos que son de valor para la gestión de nuestros clientes.
- Esta información adicional se envía a un servicio webhook (construido por el cliente y ubicado en su infraestructura) junto con la información y estado del mensaje procesado; es necesario que dicho webhook cuente con el acceso necesario para que el consumo desde la infraestructura Inalambria sea posible.
- Cada una de estas herramientas relaciona diferentes aspectos de configuración que deben ser validados para su viabilidad; para mayor información, consulte con su asesor comercial de Inalambria.
Campos Enviados al Webhook de Nuestros Clientes
Desde Inalambria Internacional, se envían los datos por transacción con el estado de los mensajes, después de su procesamiento. Tenemos los siguientes campos:
| Nombre | Descripción |
|---|---|
| bulkId | Corresponde al código de la transacción (datos del cliente). |
| messageId | Identificador del mensaje (datos del cliente). |
| to | Destinatario (datos del cliente). |
| sentAt | Fecha y hora de entrega al operador (datos de Inalambria). |
| doneAt | Fecha y hora de entrada al sistema (datos de Inalambria). |
| callbackData | Objeto con datos de la campaña procesada; por lo general, contiene los campos 'Account', 'Action', 'Campaign' y 'Gateway' (datos del cliente). |
| smsCount | Indica la cantidad de segmentos del mensaje. |
| status | Objeto cuyos campos se describen en la parte inferior de esta página. |
| error | Objeto cuyos campos se describen en la parte inferior de esta página. |
| transactionNumber | Número de transacción generado al ingresar un mensaje SMS a nuestra plataforma (datos de Inalambria). |
Campos enviados en el objeto 'status'
| Nombre | Descripción |
|---|---|
| groupId | Grupo que identifica el estado del mensaje. Posibles valores: 3: Mensaje exitoso, 0: Error en el mensaje |
| groupName | Posible valores: DELIVERED: Mensaje exitoso, Ok: Error en el mensaje |
| id | Posibles valores: 1: Mensaje exitoso, 0: Mensaje con error |
| name | Posibles valores: DELIVERED_TO_HANDSET: Mensaje exitoso, NO_SUCCESS: Mensaje con error |
| description | Posibles valores: Message delivered to handset: Mensaje exitoso, No success: Mensaje no exitoso |
Campos enviados en el objeto 'error'
| Nombre | Descripción |
|---|---|
| groupId | Grupo que identifica el estado del mensaje. Posibles valores: 0: Mensaje exitoso, 3: Error en el mensaje |
| groupName | Posible valores: ERROR: Mensaje con error, Ok: mensaje exitoso |
| id | Posibles valores: 1 a 99 |
| name | Descripción del error |
| description | Descripción del error |
| permanent | Indica si el estado de error es permanente |
Ejemplo de Payload
Este es un ejemplo de la estructura del payload que enviamos al Webhook de nuestros clientes:
{
"results": [
{
"bulkId": "",
"messageId": "",
"to": "",
"sentAt": "",
"doneAt": "",
"callbackData": "",
"smsCount": "",
"status": {
"groupId": 0,
"groupName": "",
"id": 0,
"name": "",
"description": ""
},
"error": {
"groupId": 0,
"groupName": "",
"id": 0,
"name": "",
"description": "",
"permanent": ""
},
"transactionNumber": 0
}
]
}