TELECO CHILE S.A. WSDL SOAP de Acceso a Plataforma SMS

WSDL SOAP de Acceso a Plataforma SMS – Versión 1.0

Tabla de Contenidos 1.

CONTROL DE DOCUMENTACIÓN ..........................................................................................................................3

2.

PLATAFORMA TELECO CHILE SMS .....................................................................................................................4

3.

OPERACIÓN DE PLATAFORMA TELECO CHILE MEDIANTE WEBSERVICES SOAP ..............................5 Servicios Soportados .............................................................................................................................................................5 Protocolo ...............................................................................................................................................................................5 Parámetros .............................................................................................................................................................................5

4.

MÉTODOS ......................................................................................................................................................................6 1.1.1 Chequeo de validez de numeración..........................................................................................................................6 1.1.2 Envío de Mensaje .....................................................................................................................................................7 1.1.3 Consulta de estado para mensajes enviados ..........................................................................................................10 1.1.4 Consulta de créditos ..............................................................................................................................................13 1.1.5 Recepción de Mensajes ..........................................................................................................................................16

5. RECEPCIÓN DE EVENTOS DESDE LA PLATAFORMA TELECO CHILE ......... ¡ERROR! MARCADOR NO DEFINIDO. Servicios Soportados ........................................................................................................... ¡Error! Marcador no definido. Protocolo ............................................................................................................................. ¡Error! Marcador no definido. Métodos............................................................................................................................... ¡Error! Marcador no definido. Notificación de recepción de mensaje ............................................................................. ¡Error! Marcador no definido.

Página 2 de 18

1. Control de documentación Histórico de versiones Versión

Fecha

1.0

28 de Mayo de 2015

José Alberto Monje Ruiz.

Control de Instancia Autor: José Antonio Akel. Aprobado por: Firma: Distribución:

EPCS

Francisco Gutierrez

Cargo:

Ing. de Desarrollo

Cargo:

Jefe de Proyecto

Fecha:

2. Plataforma TELECO CHILE SMS La plataforma de SMS TELECO CHILE les permite a nuestros clientes comunicarse mediante la red mundial de mensajería corta soportada por operadores móviles alrededor de todo el mundo. El servicio es operado las 24 horas del día y ofrece tanto los servicios de entrega de mensajes como los de confirmación de recepción.

3. Operación de Plataforma TELECO CHILE Mediante WebServices WebServices SOAP

Servicios Soportados En la presente versión del documento la plataforma ofrece los siguientes servicios a los clientes de TELECO CHILE: 1. Chequeo de validez de numeración 2. Envío de mensajes cortos 3. Consulta de estado para mensajes enviados 4. Rescate de mensajes recibidos

Protocolo La plataforma TELECO CHILE utiliza el protocolo WSDL SOAP, debido a su ubicuidad y simplicidad

Parámetros El servicio se encuentra operativo en el siguiente servidor. http://smpp2.telecochile.cl:4046/?wsdl

4. Métodos 1.1.1 Chequeo de validez de numeración Objetivo: chequear si un número móvil es válido, y obtener el bloque de numeración asignado. Este bloque puede hacer referencia a un operador móvil específico, o a una ruta de entrega. Nombre del método: checkNumber Parámetros: clientId (ASCII string): el nombre de usuario del cliente de TELECO CHILE clientPassword (ASCII string): la contraseña del cliente de TELECO CHILE Número móvil (string) Salida: Texto referente a la compañía o ruta de salida Ejemplo:

XML Request

XML Response

1.1.2 Envío de Mensaje Objetivo: enviar un mensaje corto a la plataforma TELECO CHILE para su entrega al destinatario. Nombre del método: submitMsg Parámetros: clientId (ASCII string): el nombre de usuario del cliente de TELECO CHILE clientPassword (ASCII string): la contraseña del cliente de TELECO CHILE ani (ASCII string): el remitente del mensaje dnis (ASCII string) el destinatario del mensaje msg (UTF-8 string) mensaje de texto Salida: Arreglo asociativo con las siguientes llaves:

“ CODE”: Código de salida. 0 significa “Sin error” “ MESSAGE”: Mensaje de error “ ID”: el ID asignado por la plataforma TELECO CHILE al mensaje recibido Ejemplo:

