OBJETIVO REQUERIMIENTOS

Transcripción

1

2 CONTENIDO OBJETIVO 3 REQUERIMIENTOS 3 Conocimientos básicos 3 Darse de alta 3 PANEL DE CONTROL 4 DESCRIPCION 5 INTEGRANDO SUS APLICACIONES 5 Consideraciones generales 5 ENVIO DE SMS 6 Respuesta 7 Respuestas de error 7 CONSULTA DEL ESTADO DE LOS SMS 8 Respuesta 8 CONSULTA DE SALDO 9 Respuesta 9 CONTACTENOS 10 Copyright Marketext Ltd Página 2 de 10

3 OBJETIVO Este manual le permitirá al lector conectar sus aplicaciones informáticas con nuestra plataforma de envío de SMS a través de nuestra solución MasSMS Gateway Conocimientos básicos REQUERIMIENTOS Para una completa comprensión de este manual y una rápida y fácil integración se requieren conocimientos en lenguajes de programación. Darse de Alta Para acceder a nuestro servicio es necesario contar con una cuenta en o, su alta/registro es totalmente gratuita. Si ya posee una cuenta en cualquiera de nuestros sitios Web omita este paso, de lo contrario, siga las instrucciones para crearla: Crear una cuenta: Haga clic en el enlace Registrar. Se cargará una pantalla en la cual deberá escribir los datos para registrarse como cliente, allí usted podrá elegir su Cliente ID, nombre de usuario y contraseña, los cuales usará para conectarse mediante API. Recuerde leer cuidadosamente las indicaciones en pantalla Luego de llenar todos los campos solicitados haga clic en el botón Guardar Copyright Marketext Ltd Página 3 de 10

4 En caso de presentarse alguna inconsistencia se mostrará un mensaje en el dato que contiene el error: Después de corregir los datos o si no se presentó ningún error, se abrirá una ventana donde se le solicitarán los datos de acceso Ingrese a su nueva cuenta y solicite la activación del producto a través del Panel de control, tan pronto como nuestro equipo active el producto, recibirá un indicándole que el producto ha sido activado PANEL DE CONTROL Los datos y clave de acceso del usuario que registre la cuenta y solicite la activación del producto MasSMS Gateway, serán también los datos de acceso y claves Administrativas para el ingreso al Panel de Control de dicho producto. Desde el panel de control podrá crear otros usuarios, solicitar la activación de otros productos, visualizar el reporte de los SMS enviados, el saldo de su cuenta etc. Si solicitó la activación de MasSMS Gateway Plus, podrá también crear, gestionar y realizar un total control de las cuentas de sus clientes El manual del usuario para el manejo del Panel de control lo podrá encontrar al ingresar a su cuenta en formato PDF Copyright Marketext Ltd Página 4 de 10

5 DESCRIPCION HTTP API es el sistema mediante el cual se consigue la comunicación entre los servidores de Marketext o MasSMS y el equipo de cómputo del cliente utilizando el protocolo HTTP ó HTTPS para el envío de SMS individuales o masivos Consideraciones Generales INTEGRANDO SUS APLICACIONES Nuestra API puede recibir solicitudes mediante cualquiera de los dos métodos POST o GET Los números de móvil de destino deben ser pasados en formato internacional y no deben incluir el signo + o cualquier otro código internacional de marcación (ejemplo: 00 o 010), ni ningún otro carácter que no corresponda al número del móvil Se debe suprimir el 0 para realizar envíos a países donde los números de móvil empiecen por este dígito. Por ejemplo, un número de móvil en Reino Unido se debe enviar así: (Recuerde que 44 es el código de país correspondiente a Reino Unido). Puede enviar el mismo SMS a varios móviles, basta con separar cada número de destino con una coma, El parámetro que contiene el texto del SMS deberá ser enviado URL-encoded (los caracteres especiales como & y / son reemplazados por códigos) o de lo contrario, recibirá un error por parte del servidor o el SMS puede salir incompleto El encabezado o remitente del mensaje -senderid- debe contener entre 3 y 11 caracteres máximo. No se permiten espacios, el primer caracter no puede ser el numero 0 (cero), no puede contener letras con acentos ni caracteres de puntuación o especiales como < > i $ * Tampoco se deben incluir caracteres del alfabeto griego Copyright Marketext Ltd Página 5 de 10

