MT: Web Service Rest tipo GET

//MT: Web Service Rest tipo GET

3.1. MT: Web Service Rest tipo GET

Este API está basado en llamados HTTP GET ideales para transacciones básicas y rápidas hechas por el cliente a una URL. Bajo este esquema los parámetros de la solicitud de envío se adjuntan a la petición HTTP vía GET.

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})

URL de la petición:

https://apitellit.aldeamo.com/SmsiWS/smsSendGet?mobile={NumeroCelular} &country={CódigoPaís}&message={Mensaje}&messageFormat={Formato}

Parámetros:

Tabla 1 Parámetros HTTP GET
Parámetro Descripción Obligatoriedad
Usuario Usuario de las credenciales creadas para el cliente. Obligatorio
Contraseña Contraseña asignada para el cliente. Obligatorio
Número Celular Destinatario del mensaje (número celular o GSM sin prefijos) Obligatorio
Código País Código Internacional asignado para el país. Obligatorio
Mensaje Texto del mensaje; no debe tener caracteres que afecten la URL de la petición. Obligatorio
Formato Tipo de mensaje a enviar, puede ser: SMS normal (1) SMS Flash (2) – Requiere configuración previa. Opcional

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

Código de Respuesta – Status:

Tabla 2 Parámetros Respuesta HTTP GET
Código Descripción Nivel
1 Petición recibida con éxito General/Detallado
-1 Error de autenticación General
-2 Ruta no configurada Detallado
-3 Número celular inválido Detallado
-4 Crédito insuficiente General
-5 Error interno de la transacción General/Detallado
-6 URL a acortar inválida Detallado
-7 Fecha de envío inválida General
-8 Petición con formato inválido General
-9 Usuario bloqueado por intentos fallidos General
-10 Código de país inválido General
-11 Mensaje del cuerpo inválido General
-12 ID de transacción Inválida Detallado
2021-06-29T11:51:56-05:00