PDF de programación - SMTP XML API - Permite enviar SMS mediante correo electrónico

SMTP XML API

Permite enviar SMS mediante correo electrónico.

Aspectos generales

En los ejemplos de esta documentación se usa el símbolo {:name} para tu nombre de usuario y {:pass} para tu contraseña.

Para enviar SMS/MMS mediante la plataforma de envío de SMS vía email de Lleida Networks, simplemente debe enviar un
email con los siguientes parámetros:

Asunto Vacío.
Destinatario [email protected]
Cuerpo del mensaje El cuerpo del mensaje debe ir formateado según la especificación de las secciones 1, 2, o 3.

Elementos comunes
Elemento dst
Este elemento debe contener uno o más subelementos num, cada uno de los cuales contiene un número de teléfono
destinatario del mensaje:
Ejemplo de petición

<dst>

<num>+34600000000</num>
<num>+41700000000</num>
<num>+33888888888</num>

</dst>

Los números de teléfono deben indicarse en formato internacional (es decir, con el signo + al principio del código de país).

No hay un límite definido para la cantidad de destinatarios de un mensaje, pero se recomienda no sobrepasar los 1000.

Tenga en cuenta que en las URL se deben codificar correctamente los símbolos especiales. Por ejemplo en este caso %2B
que corresponde al símbolo +.

Elemento src
Este elemento contiene el remitente del mensaje, el remitente puede ser numérico o alfanumérico. Si el remitente es
alfanumérico, éste no puede superar los 11 carácteres de longitud, si es numérico, no puede superar los 15 carácteres.

Ejemplo de petición

<sms>

<user>:name</user>
<password>:pass</password>
<src>miremitente</src>

...

Elemento txt
El elemento txt contiene el texto del SMS que se enviará. En el caso que la longitud del texto sea mayor que el límite de
caracteres por SMS (160 en caso de mensajes de texto con codificación ASCII, y 70 en el caso de mensajes en codificación
Unicode), el SMSC de Lleida Networks dividirá el mensaje en varios SMS encadenados.

Este elemento dispone de dos parámetros opcionales, enconding y charset, para el caso que el texto del mensaje esté en
una codificación diferente de la especificada en la cabecera del XML. Un ejemplo sería el caso que el XML esté codificado en
ISO-8859-1 y se quiera enviar un SMS en Unicode.

Si el texto del mensaje está en una codificación diferente de la del XML, el parámetro encoding debe tener el valor base64, y
el contenido del elemento txt debe estar codificado en base64. De este modo se evita el problema deque el XML no sea
válido por encontrar caracteres no permitidos en la codificación utilizada. Además, el parámetro charset debe contener el
código de caracteres utilizado (por ejemplo, 'utf-16' para codificación Unicode). Cuando el servidor de la API se encuentra
con estos parámetros, primero descodifica el texto de base64, y posteriormente lo importa según el charset especificado.

Debe remarcarse que los parámetros enconding y charset no afectan a la codificación del SMS resultante: su única función
es poder incluir texto en cualquier charset dentro del XML. La codificación que tendrá el SMS cuando se envíe depende del
contenido del elemento data_coding.

El siguiente ejemplo especifica como texto del SMS la frase "Hello world", pero utilizando la codificación utf-16.
Ejemplo

<txt encoding="base64" charset="utf-16">
/v8ASAB1AGwAbABvACAAdwBvAHIAbABk
</txt>

Elemento data_coding
Este elemento opcional controla la codificación en que se enviará el SMS (ver la especificación de la 3GPP número TS
23.038). Los dos valores permitidos son: text, sólo se permiten en el texto del mensaje los caracteres del alfabeto
ISO-8859-1. En cambio, con el valor 'unicode' se puede utilizar caracteres de cualquier alfabeto del mundo (siempre y
cuando el teléfono receptor lo permita), ya que el SMS es enviado en utf-16.

Si se mandan SMS Unicode, probablemente deberá combinar este elemento junto con los parámetros enconding y charset

del elemento txt.

El siguiente ejemplo envía un SMS que contiene las letras griegas alfa y beta:
Ejemplo de petición

<?xml version="1.0" encoding="ISO-8859-1"?>
<sms>

<user>:name</user>
<password>:pass</password>
<dst>

<num>+3088888888</num>

</dst>
<txt encoding="base64" charset="utf-16">

/v8DsQ0y

</txt>
<data_coding>unicode</data_coding>

</sms>

Elemento delivery_receipt
Este elemento activa la petición de notificación de entrega para el SMS. El elemento puede estar vacío, o contener una
dirección de correo electrónico.

Si contiene una dirección de correo electrónico, se enviará un mail a esta dirección cuando la operadora notifique algún
cambio de estado del mensaje, que pueden ser Delivered, Buffered (fuera de cobertura o apagado), Acknowledged (by
the operator SMC) o Rejected.

Si el elemento aparece vacío, se activa igualmente la petición de notificación. Cuando se reciba, el estado del mensaje se
anota en las bases de datos del SMSC de Lleida Networks, y puede ser consultado mediante la intranet de usuario.

Este elemento dispone de cuatro atributos opcionales que se utilizan para activar y configurar el servicio de SMS certificado.

En el atributo lang se indica el idioma en que se desea recibir el certificado de recepción, cuyo valor por defecto es Español.

