SERVICIOS WEB JSON v1.0 [02/11/2016] Tabla de contenido

Transcripción

1 Servicios WEB JSON

2 Tabla de contenido Servicios WEB JSON de MasMensajes... 3 Qué es JSON?... 3 Funciones del Web Service JSON de MasMensajes... 4 Envío de Mensajes... 4 Recepción de Respuestas... 6 Recepción de Mensajes por Palabra Clave... 7 Obtener Estatus de Envío... 8 Obtener Estatus de Mensaje... 9 Obtener Estatus de Cuenta Consideraciones técnicas Soporte Técnico

3 Servicios WEB JSON de MasMensajes El servicio MasMensajes puede ser utilizado de manera automática para enviar y recibir mensajes SMS desde cualquier aplicación desarrollada por terceros. Esto se logra a través de servicios web que están puestos a disposición para cualquier usuario registrado en MasMensajes. El uso de los servicios web no tiene costo extra para el cliente y no tiene un límite de uso. A continuación se da una breve explicación de la conectividad entre aplicaciones externas y el sistema MasMensajes. Qué es JSON? JSON (JavaScript Object Notation. Notación de Objetos de JavaScript) es un formato ligero de intercambio de datos. Leerlo y escribirlo es simple para humanos, mientras que para las máquinas es simple interpretarlo y generarlo. Está basado en un subconjunto del Lenguaje de Programación JavaScript, Standard ECMA.262 3rd Edition. Diciembre JSON es un formato de texto que es completamente independiente del lenguaje pero utiliza convenciones que son ampliamente conocidos por los programadores de la familia de lenguajes C, incluyendo C, C++, C#, Java, JavaScript, Perl, Python, y muchos otros. Estas propiedades hacen que JSON sea un lenguaje ideal para el intercambio de datos. JSON está constituido por dos estructuras: Una colección de pares de nombre/valor. En varios lenguajes esto es conocido como un objeto, registro, estructura, diccionario, tabla hash, lista de claves o un arreglo asociativo. Una lista ordenada de valores. En la mayoría de los lenguajes, esto se implementa como arreglos, vectores, listas o secuencias. Estas son estructuras universales; virtualmente todos los lenguajes de programación las soportan de una forma u otra. Es razonable que un formato de intercambio de datos que es independiente del lenguaje de programación se base en estas estructuras. 3

