API HTTP-XML: Enviar SMS

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
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á protegida contra spambots. Usted necesita tener Javascript activado para poder verla. 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.
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 | Sí | Número total de mensajes en el envío | Numérico | |
| Control | Sí | 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 | Sí | Identificador de cada mensaje en la trama | 1,2,3,... | Numérico |
| destino | Sí | 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 | Sí | 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:
Ejemplo de trama de para obtener el Saldo en Descom SMS:
Se envía la misma trama pero quitando el nodo de <Mensajes>
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.
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.
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:
3. Ejemplos
4. Gráfico
