3.2. MT: Web Service Rest tipo POST
Este api está basado en llamados HTTP POST hechos por el cliente a una URL, bajo este esquema se encuentran varias funcionalidades adicionales como:Envíos por lotes de mensajes: Posibilidad de enviar el mismo mensaje a una lista de destinatarios en una misma petición, la respuesta de la petición retorna la información de cada mensaje por lo que se recomiendan lotes de hasta 50 SMS. Permite también el envío de mensajes personalizados por cada destinatario de la petición.
Envíos Tipo Flash: Previa configuración y de acuerdo a la disponibilidad de la tecnología por operador/país, podrá realizar envío de peticiones tipo Flash.
Programación de envíos: Podrá realizar peticiones con un parámetro de fecha/hora en la que realizarán el envío.
URLs Cortas: este servicio permite el envío de URL corta, al usarse en batches podrá enviar el mismo vínculo a todos los destinatarios o una diferente a cada contacto.
CorrelationLabel: Permite añadir un identificador de mensajes que podrá consultar en reportes para agrupar peticiones.
Autenticación
El usuario se autentica por medio de usuario y contraseña codificados (en base 64) en el encabezado “Authorization” bajo el estándar “basic” de la siguiente forma:Authorization = Basic Base64({usuario}:{contraseña})Bajo este esquema se debe enviar una petición con la siguiente estructura.
URL para consumir el servicio:
https://apitellit.aldeamo.com/SmsiWS/smsSendPost/Ejemplo de la petición
- Content-Type: application/json
- JSON petición:
{
"country": "string",
"dateToSend": "string",
"message": "string",
"encoding": "string",
"messageFormat": 0,
"addresseeList": [
{
"mobile": "string",
"correlationLabel": "corelation ejemplo",
"url": "string"
},
{
"mobile": "string",
"correlationLabel": "corelation ejemplo",
"url": "string"
},
{
"mobile": "string",
"correlationLabel": "corelation ejemplo",
"url": "string"
}
]
}
Parámetros:
Tabla 3 Parámetros HTTP POST
Esquema de la respuesta
{
"status": 1,
"reason": "Request Received",
"result": {
"totalRequest": 1,
"totalFailed": 0,
"receivedRequests": [
{
"mobile": "3118644939",
"transactionId": "postT02615L57G3118644939Rm4yx8Psmsi",
"status": 1,
"reason": "Request Received"
}
],
"failedRequests": [],
"dateToSend": "2018-01-26 14:42:00",
"timeZone": "America/Bogota"
}
}
Descripción de la respuesta:
• status: Código del resultado de la solicitud (número)
• reason: Resultado de la solicitud (texto)
• result: Detalle del resultado de la solicitud
-totalRequest: Total de destinatarios recibidos en la solicitud
-totalFailed: Total de destinatarios recibidos que NO se enviarán
-ReceivedRequests: Lista detallada de destinatarios a los que se les enviará el mensaje
▪ mobile: Número celular (GSM)
▪ transactionId: Código de transacción del mensaje
▪ status: Código de la razón de la falla
▪ reason: Estado de la transacción/Razón de la falla
-failedRequests: Lista de detalles de los destinatarios que NO se enviarán
▪ mobile: Número celular (GSM)
▪ transactionId: Código de transacción del mensaje único por mensaje.
Ej. getT02917L57G3118644939RdrvaxPsmsi
▪ status: Código de la razón de la falla
▪ reason: Estado de la transacción/Razón de la falla
– dateToSend: Fecha y hora a la que saldrá el envío
– timeZone: Zona horaria de la fecha a la que saldrá el envío.