XML Request

XML Response

Tabla De códigos de salida: ERROR CODE

MESSAGE

0

Message Queued

1

Invalid userId/Password

2

Ani Not Received

3

Invalid ANI: Too long (>13)

4

Invalid DNIS: Not a Number

5

Invalid DNIS: no route available

6

Invalid Message: Too long (>160)

7

Unknown Error

8

Not enough credits

9

You do not have a valid route for this destination

1.1.3 Consulta de estado para mensajes enviados Objetivo: Averiguar el status de entrega de un mensaje. Nombre del método: enquireMsgStatus Parámetros: clientId (ASCII string): el nombre de usuario del cliente de TELECO CHILE clientPassword (ASCII string): la contraseña del cliente de TELECO CHILE msgId (ASCII string) ID del mensaje entregado por TELECO CHILE Salida: Arreglo asociativo con las siguientes llaves: “ CODE”: Código de salida. 0 significa “Sin error” “ MESSAGE”: Mensaje de error “ STATUS”: El estado del mensaje “ DELIVERYDATE” : Fecha y hora de entrega, si es que el mensaje tiene status “DELIVERED”

Ejemplo:

XML Request

XML Response Response

Posibles status de salida para enquireMsgStatus Status

Descripción

UNKNOWN

El método fue llamado con parámetros erróneos

DEFERRED

El mensage no ha podido ser entregado aún

ROUTING

La plataforma se encuentra buscando la ruta óptima para la entrega del mensaje

INCOMMING

Mensaje en la cola activa, listo para su entrega

SENT

El mensaje fue enviado, sin solicitud de confirmación

UNDELIVERED

Se confirmó que el mensaje no pudo ser entregado

CONFIRMED DELIVERY

Se confirmó la entrega del mensaje

WAITING FOR CONFIRMATION

Wl mensaje fue enviado. No se ha recibido la confirmación de su entrega

1.1.4 Consulta de créditos Objetivo: Averiguar la cantidad de créditos disponibles para envío de mensajes Nombre del método: getMyCredits Parámetros: clientId (ASCII string): el nombre de usuario del cliente de TELECO CHILE clientPassword (ASCII string): la contraseña del cliente de TELECO CHILE Salida: Arreglo asociativo con las siguientes llaves: “ CODE”: Código de salida. 0 significa “Sin error” “ MESSAGE”: Mensaje de error “ CREDITS”: La cantidad de créditos disponibles

Ejemplo:

XML Request

XML Response

Codigo

Mensaje

Descripción

-1

Invalid userId/Password

El método fue llamado con parámetros erróneos

0

Success

Se retorna exitósamente el número de créditos

19

Unknown Error

Error en la plataforma

1.1.5 Recepción de Mensajes Objetivo: Obtener los mensajes enviados por usuarios finales al número del abonado Teleco. El método devuelve todos los mensajes recibidos durante los últimos 7 días a el o los números asociados al abonado. Nombre del método: getReceivedMessages Parámetros: clientId (ASCII string): el nombre de usuario del cliente de TELECO CHILE clientPassword (ASCII string): la contraseña del cliente de TELECO CHILE count (integer, opcional): Número máximo de mensajes a recibir minId (integer, opcional): ID de mensaje mínimo a recibir Salida: Arreglo asociativo con las siguientes llaves: “ CODE”: Código de salida. 0 significa “Sin error” “ MESSAGE”: Mensaje de error “ MESSAGES”: Tupla con mensajes. Cada mensaje es, a su vez, un arreglo asociativo con la siguiente estructura:

•

“ id” : Identificador del mensaje recibido

•

“ from”: ANI del mensaje recibido

•

“ to”: DNIS del mensaje recibido. Usualmente corresponde con el número del abonado

•

“ message”: El cuerpo del mensaje, codificado en UTF8

•

“arrived”: Fecha y hora de recepción del mensaje

Ejemplo:

XML Request

XML Response

Posibles codigos y mensajes de salida para getReceivedMessages Codigo

Mensaje

Descripción

1

Invalid userId/Password

El método fue llamado con parámetros erróneos

0

Success

Se retorna exitósamente el número de créditos

19

Unknown Error

Error en la plataforma