Professional Documents
Culture Documents
1
Contenido
1 Objetivo .................................................................................................................... 4
2
4.2 Consulta de Respuestas ...............................................................................................19
3
1 Objetivo
El objetivo de este documento es explicar los distintos puntos de conectividad disponibles para el
envo y recepcin de mensajes SMS a travs de la herramienta SMS Broadcaster de TIGO.
2 Caractersticas Generales
El SMS Broadcaster cuenta con varios puntos de conexin para el envo y recepcin de mensajes
SMS:
E-Mail to SMS
SMPP
4
3 Web Service para envo y Recepcin de SMS
El Web Service utilizado es bastante sencillo y consta nicamente con cinco mtodos:
respuestaSMS1: Mtodo utilizado para extraer las respuestas recibidas (SMS entrantes)
Para la utilizacin del API es necesario que el cliente tenga configurado en el SMS
Broadcaster un SENDER con permisos para utilizacin de API. Es necesario solicitar
dichos permisos a TIGO.
El API soporta los siguientes formatos de peticin al Web Service (se utiliza la misma URL para
todos):
SOAP
HTTP GET
HTTP POST
1 Los mensajes entrantes solo estn disponibles si el cliente solicito la funcionalidad de recibir respuestas en el SMS
Broadcaster
5
3.1.1 Parmetros
6
3.1.2 Ejemplo de Solicitud SOAP
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tigo="https:// tigo.com.sv/wsAPIBulkSMS">
<soapenv:Header/>
<soapenv:Body>
< enviarSMS >
<!Mandatory -->
< usuario>?</ usuario>
< contrasea >?</ contrasea >
< numero >?</ numero >
<mensaje >?</ mensaje >
<remitente >?</ remitente >
</ enviarSMS >
</soapenv:Body>
</soapenv:Envelope>
http://apisms.tigobusiness.com.ni/wsAPISmsCorp.asmx/wsAPISmsCorp.asmx/enviarSMS?usuario
=generico&contrasena=xxxxxx&numero=50379872374&mensaje=test&remitente=Tigo
El formato en que se retorna este objeto por defecto es XML, pero puede solicitarse en JSON
usando el header HTTP:
Accept: application/json
7
MensajeRespuesta Mensaje descriptivo relacionado con el codigoEstado Cadena de
caracteres
3.2.1 Parmetros
8
An cuando es un solo mensaje su costo
depender de la cantidad de SMS requeridos para
el envo del mismo
<soap:Envelopexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<enviarBulkSms xmlns="http://tempuri.org/">
<!Mandatory -->
<usuario>?</usuario>
<contrasena>?</contrasena>
<Mensajes>
<clMensajes>
<numero>999999</numero>
<mensaje>xxx</mensaje>
<remitente>xxx</remitente>
</clMensajes>
<clMensajes>
<numero>999999</numero>
<mensaje>xxx</mensaje>
<remitente>xxx</remitente>
</clMensajes>
</Mensajes>
</enviarBulkSms>
</soap:Body>
</soap:Envelope>
9
3.2.4 Objeto de Respuesta: clRespuestaBulksms
El formato en que se retorna este objeto por defecto es XML, pero puede solicitarse en JSON
usando el header HTTP:
Accept: application/json
3.3.1 Parmetros
10
<?xml version="1.0" encoding="UTF-8" ?>
<mensajes>
<clMensajes>
<numero>9999999</numero>
<mensaje>test</mensaje>
<remitente>XX</remitente>
</clMensajes>
<clMensajes>
<numero>88888888</numero>
<mensaje>Hola test</mensaje>
<remitente>Mundial</remitente>
</clMensajes>
</mensajes>
<soap:Envelopexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<enviarBulkSmsXML xmlns="http://tempuri.org/">
<!Mandatory -->
<usuario>?</usuario>
<contrasena>?</contrasena>
<Mensajes>
Cadena de caracteres en formato XML de acuerdo a lo especificado en la tabla anterior (tabla 3.3.1)
</Mensajes>
</enviarBulkSmsXML>
</soap:Body>
</soap:Envelope>
11
3.3.3 Objeto de Respuesta: clRespuestaBulksmsXML
El formato en que se retorna este objeto por defecto es XML, pero puede solicitarse en JSON
usando el header HTTP:
Accept: application/json
12
3.4 Mtodo: Confirmacin SMS
Mtodo para consultar el estado de uno o varios SMS enviados a travs del mtodo enviarSMS.
Los posibles estados de un SMS son:
CON= confirmacin lectura (mensaje enviados exitosamente, que cuenta con confirmacin
de entrega del dispositivo mvil, no todas las operadoras son compatibles con esta
funcionalidad)
3.4.1 Parmetros
referencias Lista de referencias divididas por comas para identificar los Cadena de
mensajes SMS para los que se desea consultar su estado. caracteres
13
3.4.2 Objeto de Respuesta: clConfirmacionSMS
El formato en que se retorna este objeto por defecto es XML, pero puede solicitarse en JSON
usando el header HTTP:
Accept: application/json
14
valores son: caracteres
ENV=Enviado
3.5.1 Parmetros
Una vez invocado el mtodo respuesSMS se retornar un objeto de tipo clRespuestasSMS que
cuenta con las siguientes propiedades:
15
as
El arreglo viene vaci si la consulta no fue exitosa segn lo
reflejado en la propiedad codigoEstado
Cdigo de Mensaje Aplica para Aplica para Aplica para Aplica para Aplica para
estado enviarSMS enviarBulkS enviarBulkSMS confirmacionSM respuestaSM
MSXML S S
0 Mensaje colocado SI SI SI SI No
exitosamente
2 Parmetro CONTRASENA SI SI SI SI Si
vaco
16
6 Usuario o contrasea invalida SI SI SI SI Si
10 Error no controlado SI SI SI SI Si
11 Parmetro REFERENCIAS NO NO NO SI No
vacio
15 El nmero de telfono Si Si Si No No
ingresado no es valido,
recuerde utilizar el formato
[codigoPas] +
[numeroTelefono], solo son
aceptado telfonos de El
Salvador. En el caso de
nmeros para El Salvador el
[codigoPas] es opcional
16 El nmero Corto de la No No No No Si
Campaa no permite
Respuestas
17
4 Envo y Recepcin SMS por Insercin a Base de Datos
Por su facilidad de implementacin el SMS Broadcaster permite enviar SMS mediante la insercin
de los mensajes en una tabla de SQL Server. Adicionalmente se provee una vista donde el cliente
puede consultar los mensajes entrantes 2 y estado de mensajes enviados.
Todos los objetos de SQL Server descritos en este documento se encuentran en la base de datos
bulkSMS, esta ser la base de datos por defecto para el usuario de SQL Server que se
entregar al cliente.
El usuario de SQL Server entregado al cliente tiene los permisos restringidos y nicamente puede:
Hacer INSERT en la tabla bandejaSalidaSMS los SELECT a esa tabla no son permitidos
Mensaje: Contenido del mensaje. Cada SMS puede contener un mximo de 160
caracteres. El sistema permite enviar mensajes ms grandes pero estos se envan por
medio de mensajes concatenados (un SMS por cada 160 se caracteres, al llegar al celular
todos los SMS se unen en un solo mensaje y el proceso es transparente para el usuario
final). El cobro al cliente es por SMS no por mensaje.
2 Los mensajes entrantes solo estn disponibles si el cliente solicito la funcionalidad de recibir respuestas en el SMS
Broadcaster
18
Al insertar el mensaje se puede utilizar el comando @@identity de SQL server para obtener el
cdigo del mensaje y de esta manera consultar su estado posteriormente.
OutgoingId: cdigo del mensaje saliente relacionado con este mensaje entrante
Para saber el estado del mensaje basta consultar el campo exitoso de la vista
bulksms_NC.dbo.vwBandejaSalida[nombreCliente]
19
SELECT exitoso FROM bulksms_NC.dbo.vwBandejaSalidaAsesuisa where
codigo=@codigo
20