4 Funciones del Web Service JSON de MasMensajes A continuación se muestran las instrucciones de como consumir las diferentes funciones de nuestro servicio web JSON. Envío de Mensajes 2. Su aplicación deberá generar la siguiente estructura en formato JSON: {"user":"usuario",...el nombre de usuario de MasMensajes "password":"contraseña",...contraseña de la cuenta de MasMensajes "service":"1",...el número del servicio a utilizar (1 es envió de mensajes) "data":{...contiene la información que necesita el Web Service "message":"hola +NOMBRE+ GRACIAS POR REGISTRARTE ",...Texto a mandar como mensaje "cellphones":[" "," "],...números de teléfono "lada":"1",...identificador de lada "combination":["david,,,,","omar,,,,"]...campos genéricos para cambiar los mensajes individualmente dirección: {"status":"added",...estado de la petición en caso de error este se presentaría aquí "date":" :57:07",. Fecha en que se registró el envío "total":"'2'",......el número total de mensajes a enviar "totaladd":"2",... El número total de mensajes registrados con éxito "idsender":" ",....número identificador del envío "idmessage":[{..contiene información de cada mensaje en el envío "cellphone":" ",.....número celular al que se envía un mensaje "id":" "}, Número identificador del mensaje {"cellphone":" ", "id":" "} ]} 7. MasMensajes ejecutará el envío a la brevedad. Los mensajes enviados se descontarán del crédito de su cuenta MasMensajes de manera automática. 4

5 El número identificador de lada se puede consultar en la siguiente tabla: ID PAIS 1 México 2 Estados Unidos 3 Colombia 4 Panamá 5 Costa Rica 6 Brasil 7 Perú 8 Paraguay 9 Ecuador 10 Belice 11 Costa Rica 12 Canadá 13 Guatemala 14 Venezuela 15 Argentina 16 República Dominicana 17 Honduras 18 Bolivia 19 Chile 20 Nicaragua NOTA: El servicio de mensajes internacional solo está disponible por web service. 5

6 Recepción de Respuestas 2. Su aplicación deberá generar la siguiente estructura en formato JSON:+ {"user":"usuario",...el nombre de usuario de MasMensajes "password":"contraseña",... Contraseña de la cuenta de MasMensajes "service":"2",...el número del servicio a utilizar (2 es recepción de mensajes) "data":{...contiene la información que necesita el web service "from":" ",...fecha inicio de la búsqueda (opcional) "to":" ",...fecha final de la búsqueda (opcional) "type":"1..tipo de respuesta (1- Todas las respuestas 2- Respuestas no leídas 3- Respuestas leídas) *Nota: si el objeto JSON contiene el campo type devolverá todos los registros de respuestas según su tipo, en este caso los campos from y to son innecesarios, en caso de que se necesite consultar por fechas determinadas omita el campo type y se obtendrá todas las respuestas sin hacer distinción de tipo. dirección: {"estatus":"success",.....estado de la petición en caso de error este se presentaría aquí "Responses":[...Muestra información referente a cada respuesta que cumpla con los parámetros {"idsender":" ",......número identificador de envío "idmessage":" ",...número identificador del mensaje ligado a respuesta "message":"respuesta",..texto contenido en la respuesta "cellphone":" ",.... Número celular que respondió al mensaje "receptiondate":" :29:28",..Fecha en que se registró la respuesta "status":"1"}. Código de estado de respuesta (1-Leído, 0- No leído) ]} Si se utiliza el campo type con la opción 2 ó 3 en la consulta, no parecerá el campo status en la respuesta del servicio. En caso de no encontrar resultados, el sistema responderá de la siguiente manera: {"estatus":"success","responses":[]} 6

7 Recepción de Mensajes por Palabra Clave 2. Su aplicación deberá generar la siguiente estructura en formato JSON: {"user":"usuario",...el nombre de usuario de MasMensajes "password":"contraseña",... Contraseña de la cuenta de MasMensajes "service":"3",...el número del servicio a utilizar (3 es recepción de mensajes por palabra clave) "data":{...contiene la información que necesita el web service "from":" ",...fecha inicio de la búsqueda (opcional) "to":" ",...fecha final de la búsqueda (opcional) "type":"1"...tipo de mensajes (1- Todos los mensajes 2- Mensajes leídos 3- Mensajes no leídos) *Nota: si el objeto JSON contiene el campo type devolverá todos los registros de mensajes según su tipo, en este caso los campos from y to son innecesarios, en caso de que se necesite consultar por fechas determinadas omita el campo type y se obtendrá todos los mensajes sin hacer distinción de tipo. dirección: {"estatus":"success",.....estado de la petición en caso de error este se presentaría aquí "Responses":[....Muestra información referente a cada mensaje que cumpla con los parámetros {"keyword":"pclave",.... Palabra clave utilizada en mensaje "message":" numero de folio EF ",.. Texto contenido en mensaje "cellphone":" ",..número celular que mando el mensaje "receptiondate":" :51:33". Fecha en que se recibió el mensaje "status":"0"}. Código de estado de respuesta (1-Leído, 0- No leído) ]} Si se utiliza el campo type con la opción 2 ó 3 en la consulta, no parecerá el campo status en la respuesta del servicio. En caso de no encontrar resultados, el sistema responderá de la siguiente manera: {"estatus":"success","responses":[]} 7

8 Obtener Estatus de Envío 2. Su aplicación deberá generar la siguiente estructura en formato JSON: {"user":"usuario",...el nombre de usuario de MasMensajes "password":"contraseña",... Contraseña de la cuenta de MasMensajes "service":"4",...el número del servicio a utilizar (4 es obtención de estatus) "data":{...contiene la información que necesita el web service "idsender ":" ". El número identificador del envío dirección: {"estatus":"success",...estado de la petición en caso de error este se presentaría aquí "idssender":{....contienen la información del envío "id":" ", Número identificador del envío que se está consultando "message":" HOLA +NOMBRE+ GRACIAS ",..Texto que contienen los mensajes del envío "send":"2",. Número de mensajes que han sido enviados "Not Send":"0",.....Número de mensajes que no han sido enviados (error) "tosend":"0".. Número de mensajes en espera de enviarse 8

9 Obtener Estatus de Mensaje 2. Su aplicación deberá generar la siguiente estructura en formato JSON: {"user":"usuario",...el nombre de usuario de MasMensajes "password":"contraseña",... Contraseña de la cuenta de MasMensajes "service":"4",...el número del servicio a utilizar (4 es obtención de estatus) "data":{...contiene la información que necesita el web service "idmessage":" ". El número identificador del envío dirección: {"estatus":"success",...estado de la petición en caso de error este se presentaría aquí "idsmessage":{....contienen la información del mensaje "id":" ", Número identificador del mensaje consultado "message":" HOLA David GRACIAS ",...Texto contenido en el mensaje "cellphone":" ",.. Número celular al cual el mensaje fue enviado "status":"s"...código que indica el estado del mensaje(s- Enviado. B- En proceso. U Sin enviar N- Error.) 9

10 Obtener Información de Cuenta 2. Su aplicación deberá generar la siguiente estructura en formato JSON: {"user":"usuario",...el nombre de usuario de MasMensajes "password":"contraseña",... Contraseña de la cuenta de MasMensajes "service":"5",...el número del servicio a utilizar (5 es obtención de información de cuenta) "data":{...contiene la información que necesita el web service "user":" USUARIO". El nombre de usuario de MasMensajes dirección: {"estatus":"success",...estado de la petición en caso de error este se presentaría aquí "username":"usuario", Nombre de usuario registrado en MasMensajes "name":" Gerardo",.....Nombre del usuario de la cuenta "lastname":"nava Fernandez",..... Apellidos del usuario de la cuenta "mail":"gnavafdz@empresa.com, correo electrónico registrado en MasMensajes "credit":" crédito disponible para enviar mensajes } 10

11 Consideraciones técnicas Las adecuaciones de su sistema de información para el funcionamiento con Mas Mensajes deberán ser realizadas por su integrador de TI o un experto en la materia. MasMensajes puede dar soporte en cuanto al desarrollo vía telefónica o por correo electrónico. Soporte Técnico Tecnología y Soluciones Aplicadas S.A. de C.V. Brasilia 107 Col. La Fuente Aguascalientes, Ags. CP Tel. ext. 117, 119 y