El atributo cert_type debe contener el tipo de certificado que se quiere consultar: D para el tipo certificado y T para los
contratos.

Los atributos cert_name y cert_name_id se utilizan para indicar la razón social y el NIF que aparecerá en la certificación del
PDF.

Los idiomas disponibles para el certificado son:

Código

DE

CA

ES

FR

EN

IT

NL

PT

Código

Idioma

Alemán

Catalán

Español

Francés

Inglés

Italiano

Neerlandés

Portugués

Idioma

IMPORTANTE: Si se activa el servicio de SMS certificado, el elemento delivery_receipt debe contener el correo electrónico
dónde se enviará el certificado de recepción. En caso de no contener el correo electrónico aparecerá el error -8: Correo
electrónico incorrecto.
Ejemplo de envío de SMS con notificación via email:

<?xml version="1.0" encoding="ISO-8859-1"?>
<sms>

<user>:name</user>
<password>:pass</password>
<dst>

<num>+3460000000</num>
<num>+3466666666</num>

</dst>
<txt>El texto del mensaje</txt>
<delivery_receipt>

[email protected]

</delivery_receipt>

</sms>

Ejemplo de envío de SMS con petición de estado de entrega sin enviarla a un email:

<?xml version="1.0" encoding="ISO-8859-1"?>
<sms>

<user>:name</user>
<password>:pass</password>

<dst>

<num>+3460000000</num>
<num>+3466666666</num>

</dst>
<txt>El texto del mensaje</txt>
<delivery_receipt/>

</sms>

Ejemplo de envío de SMS con certificado de recepción:

<?xml version="1.0" encoding="ISO-8859-1"?>
<sms>

<user>:name</user>
<password>:pass</password>
<dst>

<num>+3460000000</num>
<num>+3466666666</num>

</dst>
<txt>El texto del mensaje</txt>

<delivery_receipt lang = "ES" cert_type="D">
[email protected]

</delivery_receipt>

</sms>

Elemento allow_answer
Este elemento permite especificar que el envío del mensaje se realice con un remitente numérico largo para que el
destinatario pueda responderlo. Si el usuario tiene un número própio asignado se utilizará éste, sino se asignará uno
dinámico.

Cuando se especifica este elemento no puede aparecer el elemento src.
Ejemplo de petición

<?xml version="1.0" encoding="ISO-8859-1"?>
<sms>

<user>:name</user>
<password>:pass</password>
<dst>

<num>+3460000000</num>
<num>+3466666666</num>

</dst>
<txt>El texto del mensaje</txt>
<allow_answer/>

</sms>

Elemento mt_id
Este elemento permite que el usuario asigne un identificador único para cada mensaje, que posteriormente se puede
utilizar para consultar el estado del mensaje.

El contenido del elemento debe ser una cadena alfanumérica única, a la que posteriormente el sistema añadirá el número
de destino para formar el identificador.
Ejemplo de petición

<?xml version="1.0" encoding="ISO-8859-1"?>
<sms>

<user>:name</user>
<password>:pass</password>
<dst>

<num>+3460000000</num>
<num>+3466666666</num>

</dst>
<txt>El texto del mensaje</txt>
<mt_id>ABCDE1234</mt_id>

</sms>

Tal como se ha indicado, el sistema añade el teléfono de destino al identificador para poder gestionar el caso de
multienvíos. En el ejemplo anterior, el identificador generado para el primer mensaje sería ABCDE1234:+34600000000, y
para el segundo sería ABCDE1234:+34666666666.

IMPORTANTE: Si con el mismo mt_id se repite el destinatario, la consulta de estado sólo devolverá la información del
último enviado.

Elemento schedule.
Con este elemento se puede especificar la fecha y hora en que se desea que se entregue el mensaje en destino. De este
modo es posible realizar un envío de mensajes programado a una fecha y hora concretas. El formato de la fecha debe ser
YYYYMMDDhhmm.
Ejemplo de petición
Este ejemplo programaría el mensaje de texto para ser entregado a los dos destinatarios el día 1 de Diciembre del 2007 a las
13:50.

<?xml version="1.0" encoding="ISO-8859-1"?>
<sms>

<user>:name</user>

<password>:pass</password>
<dst>

<num>+3460000000</num>
<num>+3466666666</num>

</dst>
<txt>El texto del mensaje</txt>
<schedule>200712011350</schedule>

</sms>

Elemento mail
Este elemento permite especificar una dirección de correo electrónico a la que se enviará el reporte con el resultado del
envío del mensaje y el saldo disponible en la cuenta del usuario que realiza el envío.

<sms>

<user>:name</user>
<password>:pass</password>
<dst>

<num>+3460000000</num>
<num>+3466666666</num>

</dst>
<txt>this is the SMS text</txt>
<mail>[email protected]</mail>

</sms>

Tipos de MMS

MMS Permite enviar y recibir contenidos multimedia, incorporando sonido, video, fotos o cualquier contenido disponible en el futuro.
Wappush El envío de un Wappush es significativamente más económico que el envío de un MMS, y es obligatorio para contenidos que
no son multimedia, por ejemplo, juegos Java. En contrapartida, es menos directo para el usuario final, ya que éste debe autorizar la
descarga del contenido.
Waplink El formato del cuerpo del mensaje para este tipo de envios es parecido al de envi