0% encontró este documento útil (0 votos)
0 vistas21 páginas

ManualAPI

El manual de API para SMS Broadcaster TIGO detalla los métodos y parámetros necesarios para el envío y recepción de mensajes SMS, incluyendo opciones como SOAP, GET y POST. Se describen métodos específicos como enviarSMS, enviarBulkSms y confirmar el estado de los mensajes enviados. Además, se menciona la necesidad de contar con permisos adecuados en el sistema para utilizar la API.

Cargado por

rpalacios
Derechos de autor
© All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
0% encontró este documento útil (0 votos)
0 vistas21 páginas

ManualAPI

El manual de API para SMS Broadcaster TIGO detalla los métodos y parámetros necesarios para el envío y recepción de mensajes SMS, incluyendo opciones como SOAP, GET y POST. Se describen métodos específicos como enviarSMS, enviarBulkSms y confirmar el estado de los mensajes enviados. Además, se menciona la necesidad de contar con permisos adecuados en el sistema para utilizar la API.

Cargado por

rpalacios
Derechos de autor
© All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd

MANUAL DE API

SMS Broadcaster TIGO

1
Contenido
1 Objetivo ........................................................................................................................ 4

2 Características Generales .......................................................................................... 4

3 Web Service para envío y Recepción de SMS ......................................................... 5


3.1 Método: enviarSMS....................................................................................................... 5

3.1.1 Parámetros ............................................................................................................... 6

3.1.2 Ejemplo de Solicitud SOAP ...................................................................................... 7

3.1.3 Ejemplo Solicitid GET ............................................................................................... 7

3.1.4 Objeto de Respuesta: clRespuesta........................................................................... 7

3.2 Método enviarBulkSms ................................................................................................. 8

3.2.1 Parámetros ............................................................................................................... 8

3.2.2 Sub-objeto: clMensajes............................................................................................. 8

3.2.3 Ejemplo de Solicitud SOAP ...................................................................................... 9

3.2.4 Objeto de Respuesta: clRespuestaBulksms ........................................................... 10

3.3 Método enviarBulkSmsXML ........................................................................................ 10

3.3.1 Parámetros ............................................................................................................. 10

3.3.2 Ejemplo de Solicitud SOAP .................................................................................... 11

3.3.3 Objeto de Respuesta: clRespuestaBulksmsXML .................................................... 12

3.4 Método: Confirmación SMS ........................................................................................ 13

3.4.1 Parámetros ............................................................................................................. 13

3.4.2 Objeto de Respuesta: clConfirmacionSMS ............................................................. 14

3.4.3 Sub-objeto de respuesta: clListadoEnvios .............................................................. 14

3.5 Método: RespuestaSMS ............................................................................................. 15

3.5.1 Parámetros ............................................................................................................. 15

3.5.2 Objeto de Respuesta: clRespuestasSMS ............................................................... 15

3.5.3 Sub-objeto de respuesta: clListaRespuestas .......................................................... 16

3.6 Método: RespuestaBESMS......................................................................................... 17

3.6.1 Parámetros ............................................................................................................. 17

3.6.2 Objeto de Respuesta: clRespuestasSMS ............................................................... 17

2
3.6.3 Sub-objeto de respuesta: clListaRespuestas .......................................................... 18

3.7 Códigos de Estado ...................................................................................................... 18

4 Envío y Recepción SMS por Inserción a Base de Datos ...................................... 20


4.1 Envío de Mensajes ...................................................................................................... 20

4.2 Consulta de Respuestas ............................................................................................. 21

4.3 Opcional: Consulta de Estado de envío ...................................................................... 21

3
1 Objetivo
El objetivo de este documento es explicar los distintos puntos de conectividad disponibles para el
envío y recepción de mensajes SMS a través de la herramienta SMS Broadcaster de TIGO.

2 Características Generales
El SMS Broadcaster cuenta con varios puntos de conexión para el envío y recepción de mensajes
SMS:

• Web Service SOAP, GET y POST

• Inserciones y lecturas de base de datos SQL Server

• E-Mail to SMS

• SMPP

La finalidad de este documento es describir en detalla la forma de utilizar:

• Web Service SOAP, GET y POST

• Inserciones y lecturas de base de datos SQL Server

El resto de modalidades por considerarse estándar no se mencionan en este manual:

