Documentación técnica de la pasarela Email-SMS

Documentación técnica de la pasarela Email-SMS

Pasarela de comunicación "Email a SMS"
Para realizar envíos SMS a partir de un email, éste tiene que enviarse a la dirección
[email protected] conteniendo cierta información en un formato específico. La
cabecera del email es indiferente, pero el cuerpo del mensaje debe basarse en el siguiente modelo:
<masteraccountid>Clave-Master</masteraccountid>
<subaccountid>Clave-Cliente</subaccountid>
<mobile>612345678;666777888;600111222</mobile>
<message>Este es un mensaje de prueba</message>
<sender>MiRemitente</sender>
<immediatedelivery>1</immediatedelivery>
<deliverydate></deliverydate>
<reply>2</reply>
<replychannel>[email protected];699888777</replychannel>
También es posible identificar la cuenta del cliente en cuestión mediante email y password, en vez de los
campos masteraccountid y subaccountid. En ese caso deberá tener el siguiente formato:
<email>[email protected]</email>
<password>1234</password>
<mobile> ….</mobile>
etc.
Donde:
- masteraccountid: corresponde a la clave máster que TAP asigna a la empresa desarrolladora al
darse de alta en el servicio.
- subaccountid: identificador de la cuenta del cliente (tiene que estar dada de alta previamente en
el web de gestión que se encuentra en www.plataforma-sms.com).
- email: en caso de no desear identificar la cuenta de cliente vía masteraccountid/subaccountid,
podremos utilizar el par email/password (que previamente ha tenido que darse de alta en el web de
gestión).
- password: parámetro que irá ligado al email.
- mobile: listado de móviles separados por punto y coma (en caso de indicar más de uno). En el
caso de ser un móvil internacional, habrá que indicar su prefijo internacional (como por ejemplo
4917612345678 para Alemania).
- message: contenido que no debe superar los 160 caracteres. Si fuera así, se recortaría el texto
hasta los primeros 160.
- sender (opcional): corresponde al remitente que se utilizará y tiene que estar previamente dado de
alta. No hay limitación en el número de remitentes a utilizar ni sobrecoste alguno. No debe superar
los 11 caracteres alfanuméricos (o podría ser un número de móvil también). Si no se indica
ninguno, se le asignará el que tuviera por defecto.
- immediatedelivery (opcional): sus valores posibles son 0 y 1. El valor 1 significa que el envío se
realizará al instante. El valor 0 nos indicará que es diferido y se enviará cuando el parámetro
"deliverydate" indique. Si no se indica, su valor por defecto es 1.
- deliverydate (opcional): parámetro ligado a “immediatedelivery”. Vendrá en formato
yyyymmddhhmmss, donde los minutos deben ser múltiplos de 15 (es decir, 00, 15, 30 y 45) y los
segundos = 00. Ejemplo: 20081204181500 (las 6 y cuarto pm del 4 de diciembre del 2008).
-
reply (opcional): este parámetro es para los casos de desear que se nos comunique qué ha
pasado con la comunicación. Tiene 3 posibles valores: 0 significa que no deseamos ninguna
notificación (valor por defecto). 1 implica que queremos que se nos comunique qué ha pasado sólo
en el caso de incidencia (cuando haya habido algún problema en el envío del SMS). El valor 2
implica que deseamos que se nos informe de qué ha pasado con la comunicación,
independientemente del éxito de su ejecución.
- replychannel (opcional): si en "reply" hemos indicado que deseamos que se nos comunique algo,
aquí indicaremos cómo queremos que se nos informe, si por email y/o SMS. En el ejemplo de
arriba vemos como podemos indicar tanto correo como número de móvil a la vez.
Towerplane Advanced Projects S.L.L. C/. Carlota Pasarón, 25 Baix. 03005 ALACANT/ALICANTE
T: 966-083-591 F: 966-084-071 [email protected] www.towerplane.com
Vemos pues como los únicos valores imprescindibles serían:
Para el caso de utilizar masteraccountid/subaccountid:
<masteraccountid>Clave-Master</masteraccountid>
<subaccountid>Clave-Cliente</subaccountid>
<mobile>612345678;666777888;600111222</mobile>
<message>Este es un mensaje de prueba</message>
En caso de utilizar email/password:
<email>[email protected]</email>
<password>1234</password>
<mobile>612345678;666777888;600111222</mobile>
<message>Este es un mensaje de prueba</message>
No dude en poner un email a [email protected] en caso de alguna duda, problema o sugerencia.
Towerplane Advanced Projects S.L.L. C/. Carlota Pasarón, 25 Baix. 03005 ALACANT/ALICANTE
T: 966-083-591 F: 966-084-071 [email protected] www.towerplane.com