Acceso Area de ClienteArea Cliente LLamanos al 965 861 024965 861 024

sdk-httpxml-a

1. Descripción

La API HTTP-XML de Grupos de la Agenda de Contactos te permite obtener un listado de los grupos de contactos disponibles en el servidor y sus datos. También permite borrar un grupo  y sus contactos asociados.

2. Documentación

Petición de listado de grupos y borrado

URL:

https://www.descomsms.com/AP/dmapi.servlet.Servlet

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 :

<TXEnvio>
<Autentificacion>
<usuario>login usuario</Usuario>
<passwd>contraseña de usuario </Passwd>
<idcli>código de cliente</Idcli>
</Autentificacion>
<LISTASGET accion=”LGET,LDEL” >
    <lista_id>Codigo de grupo a obtener o borrar</lista_id>
    <borrar_contactos>si,no</borrar_contactos>
</LISTASGET>
</TXEnvio>
 

 

Definición de trama de autentificación:

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 en parámetro “accion”:
  • LGET: Obtiene un listado de listas.
  • LDEL: Borra Lista solicitada y sus contactos de manera opcional.

El elemento <LISTASGET> contiene :

Parámetro Descripción Posibles Valores Tipo de Datos
lista_id Código de grupo a obtener o borrar.
Dejar en blanco para obtener todos los grupos
  Numérico
borrar_contactos Borra los contactos del servidor asociados al grupo.

no -> Borrra sólo el grupo sin borrar los contactos.
si  -> Borra el grupo y además los contactos asociados
 

 

Respuesta de resultados.

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.

 

Definición de Trama de Respuesta para búsqueda de grupos:

<RXEnvio>
<Autentificacion>
    <Usuario>8865736572303038</Usuario>
    <Resultado>1</Resultado>
    <Comentario>Autentificacion satisfactoria.</Comentario>
</Autentificacion>
<LISTASLIST ntotal="2">
    <LISTA>
        <LN>1</LN>
        <LID>13850</LID>
        <LNAME>6c6973746164696c6c6f</LNAME>
        <LPCLAVE/>
        <LNC>16243</LNC>
    </LISTA>
    <LISTA>
        <LN>2</LN>
        <LID>13813</LID>
        <LNAME>6c69737461646d</LNAME>
        <LPCLAVE/>
        <LNC>0</LNC>
    </LISTA>
</LISTASLIST>
</RXEnvio>
 

 

El elemento <LISTASLIST> contiene :

ntotal Total de grupos encontrados en la búsqueda

 

Por cada grupo encontrado, el elemento <LISTA> contiene :

Parámetro Descripción Posibles Valores Tipo de Datos
LN Número de registro en la respuesta 1,2,3, etc... Numérico
LID Identificador del Contacto   Numérico
LCNAME Nombre de la Lista   Alfanumérico
LPCLAVE Palabra clave de la Lista   Alfanumérico
LNC Numero de Contactos en la Lista   Nunérico


* Todos los datos en <LISTA> devueltos en formato hexadecimal.

 

Definición de Trama de Respuesta para borrado de grupo:

<RXEnvio>
<Autentificacion>
    <Usuario>8865736572303038</Usuario>
    <Resultado>1</Resultado>
    <Comentario>Autentificacion satisfactoria.</Comentario>
</Autentificacion>
<LISTASDEL>
    <total_listas_borradas>0</total_listas_borradas>
    <total_contactos_en_lista>0</total_contactos_en_lista>
</LISTASDEL>
<CONTACTOSDEL>
    <total_contactos_borrados>0</total_contactos_borrados>
</CONTACTOSDEL>
</RXEnvio>


Resultado del borrado de grupo, el elemento <LISTASDEL> contiene :

Parámetro Descipción Tipo de Datos
total_listas_borradas Total de contactos asociados al grupo Numérico
total_contactos_en_lista Total de contactos que había en el grupo al borrarlo Numérico


El elemento <CONTACTOSDEL> contiene :

Parámetro Descripción Tipo de Datos
total_contactos_borrados Total de contactos borrados asociados al grupo  

 

3. Ejemplos

Descarga nuestros ejemplos o accede a una demo online: demo online PHPdescargar ejemplos en PHP.

4. Gráfico

Soporte Técnico:

ic-email Esta dirección de correo electrónico está siendo protegida contra los robots de spam. Necesita tener JavaScript habilitado para poder verlo.

Nagios

Nagios

Recibe las alertas por SMS, integrando el envío de mensajes en las notificaciones de Nagios.
[más info