API HTTP-XML: confirmación de entrega de SMS

1. Descripción
Mediante esta interfaz podrás obtener un informe detallado del histórico de mensajes enviados desde tu cuenta. Para ello debes enviar tus datos de autenticación y los parámetros de búsqueda de informes.
2. Documentación
URL:
http://www.descomsms.com/servlet/dmapi.servlet.Servlet
Petición de envío
Para poder recibir el informe de los reports, deberán de 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”:
- GETM, Obtener mensajes por report y 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 |
|
El elemento <busqueda> contiene :
| Nombre Parámetro |
Descripción | Posibles Valores | Tipo de Dato |
| bidsend |
Identificador del mensaje a buscar |
Numérico | |
| bnombre | Parte o todo el nombre de contacto a buscar |
Hexadecimal | |
| bmovil | Parte o todo el número de móvil a buscar | Numérico | |
| blista | Código de grupo a los que pertenecen los contactos a buscar | Numérico | |
| btexto | Parte del mensaje a buscar. | Hexadecimal | |
| bestado | Estado de los mensajes a buscar | 0 -> Sin información de envío todavía. 1 -> Enviado, sin confirmación de entrega 2 -> Entregado, con confirmación de entrega a operador o a móvil 3 -> Rechazado o información no disponible. |
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 Mensajes:
El elemento <MENSAJELIST> contiene como atributos :
| Nombre Parámetro |
Descripción | Posibles Valores | Tipo de Dato |
| fini | Fecha de inicio de la búsqueda |
Fecha en formato: dd/mm/yyyy |
Fecha |
| ffin | Fecha de fin de la búsqueda | Fecha en formato: dd/mm/yyyy | Fecha |
| ntotal | Total de mensajes encontrados en la búsqueda |
Numérico | |
| nfilas | Registros MENSAJE mostrados en la trama devuelta | Numérico | |
| ndesde | A partir de qué mensaje se está mostrando en la trama devuelta | Numérico |
Por cada mensaje encontrado <MENSAJE>
| Nombre Parámetro |
Descripción | Posibles Valores | Tipo de Dato |
| nm | Número de registro del total encontrados, comenzando desde 1 |
Numérico | |
| fecha_enviado | Fecha de envío del mensaje | Fecha en formato: dd/mm/yyyy hh:mm:ss | Fecha |
| idsend | Identificador numérico del mensaje enviado. Este es el identificador proporcionado por Descom SMS para poder usarlo a posteriori a la hora de obtener información acerca de este mensaje. | Numérico | |
| 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 | |
| movil | Número de móvil en formato internacional al que se ha enviado el mensaje |
Numérico | |
| htexto | Texto del mensaje enviado | Hexadecimal | |
| nmens | Número de SMS empleados para enviar este mensaje | Numérico | |
| hremitente | Texto del remitente enviado | Hexadecimal | |
| hcname | Nombre del contacto | Hexadecimal | |
| hcapellidos | Apellidos del contacto | Hexadecimal | |
| estado | Estado actual del mensaje | 0 : Sin información, información de envío no disponible todavía o mensaje pendiente de enviar. 1: Enviado, el mensaje ha sido enviado con éxito hacia el destinatario. En este estado el mensaje puede haber sido entregado aunque no hayamos recibido notificación de entrega. 2 : Entregado, el mensaje ha sido entregado en el destinatario o en el operador. Entregado a Destinatario: El mensaje ha sido entregado en el móvil y hemos recibido confirmación de entrega. Enviado a Operador: El mensaje ha sido entregado con éxito en el operador, la no recepción de la notificación de entrega a Destinatario no indica que no se haya entregado el mensaje. La no recepción de notificación no indica que no se haya entregado el mensaje. 3: Rechazado, ha ocurrido un error entregando el SMS en el destinatario. |
Numérico |
| estadocod | Código de estado si procede, para más información remita este código a Descom | Numérico | |
| estadohdesc | Texto con los detalles del estado del mensaje | Hexadecimal | |
| fecha_entregado | Fecha y hora en el que el SMS ha sido entregado al operador - Tiempo transcurrido entre el envío y la entrega | Fecha en formato: dd/mm/yyy hh:mm:ss | Fecha |
| fecha_confirmado | Fecha y hora de recepción de la confirmación de entrega. Esta confirmación es suministrada opcionalmente por el operador de telefonía - Tiempo transcurrido desde que el mensaje es entregado hasta que se recibe la confirmación de entrega del operador. | Fecha en formato: dd/mm/yyy hh:mm:ss | Fecha |
3. Ejemplos
4. Gráfico
