SMS FULL IPLAN MANUAL TECNICO DE API

Tamaño: px

Comenzar la demostración a partir de la página:

Download "SMS FULL IPLAN MANUAL TECNICO DE API"

Lorenzo Molina Salas
hace 9 años
Vistas:

1 SMS FULL IPLAN MANUAL TECNICO DE API

2 1. INTRODUCCION Este manual tiene como objetivo explicar técnicamente la integración vía API a SMS FULL IPLAN. 2. DIAGRAMA DEL MODELO object Use Case Model Provisionar Servicio de envio de SMS Prov isionar Servicios «extend» CU1 - Env io de SMS Usuario 3. FLUJO DE EVENTOS Flujo Básico 1: Aprovisionar servicio de envío de SMS identificador CU: 1 El servicio de provisión de envío de SMS brindará toda la Descripción funcionalidad necesaria al cliente, para que el mismo, pueda realizar todo el comportamiento relacionado con esta provisión. Actor Principal Cliente Actor Secundario N/A Precondiciones Ver 2 Flujo Básico Común Flujo Normal Ver 2 Flujo Básico Común Excepciones Ver 2 Flujo Básico Común. Operaciones de Envío de SMS Operación enviosms Descripción Realiza el envío de SMS. Parámetros Parámetro Requerido Default Notas Header order_id X Se utiliza para identificar unívocamente un envío de ejecución (orden). Username X Usuario registrado en la plataforma de provisión. Password X Clave del usuario registrado en la plataforma de provisión. i_date X Fecha de envío de la orden. Provision X Nombre del servicio de provisión. 2

FLUJO DE EVENTOS Flujo Básico 1: Aprovisionar servicio de envío de SMS identificador CU: 1 El servicio de provisión de envío de SMS brindará toda la Descripción funcionalidad necesaria al cliente,

3 Excepción Ejemplo de Request XML Ejemplo de Response XML OK Operation X Nombre de la operación a ejecutar Body destino X Numero telefónico al cual se le desea enviar el mensaje. origen X Número corto desde el cual se desea enviar el SMS. mensaje X Mensaje que se desea enviar (No mayor a 160 caracteres). telco X Empresa a la que pertenece el teléfono destinatario. keyword X Palabra clave utilizada para la generación de reportes. wappush X Se utiliza para identificar si el mensaje es del tipo WAP Push. En caso afirmativo tendrá un valor 1, en caso contrario 0. Asignar los valores requeridos (X), sino ocurre una excepción. El formato del XML Request debe cumplir con la especificación. <order> <header> <order_id>opt-b1a3655b</order_id> <password>[clave]</password> <i_date> :33:47</i_date> <provision> smsgenerico</provision> <operation> enviosmsgenerico </operation> </header> <body> <set> <setid>1</setid> <value> <parameters> <destino> </destino> <origen></origen> <mensaje>mensaje...</mensaje> <telco>ar.simbank</telco> <keyword>proguide</keyword> <wappush>0</wappush> </parameters> </value> </set> </body> <order> <status> <code>0</code> <severity>success</severity> <message>info</message> <o_date> :20:50</o_date> </status> <additionalinfo> <order_id> </order_id> <i_date> :20:00</i_date> <provision> smsgenerico </provision> 3

keyword X Palabra clave utilizada para la generación de reportes. wappush X Se utiliza para identificar si el mensaje es del tipo WAP Push. En caso afirmativo tendrá un valor 1, en caso contrario 0.

4 <operation> enviosmsgenerico </operation> <set> <setid>1</setid> <response> <xml> <estado>1</estado> <mensajedeestado> La operación se ejecuto Correctamente </mensajedeestado> </xml> </response> </set> </additionalinfo> Ejemplo de Response XML con Error Mensajes de Error Enviosms OK enviosms Error <order> <status> <code>1</code> <severity>error</severity> <message>el usuario no tiene permisos de ejecucion</message> <o_date> :25:00</o_date> </status> <additionalinfo> <order_id> </order_id> <i_date> :20:00</i_date> <provision>smsgenerico </provision> <operation>enviosmsgenerico</operation> <set/> </additionalinfo> El usuario no tiene permisos de ejecución. IP de origen no valida. Algunos parámetros son incorrectos o no fueron definidos. Se ha producido un error al ejecutar la operación. El usuario no se encuentra autorizado para el envío por este numero <xml> <estado>1</estado> <mensajedeestado> La operación se ejecuto Correctamente </mensajedeestado> </xml> El Tag estado tiene valor 1 cuando se ejecuto sin error la consulta <xml> <estado>0</estado> <mensajedeestado> Error en el servicio. </mensajedeestado> </xml> El Tag estado tiene valor 0 cuando se ejecuto con error la consulta Especificación de parámetro técnico. 4

permisos de ejecucion</message> <o_date>2007-05-02 10:25:00</o_date> </status> <additionalinfo> <order_id>200705031020</order_id> <i_date>2007-05-02 10:20:00</i_date> <provision>smsgenerico

5 Empresa Movistar Claro Nextel Personal SimBank Desconocido Parámetro telco ar.movistar ar.claro ar.nextel ar.personal ar.simbank Enviar en el tag telco el string vacio es decir: <telco>vacio</telco> Especificación de comunicación por SOAP Protocolo WSDL Entorno Testing Url Entorno Testing WSDL Entorno Producción SOAP Url Entorno Producción Puerto 80 Formato WebService sobre protocolo SOAP Servicio serviciofrontera Operación ejecutar (string xmlorder) Especificación de comunicación por TCP Post En caso de no contar con un cliente SOAP para efectuar la comunicación con el WebService serviciofrontera, se deberá realizar un POST de la siguiente manera: 5

http://wsfrontera.testvariosweb.sondeosglobal.com.ar/service.php?wsdl http://wsfrontera.testvariosweb.sondeosglobal.com.ar/service.php http://wsfrontera.sondeosglobal.com/service.

6 Protocolo TCP Método POST Puerto 80 Url Entorno Testing Url Entorno Producción Modelo de mensaje Versión del XML a utilizar para el envío de SMS <?xml version=\"1.0\" encoding=\"iso \"?> <SOAP-ENV:Envelope xmlns:soap-env=" xmlns:xsd=" xmlns:xsi=" xmlns:tns="urn:serviciofrontera" xmlns:soap=" xmlns:wsdl=" xmlns:soap-enc=" <SOAP-ENV:Body> <mns:ejecutar xmlns:mns="urn:serviciofrontera" SOAP- ENV:encodingStyle=" <xmlorder xsi:type="xsd:string"><order> <header> <order_id>opt-b1a3655b</order_id> <password>[clave]</password> <i_date> :33:47</i_date> <provision> smsgenerico </provision> <operation> enviosmsgenerico </operation> </header> <body> <set> <setid>1</setid> <value> <parameters> <destino> </destino> <origen></origen> <mensaje>mensaje...</mensaje> <telco>ar.simbank</telco> <keyword>proguide</keyword> <wappush>0</wappush> </parameters> </value> </set> </body> </mns:ejecutar> </SOAP-ENV:Body></SOAP-ENV:Envelope> 6

org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/xmlschema" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" xmlns:tns="urn:serviciofrontera" xmlns:soap="http://schemas.xmlsoap.

Documentos relacionados

Especificación Técnica de Protocolo Para el intercambio de información entre Telecom Personal y sus proveedores de servicios

Especificación Técnica de Protocolo Para el intercambio de información entre Telecom Personal y sus proveedores de servicios Página 1 de 26 09/12/2009 Página 2 de 26 09/12/2009 Índice OBJETIVOS... 5 INTRODUCCIÓN...