Elige tu API

API HTTP-XML: seleccionar contactos

sdk-httpxml-a

1. Descripción

La API HTTP-XML de la Selección de Agenda de Contactos te permite realizar selecciones según parámetros en la agenda de contactos para buscar contactos en la agenda, asociar contactos a grupos y eliminar contactos.

2. Documentación

Búsqueda Avanzada de Contactos

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>
<CONTACTOSGET acción=”CGET,CDEL,LASOC”>
    <cbusqueda>
        <cunion>AND, OR</cunion>
        <orden1_campo></orden1_campo>
        <orden1_tipo></orden1_tipo>
        <orden2_campo></orden2_campo>
        <orden2_tipo></orden2_tipo>
        <orden3_campo></orden3_campo>
        <orden3_tipo></orden3_tipo>
        <sel_aleatoria></sel_aleatoria>
        <lista_asociar></lista_asociar>
        <lista_nueva></lista_nueva>
        <lista_noexiste></lista_noexiste>
        <cfilas></cfilas>
        <cdesde></cdesde>
        <cbparamlist union=”AND, OR”>
            <cbparametro>
                <pbcampo></pbcampo>
                <pbvalor></pbvalor>
                <pboperador></pboperador>
             </cbparametro>
             ………………………
         <cbparamlist>
         ……………………………………..
    </cbusqueda>
</CONTACTOSGET>
</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 Acción:

Tipos en parámetro “accion”:

CGET: Obtiene Contactos según criterio de búsqueda.
CDEL: Borra Contactos según criterio de búsqueda.
LASOC: Asocia Contactos a Grupo según criterio de búsqueda.

El elemento <cbusqueda> contiene :

Parámetro

Descripción

<union>

Tipo de unión de grupos de criterios: AND, OR

<orden1_campo>

Primer campo de ordenación .
Campos válidos:

id	identificador del contacto
nombre	Nombre del contacto
apellidos	Apellidos del contacto
numero	Número de móvil del contacto
sexo	Sexo del Contacto. Valores válidos
alias	Alias
email	Email
localizacion	Localizacion
etiquetas	Etiquetas
notas	Notas
cp	Código postal
edad	Edad
fnac	Fecha de nacimiento en formato dd/mm/yyyy
lista	Código de lista

<orden1_tipo>

Tipo de ordenacion primer campo: ASC, DESC

<orden2_campo>

Segundo campo de ordenación :

<orden2_tipo>

Tipo de ordenacion segundo campo: ASC, DESC

<orden3_campo>

Tercer campo de ordenación :

<orden3_tipo>

Tipo de ordenacion tercer campo: ASC, DESC

Sólo para asociar contactos listas

<sel_aleatoria>

Seleccionar aleatoriamente X contactos del total

<lista_asociar>

Código de grupo a asociar Contactos

<lista_nueva>

Nombre de grupo nuevo o existente a asociar contactos

<cfilas>

limite de contactos a obtener, máximo 100 por petición

<cdesde>

punto desde donde obtener registros, comenzando en 1

El elemento <cbparamlist> define un grupo independiente de criterios, contiene:

<union>

Tipo de unión para el grupo de campos del criterio: AND, OR

<cbparametro>

Datos de parámetro de búsqueda, contiene:

<pbcampo>

Nombre del campo a buscar.
Nombre de campo válidos:

id	identificador del contacto
nombre	Nombre del contacto
apellidos	Apellidos del contacto
numero	Número de móvil del contacto
sexo	Sexo del Contacto. Valores válidos H -> Hombre M -> Mujer N -> No Disponible
alias	Alias
email	Email
localizacion	Localizacion
etiquetas	Etiquetas
notas	Notas o comentarios
cp	Código postal
edad	Edad
fnac	Fecha de nacimiento en formato dd/mm/yyyy
lista	Código de lista

Valor del texto a buscar en formato hexadecimal

Operador a aplicar en el criterio:
Tipos de operadores:
EQ ->igual que
NEQ -> distinto que
IN -> Contiene
NIN -> No Contiene
GET -> Mayor o Igual que
LEQ -> Menor o Igual que

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.

<RXEnvio>
<Autentificacion>
    <Usuario>8865736572303038</Usuario>
    <Resultado>1</Resultado>
    <Comentario>Autentificacion satisfactoria.</Comentario>