1. E-Mail to SMS: Consiste únicamente en generar un correo electrónico a la dirección:


[celular destino]@[Link]

2. SMPP: Se refiere al protocolo estándar para recepción y envío de SMS. Se recomienda


que solo sea utilizada por empresas que ya cuenten con este protocolo implementado en
sus sistemas internos.

4
3 Web Service para envío y Recepción de SMS
El Web Service utilizado es bastante sencillo y consta únicamente con cinco métodos:

• enviarSMS: Método utilizado para enviar un SMS a cualquier operadora de Centroamérica


a través del SMS Broadcaster de TIGO

• enviarBulkSms: Método utilizado para enviar uno o más SMS a cualquier operadora de
Centroamérica a través del SMS Broadcaster de TIGO. La lista de mensajes a enviar se
especifica como un arreglo de objetos.

• enviarBulkSmsXml: Método utilizado para enviar uno o más SMS a cualquier operadora
de Centroamérica a través del SMS Broadcaster de TIGO. La lista de mensajes a enviar se
especifica en una cadena de caracteres en formato XML.

• confirmacionSMS: Método para consultar el estado de uno o varios SMS enviados a


través del método “enviarSMS”

• respuestaSMS1: Método utilizado para extraer las respuestas recibidas (SMS entrantes)

Para la utilización del API es necesario que el cliente tenga configurado en el SMS
Broadcaster un SENDER con permisos para utilización de API. Es necesario solicitar
dichos permisos a TIGO.

El API soporta los siguientes formatos de petición al Web Service (se utiliza la misma URL para
todos):

• SOAP

• HTTP GET

• HTTP POST

3.1 Método: enviarSMS


El método enviarSMS es utilizado para enviar un SMS a destinos en cualquier operadora de
Centroamérica a través del SMS Broadcaster de TIGO.

El método puede llamarse vía SOAP, HTTP GET o HTTP POST.

1
Los mensajes entrantes solo están disponibles si el cliente solicito la funcionalidad de recibir respuestas en el SMS
Broadcaster

5
3.1.1 Parámetros

Parámetro Descripción Tipo de dato

usuario Usuario utilizado para autenticarse en el SMS Broadcaster, Cadena de


este usuario será proporcionado por TIGO. caracteres

contrasena Contraseña utilizada para autenticarse en el SMS Broadcaster, Cadena de


será proporcionado por TIGO. Caracteres

numero Número de teléfono del destinatario del mensaje. Debe Cadena de


incluirse el código de país (503 en el caso de El Salvador, ej.: caracteres
50378870000)

mensaje El mensaje que se desea enviar por SMS. Cadena de


caracteres
Nota importante: El estándar requiere que cada SMS tenga
un máximo de 160 caracteres. Es posible enviar mensajes de
tamaño mayor pero esto implica que:

• Se generaran varios SMS concatenados para enviar


el mensaje

• Aun cuando es un solo mensaje su costo dependerá


de la cantidad de SMS requeridos para el envío del
mismo

Remitente Es el número origen del SMS (longitud máxima 11 Cadena de texto


caracteres). Se aceptan remitentes alfanuméricos. Los
remitentes alfanuméricos solo son compatibles con la red
TIGO y Claro de El Salvador para otras redes el remitente
alfanumérico es sustituido de manera automática por un
número.

6
3.1.2 Ejemplo de Solicitud SOAP

<soapenv:Envelope xmlns:soapenv="[Link]
xmlns:tigo="https:// [Link]/wsAPIBulkSMS">
<soapenv:Header/>
<soapenv:Body>
< enviarSMS >
<!—Mandatory -->
< usuario>?</ usuario>
< contraseña >?</ contraseña >
< numero >?</ numero >
<mensaje >?</ mensaje >
<remitente >?</ remitente >
</ enviarSMS >
</soapenv:Body>
</soapenv:Envelope>

3.1.3 Ejemplo Solicitid GET

[Link]
x&numero=50379872374&mensaje=test&remitente=Tigo

3.1.4 Objeto de Respuesta: clRespuesta

Una vez invocado el método enviarSMS se retornará un objeto de tipo “clRespuesta”.

El formato en que se retorna este objeto por defecto es XML, pero puede solicitarse en JSON
usando el header HTTP:

• Accept: application/json

El objeto cuenta con las siguientes propiedades:

Parámetro Descripción Tipo de dato

