post https://rest.inalambria.com/mtmessage
Esta API permite el envío de mensajes a través del canal especificado. Los desarrolladores pueden interactuar con este servicio utilizando el endpoint proporcionado, enviando un payload en formato JSON. Previamente se requiere obtener el token de autenticación.
{
"Type": 1,
"MessageText": "Mensaje enviado desde Inalambria",
"Devices": "3XXXXXXXXX"
}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 |
|---|---|---|---|
| Type | Sí | Tipo de envío; sus valores pueden ser 1 para modalidad masiva, 2 para modalidad personalizada y 3 para modalidad plantilla. | Número |
| Channel | No | Canal de envío; su valor predeterminado es SMS, soporta también el valor RCS para envíos a través de dicho canal (requiere configuración preliminar). | Texto |
| Devices | Para modalidad masiva | Lista de dispositivos a los que se enviará el mensaje; en caso de ser más de uno, los números celulares deben estar separados por guión. Ejemplo: 573XXXXXXXXX-573YYYYYYYYY | Texto |
| MessageText | Para modalidad masiva | Mensaje de texto a enviar. | Texto |
| MessagePattern | Para modalidad personalizada | Patrón del mensaje usado en envíos personalizados. | Texto |
| MessageData | Para modalidades personalizada y plantilla | Texto en notación JSON, el cual contiene los datos personalizados del mensaje. Obligatorio que venga la propiedad PhoneNumber. | Texto |
| TemplateId | Para modalidad plantilla | Identificador de la plantilla registrada | Número |
| DateMessage | No | Fecha usada para programar el envío de mensajes; su formato debe ser: yyyy-MM-dd HH:mm:ss | Texto |
| FlashSMS | No | Para mensajes SMS, indica si dicho mensaje es de tipo flash; en tal caso, su valor deberá ser el número 1. | Texto |
| HasMore | No | Indica si el envío es por lotes de mensajes con un único número de transacción; en tal caso, su valor deberá ser el número 1. | Texto |
| TransactionNumber | Si el parámetro 'HasMore' hace parte de la petición, y su valor es el número 1 | Número de transacción para asociar envíos por lotes. | Número de 28 dígitos |
| Url | No | URL larga a acortar e insertar en el mensaje a enviar. | Texto |
| Variables | No | Objeto en formato clave valor con la lista de variables a adjuntar al mensaje. | Objeto |
| CustomMessageId | No | Id de mensaje, el cual será retornado vía Callback. | Texto |
| CallbackData | No | Objeto en formato clave valor con datos adicionales, retornado vía Callback. | Objeto |
Posibles Estados HTTP de Respuesta
- 200: Mensaje recibido y en procesamiento.
- 400: Estructura de payload inválida.
- 401: No autorizado. Es necesario verificar las credenciales de autenticación.
- 403: Permisos insuficientes. Es posible que las credenciales estén validas, pero no se tiene permitido acceder al recurso (por ejemplo, la petición de consumo se genera desde una dirección IP no permitida).
- 500: Error interno del servidor. Se recomienda intentar en unos minutos, o en su defecto, contactar el servicio de soporte de Inalambria Internacional.
Campos de Respuesta
En la respuesta obtenida al consumir nuestro servicio, se encuentran los siguientes campos:
| Nombre | Descripción | Tipo de Dato |
|---|---|---|
| TransactionNumber | Número de transacción, con el cual es posible consultar el estado de los envíos. | Número de 28 dígitos |
| Status | Estado de la petición; si el mensaje fue validado de manera correcta para su envío, el valor de este campo será el número 0. Si la validación del mensaje para su envío falla, el valor de este campo será el número 1. | Númerico |
| MessageText | Si el campo Status tiene por valor el número 1, aquí se encontrará la descripción del evento relacionado con el fallo en la validación. | Texto |