Si el cliente desea recibir las notificaciones de DLR de las peticiones enviadas por el API de envíos masivos, deberá desarrollar un servicio web para procesar a su conveniencia dichas notificaciones.
2.1. Conexión HTTP
El servicio web a desarrollar debe atender a una solicitud POST del protocolo HTTP, el cuál recibe cadenas JSON y devuelve un resultado en texto plano. A continuación, se muestra la información necesaria para realizar la conexión del servicio.
URL: | Definida por el cliente |
METHOD: | POST |
HEADERS: | Content-Type: application/json |
AUTORIZACION: | El servicio debe contar con una autorización básica por usuario y contraseña, de tal forma que se reciba el header de autorización: Authorization: Basic [cadena generada con las credenciales proporcionadas] |
BODY: | { "messageId": [String][required], "statusDelivery": [string][required], "sendDate": [Long][required], "doneDate": [Long][optional] } |
Parámetros | ||
messageId | Parámetro que identifica al MT enviado. | Obligatorio |
statusDelivery | Parámetro que indica el estado del envío del MT. Puede tener alguno de los siguientes valores: DELIVERED: envío exitoso. REJECTED o UNDELIVERABLE: envío rechazado por el operador. UNKNOWN: envío rechazado por el operador, se desconoce el código de error. | Obligatorio |
sendDate | Parámetro que indica la fecha y hora de envío del MT. | Obligatorio |
doneDate | Parámetro devuelto por el operador que indica cuando el MT fue enviado al dispositivo o en su caso cuando fue recibido en el dispositivo (DLR handset) | Opcional |
carrier | Nombre del operador al que pertenece el MSISDN. | Obligatorio |
Ejemplo | |
Cuerpo | { "messageId": 12345678, "statusDelivery": "DELIVERED", "sendDate": 1588694204000, "doneDate": 1588694204000 , "carrier": "CLARO" } |
2.1.1. Respuesta
La respuesta del servicio deberá ser texto plano y el código HTTP correspondiente, se considerará como exitosa una respuesta con código 200 y errónea cualquier otro código, para un error de autenticación se requiere un código HTTP 401.