codigoEstado Código de estado del resultado de la transacción, referirse a Entero de 32bits


la sección 3.6 para ver los posibles códigos de estado

esEnvioExitoso Si el cliente no desea manejar los distintos estados de Bolean


transacción (codigoEstado) basta utilizar este valor para
determinar si el mensaje se encolo exitosamente

MensajeRespuesta Mensaje descriptivo relacionado con el codigoEstado Cadena de


caracteres

7
referencia Referencia única para identificar el mensaje al momento de Entero 32 bits
consultar la confirmación de entrega

3.2 Método enviarBulkSms


Método utilizado para enviar uno o más SMS a cualquier operadora de Centroamérica a través del
SMS Broadcaster de TIGO.

La lista de mensajes a enviar se especifica como un arreglo de objetos clMensajes.

3.2.1 Parámetros

Parámetro Descripción Tipo de dato

usuario Usuario utilizado para autenticarse en el SMS Broadcaster, Cadena de


este usuario será proporcionado por TIGO. caracteres

contrasena Contraseña utilizada para autenticarse en el SMS Broadcaster, Cadena de


será proporcionado por TIGO. Caracteres

mensajes Arreglo de la clase clMensaje Array de la clases


clMensaje

3.2.2 Sub-objeto: clMensajes

Parámetro Descripción Tipo de dato

Numero Número de teléfono del destinatario del mensaje. Debe Cadena de


incluirse el código de país (503 en el caso de El Salvador, caracteres
ej.: 50378870000)

Mensaje El mensaje que se desea enviar por SMS. Cadena de


caracteres
Nota importante: El estándar requiere que cada SMS
tenga un máximo de 160 caracteres. Es posible enviar
mensajes de tamaño mayor pero esto implica que:

• Se generaran varios SMS concatenados para


enviar el mensaje

• Aún cuando es un solo mensaje su costo


dependerá de la cantidad de SMS requeridos para

8
el envío del mismo

Remitente Es el número por el cual enviara el SMS (longitud máxima Cadena de


11 caracteres). Se aceptan remitentes alfanuméricos. Los texto
remitentes alfanuméricos solo son compatibles con la red
TIGO y Claro de El Salvador para otras redes el remitente
alfanumérico es sustituido de manera automática por un
número.

3.2.3 Ejemplo de Solicitud SOAP

<soap:Envelopexmlns:xsi="[Link]
xmlns:xsd="[Link] xmlns:soap="[Link]

<soap:Body>

<enviarBulkSms xmlns="[Link]

<!—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

Una vez invocado el método enviarBulkSms se retornará un objeto de tipo “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

El objeto cuenta con las siguientes propiedades:

Parámetro Descripción Tipo de dato

codigoEstado Código de estado del resultado de la transacción, referirse a Entero de 32bits


la sección 4 para ver los posibles códigos de estado

esEnvioExitoso Si el cliente no desea manejar los distintos estados de Bolean


transacción (codigoEstado) basta utilizar este valor para
determinar si el mensaje se encolo exitosamente

MensajeRespuesta Mensaje descriptivo relacionado con el codigoEstado Cadena de


caracteres

3.3 Método enviarBulkSmsXML


Método utilizado para enviar uno o más SMS a cualquier operadora de Centroamérica a través del
SMS Broadcaster de TIGO.

La lista de mensajes a enviar se especifica en una cadena de caracteres en formato XML.

3.3.1 Parámetros

Parámetro Descripción Tipo de dato

usuario Usuario utilizado para autenticarse en el SMS Broadcaster, Cadena de


este usuario será proporcionado por TIGO. caracteres

contrasena Contraseña utilizada para autenticarse en el SMS Broadcaster, Cadena de


será proporcionado por TIGO. Caracteres

mensajes Contiene una cadena de caracteres en formato XML listando Cadena de


los mensajes a enviar. Estructura del XML requerido: Caracteres

<?xml version="1.0" encoding="UTF-8" ?>

<mensajes>

<clMensajes>

10
<numero>9999999</numero>

<mensaje>test</mensaje>

<remitente>XX</remitente>

</clMensajes>

<clMensajes>

<numero>88888888</numero>

<mensaje>Hola test</mensaje>

<remitente>Mundial</remitente>

</clMensajes>

</mensajes>

3.3.2 Ejemplo de Solicitud SOAP

