API HTTP-XML: Enviar SMS

sdk-httpxml-a

1. Descripción

El Interfaz HTTP-XML te permite enviar mensajes prácticamente desde cualquier plataforma.

Solo tienes que integrar la llamada a una URL en el lenguaje de programación que estés utilizando.

Podrás enviar mensajes desde una página Web con un simple formulario, una aplicación gráfica en Windows, un script en linea de comandos en Linux, etc...

La llamada a la URL se hace pasando un parámetro con la trama XML completa en la que se especifica los datos de autenticación y los mensajes a enviar.

2. Documentación

URL:

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

 

Petición de envío

 Para poder enviar mensajes, deberás acceder al servidor seguro, a la URL arriba indicada
proporcionando el parámetro xml con la trama XML en el formato más abajo especificado en esta documentación.

Toda petición de envío tiene como respuesta un documento XML con el resultado de la operación realizada.

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>

 

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

<Autentificacion>
    <Usuario>login usuario</Usuario>
    <Passwd>contraseña de usuario </Passwd>
    <Idcli>código de cliente</Idcli>
    <Remitente>texto remitente</Remitente>
</Autentificacion>

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
Remitente* Remitente personalizado para los mensajes Texto remitente hasta 11 caracteres Alfanumérico en Hexadecimal

* Puede personalizar el remitente de los SMS, con su número de móvil autorizado, en formato no internacional (ej: 111222333), o con una cadena de texto; en este caso, consulte antes con Esta dirección de correo electrónico está siendo protegida contra los robots de spam. Necesita tener JavaScript habilitado para poder verlo. para configurar su remitente.

 

Definición de trama de envío de mensajes:

Para el envío de mensajes deberás enviar en la trama XML el nodo <mensajes> según la estructura definida a continuación.

<Mensajes  idenvioext="xxxxxxxx">
    <EmailNot>n</EmailNot>
    <MaxSMS>n</MaxSMS>
    <Total>nnn</Total>
    <Control>n</Control>
    <Mensaje>
        <ID>xx</ID>
        <Destino>nnnnnnnnnn</Destino>
        <Texto>xxxxxxxxxxxxxxxxxxx</Texto>
        <Remitente></Remitente>
    </Mensaje>
    <Mensaje>
        <ID>xx</ID>
        <Destino>nnnnnnnnnn</Destino>
        <Texto>xxxxxxxxxxxxxxxxxxx</Texto>
        <Remitente></Remitente>
    </Mensaje>
    ...............................
</Mensajes>

 

Donde:

Parámetro Requerido Descripción Posibles Valores Tipo de
Dato
idenvioext No

Identificador del envío.

Este identificador sirve para identificar un envío en el servidor. El envío de bloques de mensajes con el mismo idenvioext hará que todos los mensajes se agrupen en un mismo envío. Si se deja en blanco se genera uno automáticamente en el servidor.

Cadena alfanumérica de hasta 25 caracteres Hexadecimal
EmailNot No

Nos permite recibir por correo los reportes de entrega de los mensajes

1 -> para recibir el reporte de los envíos. 
Déjalo en blanco para no recibir reportes.
Numérico
MaxSMS No Número máximo de SMS que se enviarán por cada uno de los mensajes
Si se deja en blanco no hay límite.
1,2,3....
0 - sin límite 
Numérico
Total Número total de mensajes en el envío
Numérico
Control Control de mensajes dependiendo del saldo 0 - Si saldo es insuficiente, no enviar ningún mensaje
1 - Si saldo es insuficiente, enviar tantos mensajes como saldo exista
Numérico
Por cada mensaje:
   
ID Identificador de cada mensaje en la trama  1,2,3,...  Numérico 
destino Número de teléfono del destinatario del mensaje Teléfono en formato:
acceso internacional + cod. país + teléfono Ejemplo: 0034111222333
Numérico
texto Texto del mensaje.
Si el mensaje tiene más de 160 caracteres se dividirá en varios SMS según parámetro MaxSMS
Texto del mensaje en formato hexadecimal Hexadecimal

Remitente No Remitente personalizado específico para este mensaje. Si se deja en blanco se utilizará el remitente principal del nodo de autentificación   Hexadecimal

 

Ejemplo de trama de envío XML para 3 mensajes:

<TXEnvio>
<Autentificacion>
    <Usuario>xxxxxxxxxxxxx</Usuario>
    <Passwd>xxxxxxxx</Passwd>
    <Idcli>99</Idcli>
    <Remitente>xxxxxxxx</Remitente>
</Autentificacion>
<Mensajes  idenvioext="123456ABC">
    <EmailNot>1</EmailNot>
    <MaxSMS>0</MaxSMS>
    <Total>3</Total>
    <Control>1</Control>
    <Mensaje>
        <ID>1</ID>
        <Destino>0034111222333</Destino>
        <Texto>4F74726120507275656261</Texto>
    </Mensaje>
    <Mensaje>
        <ID>2</ID>
        <Destino>0034111222444</Destino>
        <Texto>4F74726120507275656261</Texto>
    </Mensaje>
    <Mensaje>
        <ID>3</ID>
        <Destino>0034111222555</Destino>
        <Texto>4F74726120507275656261</Texto>
    </Mensaje>
