API HTTP-XML: confirmacion de entrega de envíos realizados

1. Descripción
2. Documentación
Petición de informe de Reports
URL:
https://www.descomsms.com/AP/dmapi.servlet.Servlet
Petición de envío
Para poder recibir el informe de los reports, deberás acceder al URL arriba indicada proporcionando la siguiente información en formato POST:
Definición de trama de autentificación
Parámetros POST:
| Nombre | Descripción |
| xml | Trama XML con los datos de autentificación y acciones a realizar |
Estructura básica XML de petición:
Etiqueta Raiz: <TXEnvio>
Esta etiqueta debe envolver todos los datos XML de la llamada.
<TXEnvio> Tus datos.... </TXEnvio>
Trama completa de petición de Report:
Definición de trama de autentificación:
Deberás pasar en primer lugar el nodo de autentificación, donde figurarán sus credenciales en Descom SMS
Donde:
| Nombre Parámetro |
Descripción | Posibles Valores | Tipo de Dato |
| Usuario | Identificador de Usuario en Descom SMS | Nombre de usuario | Alfanumérico en Hexadecimal |
| Passwd | Contraseña de acceso | Contraseña | Alfanumérico en Hexadecimal |
| IdCli | Identificador de Cliente en Descom SMS | Identificador | Numérico |
Definición de trama de parámetros de Acciones
Tipos de informes en parámetro “acción”:
- GETR, obtener reports por fecha
El elemento <Reportget> contiene :
| Nombre Parámetro |
Descripción | Posibles Valores | Tipo de Dato |
| idreport |
Código numerico de report a obtener |
Numérico | |
| periodo |
Periodo del cual obtener los datos |
D -> Día actual S -> Semana actual M -> Mes actual T -> Todo Si se deja en blanco se obtiene todo |
|
| fini | Fecha de inicio de búsqueda | Fecha en formato: dd/mm/yyyy | |
| ffin | Fecha de fin de búsqueda | Fecha en formato: dd/mm/yyyy | |
| nfilas | Límite de filas a obtener, máximo 100 por petición | 1..100 | Numérico |
| ndesde | Punto desde donde obtener registros, comenzando en 1 | Numérico | |
| orden | Ordenación de registros según fecha | Asc -> en modo ascendente Desc -> en modo descendente |
Respuesta de envío.
Estructura básica XML de respuesta:
Etiqueta Raiz: <RXEnvio>
Esta etiqueta envuelve todos los datos XML del resultado.
<RXEnvio> Tus datos.... </RXEnvio>
Todas las peticiones serán respondidas con un documento XML, conteniendo la siguiente estructura.
Trama completa de respuesta de Report:
Definición de trama de autentificación :
En primer lugar recibirás el resultado de tu autentificación Descom SMS.
| Nombre Parámetro |
Descripción | Posibles Valores | Tipo de Dato |
| Usuario | Identificador de Usuario en Descom SMS | Nombre de usuario | Alfanumérico en Hexadecimal |
| Resultado | Resultado de la autentificación en Descom SMS | 1-> autentificación correcta 0->Fallo en la autentificación |
Numérico |
| Comentario | Texto descriptivo del resultado de la autentificación | Alfanumérico |
Definición de trama de Reports:
El elemento <REPORTLIST> contiene como atributos :
| Nombre Parámetro |
Descripción | Posibles Valores | Tipo de Dato |
| fini | Fecha de inicio de la búsqueda en formato dd/mm/yyyy |
Fecha | |
| ffin | Fecha de fin de la búsqueda en formato dd/mm/yyyy | Fecha | |
| ntotal | Total de reports encontrados en la búsqueda |
Numérico | |
| nfilas | Registros REPORT mostrados en la trama devuelta | Numérico | |
| ndesde | A partir de qué report se está mostrando en la trama devuelta | Numérico |
Por cada report encontrado <REPORT>
| Nombre Parámetro |
Descripción | Posibles Valores | Tipo de Dato |
| nr | Número de registro del total encontrados, comenzando desde 1 |
Numérico | |
| fecha_envio | Fecha de envío del report | Fecha en formato: dd/mm/yyyy hh:mm:ss | Fecha |
| idreport | Identificador numérico del envío. Este es el identificador proporcionado por Descom SMS para poder usarlo a posteriori a la hora de obtener información acerca de este envío. |
Numérico | |
| estado | Estado actual del Report | PENDIENTE ENVIANDO FINALIZADO SIN SALDO PROGRAMADO ENVIANDO PROGRAMADO FINALIZADO |
|
| idenvio | Identificador externo del envío. El identificador que pasas cuando realizas el envío o que se genera automáticamente. |
AlfaNumérico | |
| total_mensajes | Total de mensajes del report | Numérico | |
| total_contactos | Total de contactos del report | Numérico | |
| total_creditos | Total de crédito del report | ||
| app | Nombre de aplicación de envío | AlfaNumérico | |
| htexto | Texto en formato hexadecimal del texto enviado | Hexadecimal | |
| hremitente | Texto en formato hexadecimal del remitente enviado | Hexadecimal | |
| informe | Solicitud de iforme de entrega | 0 -> No se ha solicitado informe 1 -> Sí se ha solicitado informe |
Numérico |
| sin_confirmacion | Total de mensajes enviados correctamente de los que no se ha recibido todavía notificación de entrega | Numérico | |
| confirmados | Total de mensajes enviados correctamente de los que se ha recibido notificación de entrega a operador o móvil | Numérico | |
| errores | Total de mensajes enviados correctamente de los que hemos recibido notificación de rechazo o error de entrega | Numérico | |
| sin_informacion | Total de mensajes sin información de envío disponible todavía o mensajes pendiente de enviar | Numérico |
3. Ejemplos
4. Gráfico