<soap:Envelopexmlns:xsi="[Link]
xmlns:xsd="[Link] xmlns:soap="[Link]

<soap:Body>

<enviarBulkSmsXML xmlns="[Link]

<!—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

Una vez invocado el método enviarBulkSmsXML se retornará un objeto de tipo


“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

El objeto cuenta con las siguientes propiedades:

Parámetro Descripción Tipo de dato

codigoEstado Código de estado del resultado de la transacción, referirse a Entero de 32bits


la sección 4 para ver los posibles códigos de estado

esEnvioExitoso Si el cliente no desea manejar los distintos estados de Bolean


transacción (codigoEstado) basta utilizar este valor para
determinar si el mensaje se encolo exitosamente

MensajeRespuesta Mensaje descriptivo relacionado con el codigoEstado Cadena de


caracteres

12
3.4 Método: Confirmación SMS
Método para consultar el estado de uno o varios SMS enviados a través del método “enviarSMS”.
Los posibles estados de un SMS son:

• CON= confirmación lectura (mensaje enviados exitosamente, que cuenta con confirmación
de entrega del dispositivo móvil, no todas las operadoras son compatibles con esta
funcionalidad)

• ENV=Enviado (mensaje enviado exitosamente, el envío exitoso se determina por una


confirmación del SMSC no del celular)

• ERR= Entrega fallida

• PEN= Pendiente de enviar, es decir aún esta encolado (normalmente un mensaje no pasa
encolado nunca por más de 10 segundos)

Nota Importante: La confirmación de entrega no es posible en todos los casos debido a


limitantes en algunas operadoras.

El método puede llamarse vía SOAP, HTTP Get o HTTP POST.

3.4.1 Parámetros

Parámetro Descripción Tipo de dato

usuario Usuario utilizado para autenticarse en el SMS Broadcaster, Cadena de


este usuario será proporcionado por TIGO. caracteres

contrasena Contraseña utilizada para autenticarse en el SMS Broadcaster, Cadena de


será proporcionado por TIGO. Caracteres

referencias Lista de referencias divididas por comas para identificar los Cadena de
mensajes SMS para los que se desea consultar su estado. caracteres

La referencia se obtiene de la propiedad “referencia” del objeto


“clRespuesta” retornado por el método “enviarSMS” (ver
sección 3.1.3).

Nota importante: Para lograr que el sistema sea más


eficiente se sugiere consultar más de una referencia a la vez.

13
3.4.2 Objeto de Respuesta: clConfirmacionSMS

Una vez invocado el método “confirmacionSMS” se retornará un objeto de tipo


“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

El objeto cuenta con las siguientes propiedades:

Parámetro Descripción Tipo de dato

codigoEstado Código de estado del resultado de la transacción, referirse a Entero de 32bits


la sección 3.5 para ver los posibles códigos de estado

MensajeRespuesta Mensaje descriptivo relacionado con el codigoEstado Cadena de


caracteres

Lista Arreglo de objetos de tipo clListadoEnvios. El arreglo tiene Arreglo de tipo


un elemento por cada referencia enviada en la propiedad clListadoEnvios
“referencia” del método “confirmacionSMS”.

El arreglo viene vacio si la consulta no fue exitosa según lo


reflejado en la propiedad “codigoEstado”

3.4.3 Sub-objeto de respuesta: clListadoEnvios

Parámetro Descripción Tipo de dato

referencia Referencia única para identificar el mensaje, es la misma Entero 32 bits


referencia retornada en la propiedad del objeto clRespuesta
del método “enviarSMS”

destino Número de teléfono del destinatario a quien fue dirigido el Cadena de


mensaje. caracteres

senderId Identificador del senderID (remitente) que se utilizó para Cadena de


enviar el mensaje. Esto es equivalente al remitente del caracteres
mensaje.

Para el API comúnmente se utilizas el SenderID “genérico”

estado El estado en que se encuentra el mensaje, los posibles Cadena de

14
valores son: caracteres

• CON= confirmación lectura

• ENV=Enviado

• ERR= Entrega fallida

• PEN= Pendiente de enviar, es decir aún encolado

descripcion Descripción relacionada con el estado definido en la Cadena de


propiedad “estado” caracteres

3.5 Método: RespuestaSMS


