Especificación Web Services API TWOWAYSMS v1.0. Fecha publicación: 01/02/2008 Intelligent Bussines Communications S.L.

Transcripción

1 Especificación Web Services API TWOWAYSMS v1.0 Fecha publicación: 01/02/2008 Intelligent Bussines Communications S.L.

2 Contenido Introducción...3 Especificación de la erfaz...3 URL de acceso a la erfaz...3 Utilización de la plataforma...3 Autenticación de usuario...3 Operaciones del usuario...4 Clase UserAuth...4 login...4 logout...4 getcredit...4 Operaciones con campañas...5 Clase MessageCampaign...5 getcampaigns...5 addcampaign...5 removecampaign...5 updatecampaign...5 getcampaignname...5 Operaciones con mensajes...6 Clase Message...6 sendmessage...6 getmessages...7 getmessagesstatus...7 Operaciones con conversaciones...8 Clase Conversation...8 getconversations...8 closeconversation...8

3 Introducción Intelligent Bussines Communications ofrece acceso a su plataforma de envío de SMS a través del uso de Web Services facilitando de este modo la egración con las aplicaciones de los clientes. Para poder utilizar la erfaz que se describe a continuación es necesario disponer de una cuenta activa de TwoWaySMS y créditos disponibles para el envío de SMS. Especificación de la erfaz La URL de la especificación WSDL (Web Service Definition Language) es la siguiente: URL de acceso a la erfaz Una vez importada la especificación de los servicios web exportados por TwoWaySMS, para acceder a los diferentes servicios: Utilización de la plataforma Autenticación de usuario Para poder realizar cualquier operación con la plataforma, lo primero que debemos obtener es una instancia de la clase userauth que le devolverá la operación checklogin. Código de ejemplo: public static void main([] args) { try { // Call Web Service Operation com.ibc.smsconecta.server.ws.clientwsservice service = new com.ibc.smsconecta.server.ws.clientwsservice(); com.ibc.smsconecta.server.ws.clientws port = service.getclientwsport(); // TODO initialize WS operation arguments here java.lang. username = username ; java.lang. password = password ; java.lang. accountname = accountname ; // TODO process result here com.ibc.smsconecta.server.ws.userauth result = port.checklogin(username, password, accountname); System.out.prln("Result = " + result); } catch (Exception ex) { // TODO handle custom exceptions here } } Una vez realizada esta operación, la instancia de la clase userauth deberá guardarse puesto que cualquier operación de la erfaz disponible, requiere que se incluya dicha información en la solicitud.

4 Operaciones del usuario Definición de los diferentes servicios de la plataforma. Clase UserAuth Campo account_id accountname accountrealname password realname userid username Tipo login Operación para autenticarse en el sistema. Devuelve el usuario validado en caso de éxito. UserAuth logout Operación para salir del sistema. Devuelve un bolean con el resultado de la operación. userid boolean getcredit Esta operación permite obtener el número de créditos (un crédito equivale a un envío de SMS), así como el estado del esos créditos (1-activos, 0-inactivos) como segundo valor del cadena de enteros que retorna la función. []

5 Operaciones con campañas Una campaña le permite agrupar conversaciones relacionadas con un mismo proyecto. Clase MessageCampaign Campo accountid id Name Tipo getcampaigns Devuelve todas las campañas de un usuario. MessageCampaign[] addcampaign Añade una campaña al sistema y devuelve el identificador de la misma. campaign removecampaign Elimina la campaña indicada. campaign - (void) updatecampaign Modifica el nombre de una campaña existente. oldcampaign newcampaign - (void) getcampaignname Devuelve el nombre de una campaña desde su identificador. i campaign

6 Operaciones con mensajes El mensaje es la unidad de comunicación básica de TwoWaySMS. Se compone de una relación de destinatarios, un título y un cuerpo del mensaje. Si el cuerpo no puede ubicarse en un único mensaje SMS, se dividirá en porciones que se ajusten a dicho tamaño automáticamente para su entrega y de forma transparente al usuario o aplicación que utilice el API. Clase Message Campo body conversation date destinations id messagecampaignid messagecampaignname parentid received rejected statusid title userid userrealname Tipo Conversation Date long[][] Date sendmessage Función para enviar los SMS. Message m messagecampaignname Message La campaña que se le envía debe existir, por lo tanto se tiene que crear con anterioridad mediante la función asignada a tal operación.

7 getmessages Permite recuperar los mensajes recibidos a partir de un id de mensaje. Debe invocar esta operación para recuperar los mensajes informando el id del último mensaje que tenga recuperado en su plataforma. lastmessageid Message[] getmessagesstatus Función para consultar el estado de los mensajes entregados al sistema para ser enviados. Se le debe informar de la cadena de identificadores de los mensajes. La matriz de valores devueltos esta compuesto por el identificador del mensaje con su estado, que puede ser: [] SMSid [][]

8 Operaciones con conversaciones Una conversación permite asociar un mensaje enviado con su respuesta. Clase Conversation Campo accountid expirationdate fromdate id Tipo Date Date getconversations Devuelve todas las conversaciones del usuario, activas y no activas. Conversation[] closeconversation Cierra una conversación. Retorna el resultado de la operación. conversationid boolean