</Mensajes>
</TXEnvio>

 

Ejemplo de trama de para obtener el Saldo en Descom SMS:

Se envía la misma trama pero quitando el nodo de <Mensajes>

<TXEnvio>
<Autentificacion>
    <Usuario>xxxxxxxxxxxxx</Usuario>
    <Passwd>xxxxxxxx</Passwd>
    <Idcli>99</Idcli>
    <Remitente>xxxxxxxx</Remitente>
</Autentificacion>
</TXEnvio>

 

Obtendremos la trama de respuesta de autentificación explicada más abajo.


Respuesta de envío.

Estructura básica XML de respuesta:

Etiqueta Raiz: <RXEnvio>

Esta etiqueta debe envolver todos los datos XML de la llamada.

<RXEnvio>  Tus datos....  </RXEnvio>

 

Definición de trama de autentificación:

Todas las peticiones serán respondidas con un documento XML, conteniendo la siguiente estructura.
En primer lugar recibirás el resultado de tu autentificación Descom SMS.

<Autentificacion>    
  <Usuario>xxxxxxxxxxxx</Usuario>
  <Resultado>1</Resultado>
  <Comentario>Autentificacion satisfactoria.Remitente Aceptado</Comentario>
  <Saldo>xxxxx</Saldo>
</Autentificacion>

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
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
Saldo Saldo actual en Descom SMS de tu cuenta
Numérico

 

Definición de trama de respuesta de mensajes:

Para los mensajes enviados, recibirás la información del resultado de los envío en el nodo <mensajes> según la estructura definida a continuación.

 
<Mensajes idenvioext="xxxxxxxxxx" idenviodm="nnnnnnnnn" total_mensajes="nn" total_ok="nn" total_error="nn" total_creditos="nn" total_sms_ok="nn" total_sms_error="nn">
    <Mensaje>
        <Id>x</Id>
        <IdDM>xx</IdDM>
        <Resultado>1</Resultado>
        <Comentario>Mensaje Enviado</Comentario>
    </Mensaje>
    ...............................
</Mensajes>

 

Donde:

Parámetro Descripción Posibles Valores Tipo de
Dato
idenvioext

Identificador  externo del envío. El identificador que pasas cuando realizas el envío o que se genera automáticamente.

Cadena alfanumérica de hasta 25 caracteres Hexadecimal
idenviodm

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
total_mensajes Número total de mesnajes enviados.   Numérico
total_ok Número total de mensajes enviados correctamente. (1 mensaje puede contener varios SMS)
Numérico
total_error Número total de mensajes no enviados por contener algún error.
  Numérico
total_creditos Total de créditos gastados en el envío.   Numérico
total_sms_ok Número total de SMS enviados correctamente.   Numérico
total_sms_error Número total de SMS no enviados por contener algún error.   Numérico
Por cada mensaje:
   
ID Identificador de cada mensaje que has pasado en el envío 1,2,3,...  Numérico 
IdDM Identificador del mensaje. 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
Resultado Resultado del envío del mensaje. 1-> Envío correcto
0-> Fallo en el envío
Numérico

Comentario Texto descriptivo del resultado del envío del mensaje.
  Alfanumérico

 

Ejemplo de trama de respuesta XML para 3 mensajes enviados:

<?xml version="1.0" encoding="ISO-8859-1"?>
<RXEnvio>
<Autentificacion>
  <Usuario>7065706f7465</Usuario>
  <Resultado>1</Resultado>
  <Comentario>Autentificacion satisfactoria.Remitente Aceptado</Comentario>
  <Saldo>8888</Saldo>
</Autentificacion>
<Mensajes idenvioext="313233343536373839" idenviodm="123456" total_mensajes="3" total_ok="2" total_error="1" total_creditos="2" total_sms_ok="2" total_sms_error="1">
    <Mensaje>
        <Id>1</Id>
        <IdDM>123</IdDM>
        <Resultado>1</Resultado>
        <Comentario>Mensaje Enviado</Comentario>
    </Mensaje>
    <Mensaje>
        <Id>2</Id>
        <IdDM>0</IdDM>
        <Resultado>0</Resultado>
        <Comentario>Mensaje no Enviado</Comentario>
    </Mensaje>
    <Mensaje>
        <Id>3</Id>
        <IdDM>125</IdDM>
        <Resultado>1</Resultado>
        <Comentario>Mensaje Enviado</Comentario>
    </Mensaje>
</Mensajes>
</RXEnvio>

 

3. Ejemplos

Descarga nuestros ejemplos: 

4. Gráfico

Enviar-SMS-InterfazHTTP