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

Transcripción

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

2 Tabla de Contenidos WSDL SOAP de Acceso a Plataforma SMS Versión CONTROL DE DOCUMENTACIÓN PLATAFORMA TELECO CHILE SMS OPERACIÓN DE PLATAFORMA TELECO CHILE MEDIANTE WEBSERVICES SOAP... 5 Servicios Soportados... 5 Protocolo... 5 Parámetros MÉTODOS Chequeo de validez de numeración Envío de Mensaje Consulta de estado para mensajes enviados Consulta de créditos Recepción de Mensajes 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

3 1. Control de documentación Histórico de versiones Versión Fecha de Mayo de 2015 José Alberto Monje Ruiz. Control de Instancia Autor: José Antonio Akel. EPCS Cargo: Ing. de Desarrollo Aprobado por: Francisco Gutierrez Cargo: Jefe de Proyecto Firma: Fecha: Distribución:

4 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.

5 3. Operación de Plataforma TELECO CHILE Mediante 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.

6 4. Métodos 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

7 XML Response 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:

8 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

9 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

10 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

11 Ejemplo: XML Request XML Response se

12 Posibles status de salida para enquiremsgstatus Status UNKNOWN DEFERRED ROUTING INCOMMING SENT UNDELIVERED CONFIRMED DELIVERY WAITING FOR CONFIRMATION Descripción El método fue llamado con parámetros erróneos El mensage no ha podido ser entregado aún La plataforma se encuentra buscando la ruta óptima para la entrega del mensaje Mensaje en la cola activa, listo para su entrega El mensaje fue enviado, sin solicitud de confirmación Se confirmó que el mensaje no pudo ser entregado Se confirmó la entrega del mensaje Wl mensaje fue enviado. No se ha recibido la confirmación de su entrega

13 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

14 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

15

16 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

17 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

18 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