Introducción
El objetivo de éste documento es exponer los Web Service, detallar los servicios, parámetros y requisitos para poder integrar a los sistemas.
URL
Entorno de Pruebas: http://{IP}:{PORT}/api/notificaciones-cabal
Entorno de Producción: http://{IP}:{PORT}/api/notificaciones-cabal
Header Request Parameter
Todos los request deberán contener los datos que se encuentran especificados.
| Key | Type | Description |
|---|---|---|
Content-Type | String | Tipo de codificación del cuerpo de la petición. application/json |
Servicios
Envio de SMS a usuarios.
| Parametro | Description |
|---|---|
Metodo de Envio | POST |
| URL | /v1/enviar-sms |
Request
| Key | Type | Description |
|---|---|---|
numeroCelular | Alfanumérico | Numero de teléfono del usuario destino del SMS |
contenido | Alfanumérico | Cuerpo del SMS. Si el mensaje tiene mas de 160 caracteres se enviara en varios mensajes. |
codigoPlataforma | Numerico | Código de Plataforma que envia el SMS. De acuerdo a esto se enviara por un proveedor o OTRO. |
Response
| Key | Type | Description |
|---|---|---|
exitCode | Numerico | Código de resultado de la petición. |
messageCode | Numerico | Código de resultado del envío de la SMS. |
message | Alfanumérico | Mensaje de resultado de la petición. |
data | Estructura | |
cantidadMensajesEnviados | Numerico | Cantidad de mensajes enviados, Si el mensaje tiene mas de 160 caracteres se enviara en varios mensajes. |
cantidadMensajesFallidos | Numerico | Cantidad de mensajes no enviados |
detalle | Lista<Estructura> | |
codigoTransaccion | Alfanumérico | Mensaje de resultado de la notificación. |
mensajeEnviado | Alfanumérico | Cuerpo del SMS. |
proveedor | Alfanumérico | Proveedor por el cual se envía la transaccion. |