</Autentificacion>
<CONTACTOSLIST ntotal="837" nfilas="15" ndesde="1">
    <LCONTACTO>
        <LCN>1</LCN>
        <LCID>146540</LCID>
        <LCNUMERO>0034601001607</LCNUMERO>
        <LCNOMBRE>6331363037</LCNOMBRE>
        <LCAPELLIDOS>6133657234356b366e70</LCAPELLIDOS>
        <LCTRATAMIENTO/>
        <LCALIAS/>
        <LCSEXO/>
        <LCLOCALIZACION/>
        <LCETIQUETAS>6b6a687064</LCETIQUETAS>
        <LCNOTAS/>
       <LCCP/>
       <LCFNAC/>
    </LCONTACTO>
……………………
</CONTACTOSLIST>
</RXEnvio>

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 Resultados:

El elemento <CONTACTOSLIST> contiene como atributos :

Nombre Parámetro	Descripción	Posibles Valores	Tipo de Dato
ntotal	Total de Contactos encontrados en la búsqueda		Numérico
nfilas	Registros contactos mostrados en la trama devuelta		Numérico
ndesde	A partir de qué registro se está mostrando en la trama devuelta		Numérico

Por cada contacto devuelto en la lista, el elemento <LCONTACTO> contiene :

Nombre Parámetro	Descripción	Posibles Valores	Tipo de Dato
LCN	Número de registro en la respuesta		Nunmérico
LCID	Identificador del Contacto
LCNUMERO	Número de móvil
LCNOMBRE	Nombre
LCAPELLIDOS	Apellidos
LCTRATAMIENTO	Tratamiento
LCALIAS	Alias
LCSEXO	Sexo	H ->Hombre M -> Mujer N -> No Disponible
LCLOCALIZACION	Localización
LCETIQUETAS	Etiquetas
LCNOTAS	Notas o comentarios
LCCP	Codigo Postal

* Todos los datos en LCONTACTO devueltos en formato hexadecimal.

Definición de Trama de Respuesta de Asociación de Contactos a Lista:

<RXEnvio>
<Autentificacion>
    <Usuario>8865736572303038</Usuario>
    <Resultado>1</Resultado>
    <Comentario>Autentificacion satisfactoria.</Comentario>
</Autentificacion>
<CONTACTOSLASOC>
    <total_contactos_asociados>0</total_contactos_asociados>
</CONTACTOSLASOC>
<LISTASLIST ntotal="1">
    <LISTA>
        <LN>1</LN>
        <LID>13902</LID>
        <LNAME>70656c616d6f6e6173</LNAME>
        <LPCLAVE/>
        <LNC>837</LNC>
    </LISTA>
</LISTASLIST>
</RXEnvio>

Resultado de la asociación de contactos, el elemento <CONTACTOSLASOC> contiene :

total_contactos_asociados

Total de contactos asociados al grupo

Datos del grupo al que se han asociado los contactos, el elemento <LISTALIST> contiene :

Nombre Parámetro	Descipción
Parámetro "ntotal"	Numero de grupos devueltos
LN	Número de registro del grupo en la respuesta
LID	Identificador del grupo
LCNAME	Nombre del grupo
LPCLAVE	Palabra clave del grupo
LNC	Numero de Contactos en el grupo

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

Definición de Trama de Respuesta de Borrado de Contactos:

<RXEnvio>
<Autentificacion>
    <Usuario>8865736572303038</Usuario>
    <Resultado>1</Resultado>
    <Comentario>Autentificacion satisfactoria.</Comentario>
</Autentificacion>
<CONTACTOSDEL>
    <total_contactos_borrados>837</total_contactos_borrados>
</CONTACTOSDEL>
</RXEnvio>

Resultado del borrado de contactos, el elemento <CONTACTOSDEL> contiene :

total_contactos_borrados

Total de contactos borrados

3. Ejemplos

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

4. Gráfico

Soporte Técnico:

Esta dirección de correo electrónico está protegida contra spambots. Usted necesita tener Javascript activado para poder verla.

Ahora puedes enviar también los mensajes SMS con Outlook, de forma fácil y segura.

Nagios

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


Descom.es	Hosting	SMS	Backup
Centro de Datos	Hosting sin Límites	Enviar SMS	Backup Remoto Online
Virtualización	Hosting a Medida	Recibir SMS	Server Backup, Backup de FUTURO
Cloud Computing	Email	Aplicaciones con SMS	Data Backup
	Dominios	SDK SMS	Restauración: Cloud Server