API HTTP-XML: agenda de contactos

sdk-httpxml-a

1. Descripción

La API HTTP-XML de la Agenda de Contactos te permite tener un acceso total a todos tus contactos almacenados en tu cuenta.
Podrás gestionar tus contactos para crear nuevos, eliminar y modificar.

2. Documentación

Añadir y Modificar 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>
<CONTACTOSSET accion=”CADD” accion_existe=”N,A,I” lista_asociar=”” lista_nueva=””>
    <cdcontacto>
      <cdparametro>
          <cdcampo>
          <cdvalor>
      </cdparametro>
      <cdparametro>
          <cdcampo>
          <cdvalor>
      </cdparametro> 
      ………………………
    </cdcontacto>
    <cdcontacto>
      <cdparametro>
          <cdcampo>
          <cdvalor>
      </cdparametro>
      <cdparametro>
          <cdcampo>
          <cdvalor>
      </cdparametro> 
      ………………………
    </cdcontacto>
    ………………………
</CONTACTOSSET >
</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

El elemento <CONTACTOSSET> Contiene:

Nombre
Parámetro
Descripción Posibles Valores Tipo de
Dato
accion
Acción a realizar CADD -> Añadir/Actualizar contactos

accion_existe
Acción a realizar si el móvil del contacto a añadir ya existe
N -> Se crea el contacto nuevo, se borra el que ya existe y se crea uno nuevo
A -> Se actualiza el contacto existente sólo con los datos pasados.
I -> Se Ignora modificar el contacto si ya existe

lista_asociar

Código de grupo a asociar Contactos.
Se buscará un grupo con este id para asociar los contactos añadidos o existentes. 

  Numérico
lista_nueva

Nombre de grupo nueva o existente a asociar contactos.
Se buscará un grupo con este nombre para asociar los contactos añadidos o existentes. Si no existe un grupo con este nombre se creará uno nuevo.

  Alfanumérico

 

El elemento <cdcontacto> define un grupo de parámetros de campos de un contacto, contiene:

Parámetro Descripción
<cdparametro> Datos de campo del contacto, contiene:

<cdcampo>

Nombre del campo del contacto.
Nombre de campo válidos:
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
fnac Fecha de nacimiento en formato dd/mm/yyyy

* Campos obligatorios
** Campos recomendados

<pbvalor>

Valor del texto asociado al campo en formato hexadecimal 
Valores según campo 
nombre Texto alfanumérico
apellidos Texto alfanumérico
numero Número de móvil sin espacios, en formato nacional 666555444 o en formato internacional 0034666555444
sexo Sexo del Contacto. Valores válidos
H -> Hombre
M -> Mujer
N -> No Disponible
alias Texto alfanumérico
email Texto alfanumérico
localizacion Texto alfanumérico
etiquetas Texto alfanumérico
notas Texto alfanumérico
cp Código postal en formato numérico
fnac Fecha de nacimiento en formato dd/mm/yyyy

Todos los valores en formato Hexadecimal

 

Tramas de ejemplo para añadir 2 contactos con nombre y apellidos:

<TXEnvio>
<Autentificacion>
    <usuario>xxxxxx</Usuario>
    <passwd>xxxxxx</Passwd>
    <idcli>nnnnn</Idcli>
</Autentificacion>
<CONTACTOSSET accion=”CADD” accion_existe=”A” lista_asociar=”” lista_nueva=”invitados”>
    <cdcontacto>
      <cdparametro>
          <cdcampo>numero</cdcampo>
          <cdvalor>30303334363131323232333838<cdvalor>
      </cdparametro>
      <cdparametro>
          <cdcampo>nombre</cdcampo>
          <cdvalor>70657065</cdvalor>
      </cdparametro>
   <cdparametro>
          <cdcampo>apellidos</cdcampo>
          <cdvalor>706f72726173</cdvalor>
      </cdparametro>
    </cdcontacto>
    <cdcontacto>
      <cdparametro>
          <cdcampo>numero</cdcampo>
          <cdvalor>30303334363131323232333333<cdvalor>
      </cdparametro>
      <cdparametro>
          <cdcampo>nombre</cdcampo>
          <cdvalor>70657065</cdvalor>
      </cdparametro>
   <cdparametro>
          <cdcampo>apellidos</cdcampo>
          <cdvalor>706f72726173</cdvalor>
      </cdparametro>
    </cdcontacto>
</CONTACTOSSET >
</TXEnvio>

 

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 de Añadir Contactos:

<RXEnvio>
<Autentificacion>
    <Usuario>8865736572303038</Usuario>
    <Resultado>1</Resultado>
    <Comentario>Autentificacion satisfactoria.</Comentario>
</Autentificacion>
<CONTACTOSADD>
    <total_contactos>3</total_contactos>
    <total_contactos_nuevos>0</total_contactos_nuevos>
    <total_contactos_actualizados>3</total_contactos_actualizados>
    <total_contactos_ignorados>0</total_contactos_ignorados>
    <total_contactos_errores>0</total_contactos_errores>
</CONTACTOSADD>
</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 <CONTACTOSADD> contiene como atributos :

Nombre
Parámetro
Descripción Posibles Valores Tipo de
Dato
total_contactos
Total de contactos enviados para añadir

Numérico
total_contactos_nuevos
Total de contactos creados nuevos
  Numérico
total_contactos_actualizados
Total de contactos actualizados
Numérico
total_contactos_ignorados
Total de contactos ignorados   Numérico
total_contactos_errores
Total de contactos no añadido por errores   Numérico


3. Ejemplos

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

4. Gráfico