Protocolo Web Service Plus Mobile Gateway

Transcripción

1 Protocolo Web Service Plus Mobile Gateway Especificaciones de comunicación Web Service: Nombre: GatewaySoapClient Url: a definir Autenticación: Usuario y contraseña: Plus Mobile deberá proveer a cada cliente un usuario y contraseña para accede a los métodos del web service Host de conexión: El cliente deberá proveer a Plus Mobile el host desde el cual se va a conectar. UrlPost: El cliente deberá proveer a Plus Mobile una url a la cual se le enviará los MO porpost Parámetros de Soap Header para autenticación Parámetro Tipo Descripción User string Nombre del usuario Pass string Contraseña del usuario

2 Métodos para cobrar contenido: dobilling: Realiza un cobro dobillingkeyword: Realiza un cobro con descripción de palabra clave dobilling phonenumber string Número de teléfono a cobrar dobillingkeyword phonenumber string Número de teléfono a cobrar keyword string Palabra clave phonenumber: Número de teléfono a cobrar idbillingcode: Código de cobro, este código lo provee Plus Mobile Valores devueltos por dobilling y dobillingkeyword Tipo Formato Descripción Las funciones devuelven un string con string xml formato xml Ejemplo XML: <Gateway> <Id>1</Id> <Description>Successful.</Description> </Gateway> Descripción de respuesta XML Parámetro Tipo Descripción Id int Código de resultado Description string Descripción del resultado

3 Tabla de Respuestas dobilling y dobillingkeyword Resultado numérico Resultado string Descripción 1 Successful. Contenido cobrado 2000 Insufficient funds. No tiene saldo 2009 Carrier error. Error interno del carrier 2999 No se pudo conectar con la plataforma del carrier 2004 Not premium user. Usuario no habilitado para servicio premium (Si no es ninguno de los anteriores) Content not charged. Contenido no cobrado Ver también la tabla de errores genéricos del web service Método para ver códigos de billing habilitados para el usuario getbillingcodes: Muestra los códigos de billing habilitados para el usuario getbillingcodes - - Devuelve el listado de códigos habilitados para el usuario, especificando el carrier, precio y marcación Valores devueltos por getbillingcodes Tipo Formato Descripción string xml Las funciones devuelven un string con formato xml Ejemplo XML: <BillingCodes> <BillingCode> <idbillingcode>1</idbillingcode> <carrier>ar Personal</carrier> <shortcode>8008</hortcode> <price>1,25</price> </BillingCode> <BillingCode> <idbillingcode>2</idbillingcode> <carrier>co Tigo</carrier> <shortcode>88588</shortcode> <price>400</price> </BillingCode> </BillingCodes>

4 Descripción de respuesta XML Parámetro Tipo Descripción idbillingcode int Código para facturación carrier string Nombre del carrier shortcode string Numeración price double Costo

5 Métodos para envío de SMS: Métodos para envío de SMS: sendmessage: Envía un SMS sendmessagekeyword: Envía un SMS con descripción de palabra clave sendmessageonetoone: Envía un SMS solo si hay un MO sendmessage phonenumber string Número de teléfono a cobrar sendmessagekeyword phonenumber string Número de teléfono a cobrar keyword string Palabra clave sendmessageonetoone MsgRefIdMO int Referencia de mensaje MO phonenumber string Número de teléfono a cobrar phonenumber: Número de teléfono a cobrar idsmscode: Código de envío, este código lo provee Plus Mobile smsmessage: Contenido del SMS keyword: Palabra clave asociada el mensaje MsgRefIdMO: Referencia de mensaje MO Métodos para envío de SMS con cobro Sincrónico: sendmessagesync: Hace un cobro y envía el sms si el contenido fue cobrado sendmessagesynckeyword: Hace un cobro y envía el sms si el contenido fue cobrado, incluye descripción de palabra clave sendmessagesync phonenumber string Número de teléfono a cobrar sendmessagesynckeyword phonenumber string Número de teléfono a cobrar

6 keyword string Palabra clave phonenumber: Número de teléfono a cobrar idsmscode: Código de envío, este código lo provee Plus Mobile smsmessage: Contenido del SMS keyword: Palabra clave asociada el mensaje idbillingcode: Código de cobro, este código lo provee Plus Mobile Métodos para envío de SMS con cobro Asincrónico: sendmessageasync: Hace un cobro y envía el sms independiente del resultado del cobro sendmessageasynckeyword: Hace un cobro y envía el sms independiente del resultado del cobro, incluye descripción de palabra clave sendmessageasync phonenumber string Número de teléfono a cobrar sendmessageasynckeyword phonenumber string Número de teléfono a cobrar keyword string Palabra clave phonenumber: Número de teléfono a cobrar idsmscode: Código de envío, este código lo provee Plus Mobile smsmessage: Contenido del SMS keyword: Palabra clave asociada el mensaje idbillingcode: Código de cobro, este código lo provee Plus Mobile Valores devueltos por sendmessage, sendmessagekeyword, sendmessagesync, sendmessagesynckeyword, sendmessageasync y sendmessageasynckeyword Tipo Formato Descripción

7 string xml Las funciones devuelven un string con formato xml Ejemplo XML: <Gateway> <Id>132246</Id> <Description>Successful.</Description> </Gateway> Tabla de Respuestas sendmessage, sendmessagekeyword, sendmessagesync, sendmessagesynckeyword, sendmessageasync y sendmessageasynckeyword Resultado numérico Resultado string Descripción ( Id único de transacción, Mensaje enviado Successful. puede ser negativo ) 0 Unsuccessful No se pudo enviar el mensaje Ver también la tabla de errores genéricos del web service En el caso de envío de sms con cobro ver también la Tabla de Respuestas dobilling y dobillingkeyword Método para ver códigos sms habilitados para el usuario getsmscodes: Muestra los códigos de sms habilitados para el usuario getsmscodes - - Devuelve el listado de códigos habilitados para el usuario, especificando el carrier, precio y marcación Valores devueltos por getsmscodes Tipo Formato Descripción string xml Las funciones devuelven un string con formato xml Ejemplo XML: <SmsCodes> <SmsCode> <idsmscode>1</idsmscode> <carrier>ar Personal</carrier> <shortcode>8008</hortcode> <price>1,25</price> </SmsCode> <SmsCode> <idsmscode>2</idsmscode> <carrier>co Tigo</carrier> <shortcode>88588</shortcode> <price>400</price> </SmsCode> </SmsCodes> Descripción de respuesta XML

8 Parámetro Tipo Descripción idsmscode int Código que identifica la numeración por la que sale el mensaje carrier string Nombre del carrier shortcode string Numeración por la que sale el mensaje price double Costo URL POST: Los MO se envían a los usuarios por post, ejemplo de parámetros Array ( [MsgRefId] => [PhoneNumber] => [Message] => Mensaje ) Tabla de errores genéricos del web service Resultado int Resultado string Descripción Invalid user, pass or host. Usuario, Clave o Host invalido User without permission. Usuario sin permisos Invalid phone number length. Longitud de teléfono invalida Falta el header de autenticación o no tiene Missing authentication header. todos los parámetros Missing argument smsmessage. Falta el argumento smsmessage Invalid sms message length, max length: 160. Longitud de smsmessage invalida, tamaño máximo: 160