En algunas ocasiones la plataforma se configura de tal manera que el cliente puede responder a
los mensajes enviados. Este método permite al cliente extraer esas respuestas para procesarlas
como le parezca conveniente.

3.5.1 Parámetros

Parámetro Descripción Tipo de dato

usuario Usuario utilizado para autenticarse en el SMS Broadcaster, Cadena de


este usuario será proporcionado por TIGO. caracteres

contrasena Contraseña utilizada para autenticarse en el SMS Broadcaster, Cadena de


será proporcionado por TIGO. Caracteres

3.5.2 Objeto de Respuesta: clRespuestasSMS

Una vez invocado el método “respuesSMS” se retornará un objeto de tipo “clRespuestasSMS” que
cuenta con las siguientes propiedades:

Parámetro Descripción Tipo de dato

codigoEstado Código de estado del resultado de la transacción, referirse a Entero de 32bits


la sección 3.5 para ver los posibles códigos de estado

MensajeRespuesta Mensaje descriptivo relacionado con el codigoEstado Cadena de


caracteres

Lista Arreglo de objetos de tipo clListaRespuestas. El arreglo Arreglo de tipo


tiene un elemento por cada respuesta extraída. clListaRespuest

15
as
El arreglo viene vació si la consulta no fue exitosa según lo
reflejado en la propiedad “codigoEstado”

Referirse a la siguiente sección para ver el detalle del objeto


clListaRespuestas.

3.5.3 Sub-objeto de respuesta: clListaRespuestas

Parámetro Descripción Tipo de dato

codigo Referencia única para identificar el mensaje respuesta Entero 64 bits

remitente Número de teléfono se utilizó para enviar el mensaje. Cadena de


caracteres

destinatario Número de teléfono que recibió el mensaje de texto. Cadena de


caracteres

mensaje Texto que el remitente envió. Cadena de


caracteres

fechaIngreso Fecha que se registró la respuesta en el sistema Fecha

16
3.6 Método: RespuestaBESMS
En algunas ocasiones la plataforma se configura de tal manera que el cliente puede responder a
los mensajes enviados. Este método permite al cliente extraer esas respuestas para procesarlas
como le parezca conveniente.

3.6.1 Parámetros

Parámetro Descripción Tipo de dato

usuario Usuario utilizado para autenticarse en el SMS Broadcaster, Cadena de


este usuario será proporcionado por TIGO. caracteres

contrasena Contraseña utilizada para autenticarse en el SMS Cadena de


Broadcaster, será proporcionado por TIGO. Caracteres

numeroDestino Remitente que se tiene asignado con la opción de recibir Cadena de


respuestas, será proporcionado por TIGO caracterres

3.6.2 Objeto de Respuesta: clRespuestasSMS

Una vez invocado el método “respuestaBESMS” se retornará un objeto de tipo “clRespuestasSMS”


que cuenta con las siguientes propiedades:

Parámetro Descripción Tipo de dato

codigoEstado Código de estado del resultado de la transacción, referirse a Entero de 32bits


la sección 3.5 para ver los posibles códigos de estado

MensajeRespuesta Mensaje descriptivo relacionado con el codigoEstado Cadena de


caracteres

Lista Arreglo de objetos de tipo clListaRespuestas. El arreglo Arreglo de tipo


tiene un elemento por cada respuesta extraída. clListaRespuest
as
El arreglo viene vació si la consulta no fue exitosa según lo
reflejado en la propiedad “codigoEstado”

Referirse a la siguiente sección para ver el detalle del objeto


clListaRespuestas.

17
3.6.3 Sub-objeto de respuesta: clListaRespuestas

Parámetro Descripción Tipo de dato

codigo Referencia única para identificar el mensaje respuesta Entero 64 bits

remitente Número de teléfono se utilizó para enviar el mensaje. Cadena de


caracteres

destinatario Número de teléfono que recibió el mensaje de texto. Cadena de


caracteres

mensaje Texto que el remitente envió. Cadena de


caracteres

fechaIngreso Fecha que se registró la respuesta en el sistema Fecha

3.7 Códigos de Estado

Código 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

1 Parámetro USUARIO vacío SI SI SI SI Si

2 Parámetro CONTRASENA SI SI SI SI Si
vacío

3 Parámetro NUMERO vacío SI SI SI SI No

4 Formato de NUMERO no valido SI SI SI SI No

