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.

Posibles Campos a Enviar en la Petición

Al consumir nuestro servicio, tenemos los siguientes campos a enviar:

Nombre	¿Obligatorio?	Descripción	Tipo de Dato
CustomMessageId	No	Identificador asignado por el cliente, para su propio seguimiento interno (una vez retornado a nivel de Callback) y ajeno a la plataforma Inalambria.	Texto
CallbackData	No	Objeto en notación JSON, donde es posible enviar información de tipo 'llave:valor', con información generada y relevante para el cliente (una vez retornado a nivel de Callback) y ajeno a la plataforma Inalambria.	Objeto

Ejemplos de Payload

Este valor agregado se encuentra disponible tanto para mensajes SMS Unidireccionales individuales, como para mensajes SMS Unidireccionales en lote o batch.

Mensaje SMS Unidireccional

Este es un ejemplo de consumo de este servicio, con los datos adicionales a enviar:

curl -X POST https://rest.inalambria.com/mtmessage
-H "Content-Type: application/json"
-H "Authorization: Bearer XXXXXXXXXXXXXXX"
-d '{
    "Type": 1,
    "MessageText": "Mensaje de texto enviado por Inalambria, ejemplo de Callback",
    "Devices": "3XXXXXXXXX-3YYYYYYYYY-3ZZZZZZZZZ",
    "CustomMessageId":"123",
    "CallbackData ": { "campo1":"valor1", "campo2":"valor2"}
}'

El valor '123' corresponde al identificador del mensaje otorgado por el cliente, y se envía en el parámetro CustomMessageId. En el parámetro CallbackData, se envía un objeto en notación JSON con dos atributos, cada cual con su nombre y valor.

Mensaje SMS Unidireccional (Batch - En Lotes)

Este es un ejemplo de consumo de este servicio, con los datos adicionales a enviar:

curl -X POST https://rest.inalambria.com/mtmessage/massive 
-H "Content-Type: application/json"
-H "Authorization: Bearer XXXXXXXXXXXXXXX"
-d '{
    "messages": [
        {
            "destinations": [
                {
                    "to": "3XXXXXXXXX",
                    "messageId": "1"
                },
                {
                    "to": "3YYYYYYYYY",
                    "messageId": "2"
                }
            ],
            "text": "Mensaje enviado desde Inalambria, ejemplo Callback en batch",
            "notifyUrl": "https://miwebhook.com",
            "callbackData": "{\"Account\":13, \"Action\": 22, \"Campaign\":12, \"Gateway\":\"This is Gateway test\"}",
            "notifyContentType": "application/json"
        }
    ],
    "bulkId": "C001"
}'

Por medio del API massive, se puede configurar la URL del webhook que debe consumir Inalambria vía callback para notificar el estado de los mensajes. Los campos: “bulkId”, “callbackData”, “messageId” son datos que el cliente del API recibirá de vuelta cuando se consuma su webhook:

Nombre	¿Obligatorio?	Descripción	Tipo de Dato
messageId	No	Identificador asignado por el cliente, para su propio seguimiento interno (una vez retornado a nivel de Callback) y ajeno a la plataforma Inalambria.	Texto
CallbackData	No	Objeto en notación JSON, donde es posible enviar información de tipo 'llave:valor', con información generada y relevante para el cliente (una vez retornado a nivel de Callback) y ajeno a la plataforma Inalambria.	Objeto
bulkId	No	Identificador asignado por el cliente, con el cual es posible agrupar una serie de envíos; por lo general se asocia a mensajes relacionados a una misma campaña. Esta información es ajena a la plataforma Inalambria.	Texto