6 ENVIOS DE SMS Para enviar SMS a la API usted deberá realizar una solicitud HTTP con el siguiente conjunto de parámetros: Nombre del campo api_id user password Descripción ID de cliente que registró en nuestra plataforma Nombre de usuario que enviará los SMS, recuerde que usted puede tener cuantos usuarios desee Contraseña que utiliza para acceder a su cuenta Número(s) de móvil a los que enviará el SMS, recuerde que cada número debe contener el código internacional de país (ej: , , ) to text Para enviar SMS a varios móviles en un solo pedido debe separar los números de destino con coma,. Puede enviar el SMS a un máximo de 500 móviles en una sola solicitud Texto del SMS que se envía. Recuerde: debe enviar el texto URL-encoded Número de teléfono, nombre de la empresa o persona que envía y que aparecerá como remitente. senderid smstype date_delivery time_delivery Si se deja en blanco se enviará como remitente el valor registrado en el campo user Recuerde: Puede ser alfanumérico máximo 11caracteres Tipo de entrega del SMS: y Envío normal (Valor por defecto) p Envío programado del SMS Fecha para el envío programado, formato aaaa-mm-dd Solo es necesario diligenciar este parámetro si se envía el SMS con tipo p Hora para envío programado, formato 24 horas hh:mm Solo es necesario diligenciar este parámetro si se envía el SMS con tipo p Estos parámetros deberán ser enviados a la siguiente URL: Ejemplo: &password=xxxx&to= , &text=testing%20sms% 20gateway Copyright Marketext Ltd Página 6 de 10

7 Respuesta a los envíos de SMS La API retornará una cadena con la siguiente estructura: movil1:msgid1,movil2:msgid2,movil3:msgid3,movil4:msgid4,etc. Es decir, retornará movil:codigorespuesta por cada móvil que usted haya enviado Móvil: Número de móvil al que envió el SMS MsgID: Código único con el que podrá identificar el SMS en nuestra plataforma para posterior uso, como consultar su status Respuestas de error En caso de existir algún error con su solicitud a continuación describimos los posibles mensajes de error: Código del error Descripción del error 101 No se ha recibido el parámetro API_ID 102 No se ha recibido el parámetro USER 103 No se ha recibido el parámetro PASSWORD 104 No se ha recibido el parámetro TO 105 No se ha recibido el parámetro TEXT 106 Remitente contiene más de 11 caracteres 107 Datos de acceso incorrectos 108 Producto no activo en su cuenta 109 ID de empresa inactivo, por favor contáctenos 110 Sin Saldo de envío 111 El envío supera la cantidad de 100 móviles permitidos Copyright Marketext Ltd Página 7 de 10

8 CONSULTAR EL ESTADO DE LOS SMS Para consultar el estado de los SMS, deberá realizar una solicitud HTTP en la cual envíe el siguiente conjunto de parámetros: api_id user msgid Nombre del campo Descripción ID de cliente que registró en nuestra plataforma Nombre de usuario con el que registró su cuenta ID del SMS Estos parámetros deberán ser enviados a la siguiente URL: Ejemplo: sgid=a9821bcf4500cc12be5423a2be65a7ed Respuesta de consulta de estado de SMS La API retornará una cadena con los siguientes datos. En caso de encontrar correctamente el ID: STATUS:X donde X representa el código de estatus. Ver tabla: Código Estado 0 Enviado a la plataforma 1 Entregado al destinatario 2 Error al contactar el móvil 3 Número de móvil no válido 4 SMS Programado, en espera de ser enviado 5 Número de móvil bloqueado para entregas 6 Saldo insuficiente para envío de SMS 7 Destino no incluido en cobertura En caso de no encontrar el ID se generará el mensaje NOTFOUND Copyright Marketext Ltd Página 8 de 10

9 CONSULTA DE SALDO Para consultar el estado de sus SMS usted deberá realizar una solicitud HTTP en la cual envíe el siguiente conjunto de parámetros: api_id user Nombre del campo Descripción ID de cliente que registró en nuestra plataforma Nombre de usuario con el que registró su cuenta Estos parámetros deberán ser enviados a la siguiente URL: Ejemplo: xx Respuesta a la consulta de saldo La API retornará una cadena con su saldo actual en puntos Copyright Marketext Ltd Página 9 de 10

10 CONTACTENOS Tikets Información Soporte técnico Ventas Copyright Marketext Ltd Página 10 de 10