5 Parámetro MENSAJE vacío SI SI SI SI No

6 Usuario o contraseña invalida SI SI SI SI Si

7 Usuario está inactivo SI SI SI SI Si

8 API no configurada para la SI SI SI NO No


cuenta del usuario

9 Error al conectarse a la base SI SI SI SI Si


de Datos

18
10 Error no controlado SI SI SI SI Si

11 Parámetro REFERENCIAS NO NO NO SI No
vacio

12 Listado de referencias exitoso NO NO NO SI No

13 Parámetro Remitente vacio SI SI SI NO No

14 Parámetro Remitente pasa los Si Si Si No No


11 caracteres

15 El número de teléfono Si Si Si No No
ingresado no es valido,
recuerde utilizar el formato
[codigoPaís] +
[numeroTelefono], solo son
aceptado teléfonos de El
Salvador. En el caso de
números para El Salvador el
[codigoPaís] es opcional

16 El número Corto de la No No No No Si
Campaña no permite
Respuestas

17 Listado de Respuestas exitoso No No No No Si

18 Arraglo de mensajes vacio No SI SI No No

19 Formato Error XML NO NO Si No No

20 El número no está asignado a No No No No Si


su cuenta.

19
4 Envío y Recepción SMS por Inserción a Base de Datos
Por su facilidad de implementación el SMS Broadcaster permite enviar SMS mediante la inserción
de los mensajes en una tabla de SQL Server. Adicionalmente se provee una vista donde el cliente
puede consultar los mensajes entrantes2 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

• Hacer SELECT a la vista vwBandejaEntrada[nombreCliente]

• Hacer SELECT a la vista vwBandejaSalida[nombreCliente]

4.1 Envío de Mensajes


Para enviar mensajes el cliente tiene que hacer INSERT con los mensajes en la tabla
[Link], al hacer el insert es necesario completar los siguientes campos:

• Usuario: dato enviado con las credenciales de la empresa

• Password: Dato enviado con las credenciales de la empresa

• Celular: celular destino del mensaje

• Remitente: Número de teléfono o nombre del remitente del mensaje3

• Mensaje: Contenido del mensaje. Cada SMS puede contener un máximo de 160
caracteres. El sistema permite enviar mensajes más grandes pero estos se envían 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.

Al insertar el mensaje se puede utilizar el comando @@identity de SQL server para obtener el
código del mensaje y de esta manera consultar su estado posteriormente.

2
Los mensajes entrantes solo están disponibles si el cliente solicito la funcionalidad de recibir respuestas en el SMS
Broadcaster

3
Solo se pueden utilizar remitentes asignados por TIGO

20
4.2 Consulta de Respuestas
Para consultar las respuestas recibidas (mensajes entrantes) basta con hacer una consulta a la
vista: [Link][nombreCliente].

La vista retorna los siguientes campos:

• Codigo: Identificador único del mensaje entrante

• Mensaje: Contenido del mensaje entrante

• numeroDestino: Numero adonde el usuario envió el mensaje (generalmente este es el


mismo número que se utiliza como remitente en el mensaje saliente)

• numeroAutor: Numero del celular desde donde se originó el mensaje

• campana: Es posible que se tenga activo el servicio de envío de campañas desde la


interfaz web del Broadcaster. En ese caso esta consulta extraerá también los mensajes
entrantes generados a partir de los mensajes salientes de las campañas. Este campo
muestra la campaña relacionada al mensaje entrante.

• Accountid: Código de la operadora desde donde se originó el mensaje

• OutgoingId: código del mensaje saliente relacionado con este mensaje entrante

• FechaIngreso: Fecha y hora en que se recibió el mensaje entrante.

4.3 Opcional: Consulta de Estado de envío


Para consultar el envío el cliente debe haber obtenido al momento de insertar el mensaje el código
auto-numérico del mismo por medio del comando @@identity. Para efectos prácticos de este
documento denominaremos dicho código como @codigo.

Para saber el estado del mensaje basta consultar el campo “exitoso” de la vista
[Link][nombreCliente]

. Los posibles valores de este campo son:

• Nulo: El mensaje aún no se ha procesado (esta en cola)

• True: El mensaje fue exitoso

• False: El mensaje fallo.

Un ejemplo de consulta seria:

SELECT exitoso FROM [Link] where


codigo=@codigo

21

También podría gustarte