Escolar Documentos
Profissional Documentos
Cultura Documentos
Manual de Integracin
SMS Inteligente
www.aldeamo.com
Contenido
1. Control de Cambios ......................................................................................................... 2
2. Introduccin .................................................................................................................... 3
3. Envo de Mensajes de Texto (MT) ................................................................................... 4
3.1. MT: Webservice Rest tipo GET ................................................................................. 5
3.2. MT: Webservice tipo SOAP ....................................................................................... 6
3.3. MT: Webservice Rest tipo POST ............................................................................... 8
4. Recepcin de Mensajes de Texto (MO) .......................................................................... 9
4.1. MO - Webservice Rest tipo GET ............................................................................. 10
4.2. MO - Webservice Rest tipo POST ........................................................................... 10
4.3. MO - Webservice tipo SOAP ................................................................................... 11
5. Tablas de Caracteres Permitidos* ................................................................................. 12
www.aldeamo.com 1
1. Control de Cambios
www.aldeamo.com 2
2. Introduccin
Para la integracin de nuestros clientes a la plataforma SMS Inteligente, contamos con
varios APIs que permiten a nuestros aliados el envo y recepcin de mensajes de texto, estas
tecnologas facilitan una integracin rpida y transparente con el fin de potencializar el
negocio de nuestros clientes y asociados.
www.aldeamo.com 3
3. Envo de Mensajes de Texto (MT)
La plataforma SMS Inteligente permite la integracin para envi de mensajes originados por
su plataforma (MT: Mobile Terminated) por medio de varios servicios de integracin
expuestos:
A. HTTP GET
B. WEB SERVICES (SOAP)
*Para envos masivos se recomienda utilizar el mtodo HTTP POST para evitar cargas
masivas en el servidor que pueden causar fallas en el funcionamiento del servicio.
*Las URL o IP:Puerto que se listan a continuacin son un ejemplo, la ruta de envo debe ser
suministrada por su consultor comercial.
www.aldeamo.com 4
3.1. MT: Webservice Rest tipo GET
Este API est basado en llamados HTTP GET hechos por el cliente a una URL. Bajo este
esquema los parmetros de la solicitud de envo se adjuntan a la peticin HTTP va GET.
Parmetros:
Parmetro Descripcin
username Usuario asignado al cliente para el envo.
password Contrasea asignada.
mobile Telfono del destino.
country Cdigo internacional del pas.
message Texto del mensaje a ser enviado.
operator (Opcional) Operador del nmero, en caso que sea portado.
Valores permitidos
Tigo:57-tigo
Movistar: 57-movistar
Claro: 57-claro
Comcel: 57-avantel
Tabla 1. Parmetros HTTP GET
Valores Retornados
Se retornar una lnea de texto con los siguientes posibles valores:
Cualquier nmero mayor que cero (0), representa un identificador nico de la peticin,
lo cual indica que la transaccin fue exitosa.
{id_mensaje}|Message sent.
www.aldeamo.com 5
3.2. MT: Webservice tipo SOAP
Este api est basado en la comunicacin de servicios web a travs de SOAP.
Mtodo Remoto
Para el envo de mensajes se debe implementar el mtodo SmsSendSoap con los siguientes
Parmetros:
Parmetro Descripcin
www.aldeamo.com 6
XML respuesta envo exitoso:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:smsSendSoapResponse
xmlns:ns2="http://habitatclient.service.soapws.core.com/">
<return>{id_mensaje}|Message sent</return>
</ns2:smsSendSoapResponse>
</S:Body>
</S:Envelope>
www.aldeamo.com 7
3.3. MT: Webservice Rest tipo POST
Este api est basado en llamados HTTP POST hechos por el cliente a una URL. Bajo este
esquema se debe enviar una peticin con la siguiente estructura.
Content-Type: application/xml
XML peticin:
<?xml version="1.0" encoding="ISO-8859-1"?>
<sending>
<authentication>
<username>${username}</username>
<password>${password}</password>
</authentication>
<country>${country}</country>
<recipients>
<sms>
<mobile>${mobile}</mobile>
<message>${message}</message>
<operator></operator>
</sms>
</recipients>
</sending>
Valores Retornados
Se retornar una lnea de texto con los siguientes posibles valores:
Cualquier nmero mayor que cero (0), representa un identificador nico de la peticin, lo
cual indica que la transaccin fue exitosa.
www.aldeamo.com 8
4. Recepcin de Mensajes de Texto (MO)
Para la integracin de nuestra plataforma SMS Inteligente hacia Web Services expuestos
por nuestros clientes en el proceso de entrega de mensajes originados por los usuarios
desde sus celulares (MO: Mobile Originated), se sugiere generar un servicio web en alguno
de los API que se describen en el presente documento.
A continuacin se detallan y ejemplifican cada una de estas tecnologas (API) para poder
guiar su construccin.
www.aldeamo.com 9
4.1. MO - Webservice Rest tipo GET
Este API est basado en llamados HTTP GET hechos por Aldeamo a una URL del cliente. Bajo
este esquema los parmetros de la solicitud de envo se adjuntan a la peticin HTTP va GET.
Valores Retornados
Se espera retorne una lnea de texto con los siguientes posibles valores:
1 | Transaccin exitosa
0 | Error
Content-Type: application/xml
XML peticin:
<?xml version="1.0" encoding="ISO-8859-1"?>
<sending>
<recipients>
<sms>
<mobile>${mobile}</mobile>
<message>${message}</message>
</sms>
</recipients>
</sending>
Valores Retornados
Se espera retorne una lnea de texto con los siguientes posibles valores:
1 | Transaccin exitosa
0 | Error
www.aldeamo.com 10
4.3. MO - Webservice tipo SOAP
Este api est basado en la comunicacin de servicios web a travs de SOAP.
XML peticin:
Se espera poder realizar una peticin de entrega de mensajera con parmetros similares a
los siguientes:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:hab="http://XXXXXXX/">
<soapenv:Header/>
<soapenv:Body>
<hab:smsSoap>
<mobile>{mobile}</mobile>
<message>>{message}</message>
</hab:smsSoap>
</soapenv:Body>
</soapenv:Envelope>