Servicios web gms v22 2015 05 26

SERVICIOS WEB Documentación para los servicios web de GMS Lista de Servicios Web y parámetros para operar con las funcionalidades que GMS ofrece.

2015

Global Messaging Solutions

26-05-2015 v.22

Global Messaging Solutions | Documentación confidencial. 2

004FDED4

SERVICIOS WEB 2015

Índice

Índice ............................................................................................... 2

Introducción ..................................................................................... 4

Acceso ............................................................................................ 5

Servicios disponibles ....................................................................... 6

prueba ....................................................................................................................................... 6

multienvio07 .............................................................................................................................. 7

envioSms02 ............................................................................................................................. 11

envioSmsCertificado02 ........................................................................................................... 13

envioSmsDirecto02 ................................................................................................................. 15

consultaEstadoSms ................................................................................................................. 17

consultarSaldoSms ................................................................................................................. 19

envioMms ................................................................................................................................ 20

envioVoz .................................................................................................................................. 22

consultaHLR ............................................................................................................................ 24

crearConsultaHLRMasiva ....................................................................................................... 26

estadoConsultaHLRMasiva ..................................................................................................... 27

descargarConsultaHLRMasiva ................................................................................................ 28

crearContacto .......................................................................................................................... 29

modificarContacto ................................................................................................................... 30

borrarContacto......................................................................................................................... 31

crearFiltro ................................................................................................................................ 32

comprobarFiltro ....................................................................................................................... 33

actualizarFiltro ......................................................................................................................... 34

borrarFiltro ............................................................................................................................... 35

contenidoFiltro ......................................................................................................................... 36

listarFiltros ............................................................................................................................... 37

descargarInforme .................................................................................................................... 38


004FDED4

SERVICIOS WEB 2015

descargarInformeCertificado ................................................................................................... 39

consultaMensaje...................................................................................................................... 40

descargarRestringidos ............................................................................................................ 42

Anexo 1 ......................................................................................... 43

Comunicación de estado a través de CallBack ....................................................................... 43

Anexo 2 ......................................................................................... 44

Formato del parámetro "expiracion" ........................................................................................ 44

Ejemplos .................................................................................................................................. 44

Control de cambios ........................................................................ 45


004FDED4

SERVICIOS WEB 2015

Introducción

Los servicios web permiten el acceso automatizado a gran parte de las funcionalidades del sistema de GMS. Las funciones pueden agruparse por categorías: para el envío de mensajes, para gestionar las listas subidas al sistema y para consultar el estado de mensajes previamente enviados. GMS ofrece diferentes funciones para el envío de mensajes. Teniendo en cuenta las características específicas de cada una de ellas, el cliente puede elegir las que mejor se adapten a sus necesidades.

multienvio07: Es una función muy versátil, que permite el envío de fax, email y SMS a

destinatarios puntuales, a listas previamente subidas al sistema y/o a una lista indicada en la propia petición, permitiendo adjuntar archivos y programar la hora de inicio del envío. Si se utilizan listas, es posible personalizar el contenido de los emails y SMS, de forma que cada destinatario reciba una información diferente. Se puede utilizar también para crear plantillas y borradores.

envioSms02: Es una función especializada en el envío de SMS. Pueden indicarse uno o más

destinatarios y es posible programar la hora de inicio del envío. No se pueden utilizar listas ni personalizar el contenido del mensaje.

envioSmsDirecto02: Es una función especializada en el envío de SMS, indicada para envíos en

los que el tiempo de entrega del mensajes es crítico. El envío siempre se realiza de manera inmediata. Sólo puede indicarse un destinatario y el contenido del mensaje no se puede personalizar. El estado de estos mensajes puede consultarse utilizando el servicio web

“consultaEstadoSms”

envioMms: Es una función especializada en el envío de mensajes MMS. Pueden indicarse uno o más destinatarios y es posible programar la hora de inicio del envío. No se pueden utilizar listas ni personalizar el contenido del mensaje.

envioVoz: Es una función especializada en el envío de mensajes de voz. Pueden realizarse

envíos a listas subidas al sistema y/o a una lista indicada en la propia petición. También permite programar la hora de inicio del envío.


004FDED4

SERVICIOS WEB 2015

Acceso

Para acceder a los servicios web no es necesaria autenticación HTTP. El acceso se realiza utilizando SOAP. La URL a la que hay que conectarse depende de la función que se vaya a utilizar. Para las funciones ‘envioSmsDirecto02’, ‘consultaEstadoSms’, ‘consultaHLR’, ‘crearConsultaHLRMasiva’, 'estadoConsultaHLRMasiva', 'descargarConsultaHLRMasiva' y 'consultarSaldoSms': https://clientes.gms.es/webservice/servidorSms.php Para el resto de funciones: https://clientes.gms.es/webservice/servidor.php Es posible descargar el WSDL accediendo a https://clientes.gms.es/webservice/servidorSms.php?wsdl o https://clientes.gms.es/webservice/servidor.php?wsdl


004FDED4

SERVICIOS WEB 2015

Servicios disponibles

prueba Se puede utilizar para pruebas de conexión. Devuelve los dos parámetros pasados Parámetros:

'parámetro 1' tipo ‘int’

'parámetro 2' tipo ‘string’

Valor devuelto:

‘resultado’ (tipo ‘string’) Devuelve como texto los dos parámetros pasados


004FDED4

SERVICIOS WEB 2015

multienvio07

Se utiliza para realizar envíos de fax, email y/o SMS. También permite guardar plantillas y borradores que pueden ser utilizados posteriormente. Si se utiliza para partir de una plantilla o borrador, los parámetros indicados en la petición de envío tienen preferencia sobre los guardados en la plantilla. Notas: El parámetro ‘listaLocal’ no es guardado al crear una plantilla o borrador. Para envíos internacionales de fax y SMS es necesario que el número incluya el prefijo internacional (+prefijoPais o 00prefijoPais). Para envíos a España no es necesario, pero puede incluirse

Parámetros: Todos los parámetros son obligatorios. El parámetro ‘listaLocal’ es de tipo ‘base64Binary’ Los demás son de tipo ‘string’ Los parámetros en verde no pueden ir vacíos. Los parámetros en negro pueden ir vacíos (con valor ‘’). En cada uno aparece el valor por defecto. 'login' el usuario

‘password' la contraseña codificada en MD5

‘tipoProgramacion' el tipo de programación del envío. Debe ser uno de estos tres valores: “1” envío inmediato: el envío se realiza inmediatamente “2” envío nocturno: el envío queda programado hasta el horario nocturno “3” envío programado: el envío queda programado según los siguientes parámetros. El valor por defecto es “1”

'dia' El día del envío en formato DD. Sólo se utiliza si ‘tipoProgramacion' es “3”

'mes' El mes del envío en formato MM. Sólo se utiliza si ‘tipoProgramacion' es “3”

'ano' El año del envío en formato AAAA. Sólo se utiliza si ‘tipoProgramacion' es “3”

'hora' La hora del envío en formato hh:mm. Sólo se utiliza si ‘tipoProgramacion' es “3”

'departamento' el código de facturación. Por defecto es "" Si se utiliza, la factura aparecerá desglosada por departamento. Se puede utilizar en búsquedas desde la web

'referencia' La referencia del envío. Por defecto es "" . Se puede utilizar en búsquedas desde la web

'nombreListas' Nombre de la lista o filtro a la que realizar el envío. Puede haber varios,

separándolos por comas.

'listaLocal' Contiene una base de datos de destinatarios a los que también se enviará la

información. El formato debe ser csv delimitado por punto y coma. Debe tener una primera

línea con los nombres de los campos y los valores no deber ir entre comillas. Para envíos de

email, debe existir la columna “email”, para envíos de fax, debe existir la columna “fax”, para

envíos de SMS, debe existir la columna “sms”. Puede incluir columnas adicionales para

permitir la personalización.


004FDED4

SERVICIOS WEB 2015

'destinatarioPuntual' Destino adicional que recibirá el envío. Pueden añadirse varios separándolos por punto y coma

'enviarFax' Indica si es un envío de fax. Puede ser “0” o “1”

'enviarEmail' Indica si es un envío de email. Puede ser “0” o “1”

'enviarSms' Indica si es un envío de SMS. Puede ser “0” o “1”

'remitenteEmail' Indica la dirección del remitente que aparecerá en los correos. Puede

añadirse el nombre a mostrar con el siguiente formato: “Nombre a mostrar <[email protected]>" El valor por defecto es el asociado a la cuenta

‘emailResponderA’ Indica la dirección que aparecerá al responder a los correos. Puede

añadirse el nombre a mostrar con el siguiente formato: “Nombre a mostrar <[email protected]>" El valor por defecto es el asociado a la cuenta

'remitenteSms' Es el remitente que aparecerá en el SMS. Tiene un máximo de 11 caracteres.

Sólo permite los caracteres a-z A-Z y 0-9. No se pueden usar espacios, guiones, etc El valor por defecto es el asociado a la cuenta

'asunto' Indica el asunto del email. Para fax y SMS no se utiliza, pero se puede utilizar en búsquedas desde la web

'textoSms' El texto del SMS. No debe superar los 160 caracteres. Si se supera ese límite, el

mensaje se partirá en varios envíos diferentes

'textoEmail' El texto del email. Puede ser texto plano o código HTML

'textoFax' El texto del fax ‘adjuntos’ Adjuntos para el envío de email. En los envíos de fax, se convertirán y enviarán

después del “textoFax” (si existe). Los formatos de archivo permitidos para los envíos de fax son: Word, Excel, PDF y texto plano. Para envíos de SMS no debe utilizarse. Este parámetro es un elemento de tipo ‘adjuntos’ ‘adjuntos’ está formado por al menos un elemento ‘adjunto’ que, a su vez, está compuesto de tres elementos: • ‘nombre’: el nombre del archivo. • ‘contentId’: Reservado para uso futuro. Debe ser “”. • ‘contentData’: el contenido del archivo codificado en base64.

‘certificado’ Indica si se solicita la certificación del envío (sólo para email y SMS). Puede ser “0” o “1”. El valor por defecto es 0

‘certificadoA’ si el parámetro ‘certificado’ es 1, permite indicar una o más direcciones de email adicionales a las que enviar el certificado. Si el parámetro ‘certificado’ es 0, el informe del envío se remitirá también a las direcciones indicadas. Para indicar varias direcciones, deben ir separadas por coma o punto y coma. Nota: el certificado y el informe siempre se envían a la(s) dirección(es) configurada(s) en la cuenta. Por defecto es ‘’

‘expiracion’ Permite indicar la fecha máxima de entrega. Sólo aplica a envíos de SMS. Consultar el formato del parámetro en el Anexo 2. Por defecto es ‘’


004FDED4

SERVICIOS WEB 2015

‘idPlantilla’ Si se desea utilizar una plantilla o borrador indica el identificador del mismo. Por defecto es ‘’ (no utilizar plantilla)

‘guardarPlantilla’ Permite indicar que la petición debe guardarse como una plantilla o borrador. Puede tener los siguientes valores: o ‘’ - No se desea crear una plantilla. Es el valor por defecto. o ‘1’ - Debe guardarse como una plantilla o ‘2’ - Debe guardarse como un borrador

‘nombrePlantilla’ Si se está guardando una plantilla o borrador, permite asignarle un nombre. Por defecto es ‘’

Valor devuelto:

Se devuelven tres valores:

‘resultado’ (tipo ‘string’) Contiene el código de resultado. Será 50000 si la petición se ha procesado de forma correcta.

‘descripcion’ (tipo ‘string’) Contiene la descripción del código de resultado

‘refWeb’ (tipo ‘string’) Si la petición de envío se ha procesado con éxito, contiene la referencia asociada al mismo. Si en la petición se ha indicado que debe guardarse como una plantilla o borrador, contiene el identificador del mismo.

Códigos de resultado devueltos: 50000: Envío realizado correctamente - Ref Web: XXXXX 50000: Plantilla guardada correctamente 50001: En el fichero local de lista falta una columna con la cabecera EMAIL, FAX o SMS 50004: La selección de listas no tiene ningún destino 50006: No hay destinatarios 50007: No hay ninguna lista o filtro llamado [lista] 50008: No ha seleccionado el tipo del envío 50009: Error, debe escribir un texto o adjuntar un fichero para realizar el envío 50010: Error al generar los parámetros de envío 50011: Error al generar la BBDD 50012: Error al generar la BBDD 50013: Error al generar la BBDD 50014: Error al generar el texto del email 50015: Error al generar el texto del SMS 50016: Error al generar el texto del fax 50025: Error procesando el archivo local de lista 50027: La fecha indicada no es válida 50028: La hora indicada no es válida 50029: Faltan parámetros 50030: Sólo puede haber un destino SMS 50031: El usuario no es válido 50032: Sólo puede haber destinos SMS 50033: Error conectando a bdd 50034: El destino ‘destino’ no está permitido 50035: Error comprobando destino 50036: No hay suficientes créditos 50037: Error comprobando créditos 50038: No hay destinos SMS válidos 50039: El parametro 'login' es obligatorio. 50040: El parametro 'pass' es obligatorio. 50041: El parametro 'login' contiene caracteres no permitidos 50042: El parametro 'pass' contiene caracteres no permitidos 50043: El parametro 'adjuntos' no es correcto 50044: El parametro 'adjuntos' no es correcto


004FDED4

SERVICIOS WEB 2015

50045: Error procesando adjunto 50130: La fecha de expiración no es válida 50131: La fecha de finalización no es válida 50140: El parametro guardarPlantilla tiene un valor incorrecto 50142: La plantilla solicitada no existe 50143: La plantilla solicitada no existe 50145: Error guardando plantilla 50___: Error interno


004FDED4

SERVICIOS WEB 2015

envioSms02

Se utiliza para realizar envíos de SMS Para envíos internacionales de SMS es necesario que el número incluya el prefijo internacional (+prefijoPais o 00prefijoPais). Para envíos a España no es necesario, pero puede incluirse Todos los parámetros son obligatorios y tienen que aparecer en la petición Los parámetros en verde no pueden ir vacíos. Los parámetros en negro pueden ir vacíos (con valor ‘’). En cada uno aparece el valor por defecto. Parámetros: Todos los parámetros son de tipo ‘string’ 'login' el usuario






'hora' La hora del envío en formato hh. Sólo se utiliza si ‘tipoProgramacion' es “3”

‘minuto’ El minuto del envío en formato mm. Sólo se utiliza si ‘tipoProgramacion' es “3”

'departamento' el código de facturación. Por defecto es "" Si se usa, la factura aparecerá desglosada por departamento. Se puede utilizar en búsquedas desde la web

'referencia' La referencia del envío. Por defecto es "". Se puede utilizar en búsquedas desde la web

'asunto' Para SMS no se utiliza, pero se puede utilizar en búsquedas desde la web

'remitenteSms' Es el remitente que aparecerá en el SMS. Tiene un máximo de 11 caracteres.


'texto' El texto del SMS. No debe superar los 160 caracteres. Si se supera ese límite, el mensaje se partirá en varios envíos diferentes

'destino' El destino que recibirá en envío. Pueden añadirse varios separándolos por punto y coma

‘expiracion’ Permite indicar la fecha máxima de entrega. Consultar el formato del parámetro en el Anexo 2. Por defecto es ‘’


004FDED4

SERVICIOS WEB 2015

Valor devuelto:


‘resultado’ (tipo ‘string’) Contiene el código de resultado. Será 50000 si el envío se ha realizado de forma correcta.


‘refWeb’ (tipo ‘string’) Si el envío se ha realizado con éxito, contiene la referencia asociada al mismo. En caso contrario será ‘’

Códigos de resultado devueltos: 50000: Envío realizado correctamente - Ref Web: XXXXX 50001: En el fichero local de lista falta una columna con la cabecera EMAIL, FAX o SMS 50004: La selección de listas no tiene ningún destino 50006: No hay destinatarios 50007: No hay ninguna lista o filtro llamado [lista] 50008: No ha seleccionado el tipo del envío 50009: Error, debe escribir un texto o adjuntar un fichero para realizar el envío 50010: Error al generar los parámetros de envío 50011: Error al generar la BBDD 50012: Error al generar la BBDD 50013: Error al generar la BBDD 50014: Error al generar el texto del email 50015: Error al generar el texto del SMS 50016: Error al generar el texto del fax 50025: Error procesando el archivo local de lista 50027: La fecha indicada no es válida 50028: La hora indicada no es válida 50029: Faltan parámetros 50030: Sólo puede haber un destino SMS 50031: El usuario no es válido 50032: Sólo puede haber destinos SMS 50033: Error conectando a bdd 50034: El destino ‘destino’ no está permitido 50035: Error comprobando destino 50036: No hay suficientes créditos 50037: Error comprobando créditos 50038: No hay destinos SMS válidos 50039: El parametro 'login' es obligatorio. 50040: El parametro 'pass' es obligatorio. 50041: El parametro 'login' contiene caracteres no permitidos 50042: El parametro 'pass' contiene caracteres no permitidos 50043: El parametro 'adjuntos' no es correcto 50044: El parametro 'adjuntos' no es correcto 50130: La fecha de expiración no es válida 50131: La fecha de finalización no es válida 50___: Error interno


004FDED4

SERVICIOS WEB 2015

envioSmsCertificado02

Se utiliza para realizar envíos de SMS certificados Para envíos internacionales de SMS es necesario que el número incluya el prefijo internacional (+prefijoPais o 00prefijoPais). Para envíos a España no es necesario, pero puede incluirse Todos los parámetros son obligatorios y tienen que aparecer en la petición Los parámetros en verde no pueden ir vacíos. Los parámetros en negro pueden ir vacíos (con valor ‘’). En cada uno aparece el valor por defecto. Parámetros: Todos los parámetros son de tipo ‘string’ 'login' el usuario









'referencia' La referencia del envío. Por defecto es "". Se puede utilizar en búsquedas desde la web

'asunto' Para SMS no se utiliza, pero se puede utilizar en búsquedas desde la web

'remitente' Es el remitente que aparecerá en el SMS. Tiene un máximo de 11 caracteres.


'texto' El texto del SMS. No debe superar los 160 caracteres. Si se supera ese límite, el mensaje se partirá en varios envíos diferentes


‘certificadoA’ Permite indicar una dirección de email adicional a la que enviar el certificado. El certificado siempre se envía a la dirección configurada en la cuenta. Por defecto es ‘’


004FDED4

SERVICIOS WEB 2015


Valor devuelto:





Códigos de resultado devueltos: 50000: Envío realizado correctamente - Ref Web: XXXXX 50001: En el fichero local de lista falta una columna con la cabecera EMAIL, FAX o SMS 50004: La selección de listas no tiene ningún destino 50006: No hay destinatarios 50007: No hay ninguna lista o filtro llamado [lista] 50008: No ha seleccionado el tipo del envío 50009: Error, debe escribir un texto o adjuntar un fichero para realizar el envío 50010: Error al generar los parámetros de envío 50011: Error al generar la BBDD 50012: Error al generar la BBDD 50013: Error al generar la BBDD 50014: Error al generar el texto del email 50015: Error al generar el texto del SMS 50016: Error al generar el texto del fax 50025: Error procesando el archivo local de lista 50027: La fecha indicada no es válida 50028: La hora indicada no es válida 50029: Faltan parámetros 50030: Sólo puede haber un destino SMS 50031: El usuario no es válido 50032: Sólo puede haber destinos SMS 50033: Error conectando a bdd 50034: El destino ‘destino’ no está permitido 50035: Error comprobando destino 50036: No hay suficientes créditos 50037: Error comprobando créditos 50038: No hay destinos SMS válidos 50039: El parametro 'login' es obligatorio. 50040: El parametro 'pass' es obligatorio. 50041: El parametro 'login' contiene caracteres no permitidos 50042: El parametro 'pass' contiene caracteres no permitidos 50043: El parametro 'adjuntos' no es correcto 50044: El parametro 'adjuntos' no es correcto 50130: La fecha de expiración no es válida 50131: La fecha de finalización no es válida 50___: Error interno


004FDED4

SERVICIOS WEB 2015

envioSmsDirecto02 Se utiliza para realizar envíos de SMS Para envíos internacionales es necesario que el número incluya el prefijo del país. Opcionalmente se puede incluir el prefijo internacional (+prefijoPais o 00prefijoPais). Para envíos a España no es necesario, pero puede incluirse Todos los parámetros son obligatorios y tienen que aparecer en la petición Los parámetros en verde no pueden ir vacíos. Los parámetros en negro pueden ir vacíos (con valor ‘’). En cada uno aparece el valor por defecto. Parámetros: Todos los parámetros son de tipo ‘string’ 'login' el usuario


‘idCuenta ' Este parámetro no es operativo y debe ser ‘’

'departamento' el código de facturación. Por defecto es "". Si se usa, la factura aparecerá desglosada por departamento.

'referencia' La referencia del envío. Por defecto es "".

'destinatario' El destino que recibirá en envío. Sólo puede incluirse un único destinatario 'remitente' Es el remitente que aparecerá en el SMS. Tiene un máximo de 11 caracteres.

Sólo permite los caracteres a-z A-Z y 0-9. No se pueden usar espacios, guiones, etc.

'charset' Indica el juego de caracteres en el que está codificado el campo ‘texto’. Por defecto es "ISO-8859-15".

Los valores permitidos son:

- "ISO-8859-15"

- "ISO-8859-1"

- "UTF-8"

Para enviar caracteres no incluidos en el modo estándar de SMS (acentos, caracteres griegos, cirílicos, etc…) puede incluirse el prefijo “UCS” a cualquiera de las

codificaciones (por ejemplo “UCS UTF-8”) Al usar la codificación UTF-8 también es posible indicar el prefijo “AUTO” (“AUTO UTF-8”)

para indicar que sólo se debe usar UCS si en el texto se incluye algún carácter no ISO

'texto' El texto del mensaje. Si excede los 160 caracteres se enviaran tantos mensajes

concatenados como sea necesario. 'solicitarDR' Indica si se solicita la confirmación de entrega al terminal. Puede ser 1 (se

solicita), 0 (no se solicita) o 17 (se solicita también la notificación de entrega a la operadora). Por defecto es 0



004FDED4

SERVICIOS WEB 2015

Valor devuelto:


‘resultado’ (tipo ‘string’) Contiene el código de resultado. Será 62000 si el mensaje se ha procesado de forma correcta.



Códigos de resultado devueltos: 62000: Envío realizado correctamente - Ref Web: XXXXX 62001: El número de parámetros no es correcto 62002: El parámetro 'login' es obligatorio 62003: El parámetro 'password' es obligatorio 62004: El parámetro 'login' contiene caracteres no permitidos 62005: El parámetro 'password' contiene caracteres no permitidos 62006: El usuario no es válido 62007: El usuario no tiene permiso para utilizar este servicio web 62008: Error en la configuración del perfil 62009: Error en la configuración del perfil 62101: El remitente no está permitido 62102: El remitente no está permitido 62104: El destino no está permitido 62106: No tiene créditos 62110: El parámetro 'destino' es obligatorio 62111: El charset especificado no es valido 62112: Error interno 62130: La fecha de expiración no es válida 62150: El destino esta restringido 62___: Error interno


004FDED4

SERVICIOS WEB 2015

consultaEstadoSms Se utiliza para consultar el estado de un envío de SMS realizado mediante la función ‘envioSmsDirecto’ Todos los parámetros son obligatorios y tienen que aparecer en la petición Los parámetros en verde no pueden ir vacíos. Los parámetros en negro pueden ir vacíos (con valor ‘’). En cada uno aparece el valor por defecto. Parámetros: Todos los parámetros son de tipo ‘string’ 'login' el usuario


‘idCuenta ' Este parámetro no es operativo y debe ser ‘’

' referenciaSms' Referencia devuelta por la función ‘envioSmsDirecto’ Valor devuelto:


‘resultado’ (tipo ‘string’) Contiene el código de resultado. Será 65000 si la consulta se ha realizado con éxito.


‘estado’ (tipo ‘string’) Si la consulta se ha realizado con éxito, contiene los datos correspondientes al envío separados por punto y coma. En caso contrario será ''.

Los datos devueltos son: "referenciaSms;estadoDelMensaje;numeroDeMensajes;fechaFinalización;códigoDeResultado".

Los posibles valores de "estadoDelMensaje" son:

"Pendiente": El mensaje está todavía en la cola de envío. No aparecerán los datos "fechaFinalización" ni "códigoDeResultado"

"Enviado": El mensaje se ha entregado al operador pero todavía no hemos recibido el resultado de la entrega al terminal.

"Entregado": El mensaje se ha entregado al terminal. "Rechazado": El mensaje no se ha entregado al terminal. En "códigoDeResultado"

aparecerá el motivo. "Expirado": El mensaje no se ha podido entregar al terminal en el tiempo de

reintento y ha expirado. La fecha de finalización tiene el formato "AAAA-MM-DD hh:mm:ss" Para obtener la lista actualizada de valores del código de resultado, por favor contactar con GMS.

Códigos de resultado devueltos: 65000: Datos devueltos 65001: El número de parámetros no es correcto 65002: El parámetro 'login' es obligatorio


004FDED4

SERVICIOS WEB 2015

65003: El parámetro 'password' es obligatorio 65004: El parámetro 'login' contiene caracteres no permitidos 65005: El parámetro 'password' contiene caracteres no permitidos 65006: El usuario no es válido 65007: El usuario no tiene permiso para utilizar este servicio web 65008: Error en la configuración del perfil 65009: Error en la configuración del perfil 65102: La referencia no existe 65___: Error interno


004FDED4

SERVICIOS WEB 2015

consultarSaldoSms Se utiliza para consultar el saldo disponible para envíos de SMS y consultas HLR. Todos los parámetros son obligatorios y tienen que aparecer en la petición

Parámetros: Todos los parámetros son de tipo ‘string’ 'login' el usuario


Valor devuelto:


‘resultado’ (tipo ‘string’) Contiene el código de resultado. Será 69000 si la consulta se ha realizado con éxito.


‘saldo’ (tipo ‘string’) Contiene el saldo disponible, con cuatro decimales.

Códigos de resultado devueltos: 69000: Ok 69001: El número de parámetros no es correcto 69002: El parámetro 'login' es obligatorio 69003: El parámetro 'password' es obligatorio 69004: El parámetro 'login' contiene caracteres no permitidos 69005: El parámetro 'password' contiene caracteres no permitidos 69006: El usuario no es válido 69007: El usuario no tiene permiso para utilizar este servicio web 69100: Error en la configuración del perfil 69101: Error en la configuración del perfil 69205: No es prepago 69___: Error interno


004FDED4

SERVICIOS WEB 2015

envioMms

Se utiliza para realizar envíos de MMS

Parámetros: Todos los parámetros son obligatorios y excepto ‘contenido’ son de tipo ‘string’ Los parámetros en verde no pueden ir vacíos. Los parámetros en negro pueden ir vacíos (con valor ‘’). En cada uno aparece el valor por defecto.

'login' el usuario









'referencia' La referencia del envío. Por defecto es "" . Se puede utilizar en búsquedas desde la web

'asunto' Para mms no se utiliza, pero se puede utilizar en búsquedas desde la web

'remitente' Es el remitente que aparecerá en el mms. Tiene un máximo de 11 caracteres.


'contenido’ El contenido del mms. Este parámetro es un elemento de tipo ‘ContenidoMMS’ ‘ContenidoMMS’ está formado por al menos un elemento “ParteMMS” que, a su vez, está compuesto de tres elementos: • ’contentType’: indica el tipo del contenido (RFC 2046). • ‘contentId’: se puede utilizar para enlazar los contenidos con un elemento de presentaciones (smil). • ’contentData’: contiene el contenido multimedia codificado en base64.


004FDED4

SERVICIOS WEB 2015

El número máximo de elementos “ParteMMS” dentro del elemento “ContenidoMMS” depende del tamaño total del MMS, que está limitado a un valor en KB (consultar con GMS)


Valor devuelto:

La función devuelve un código de resultado seguido de una descripción. Si la solicitud se ha procesado correctamente, devuelve el código 50000 seguido del texto "Envío realizado correctamente - Ref Web: xxxxxxxxxxxxxxx". La referencia que devuelve es única y puede usarse para búsquedas en la web o para reportar cualquier problema. En caso contrario, se especifica el error. Códigos de resultado devueltos: 50000: Envío realizado correctamente - Ref Web: XXXXX 50001: En el fichero local de lista falta una columna con la cabecera EMAIL, FAX o SMS 50002: Error interno 50003: Error interno 50004: La selección de listas no tiene ningún destino 50006: No hay destinatarios 50007: No hay ninguna lista o filtro llamado [lista] 50008: No ha seleccionado el tipo del envío 50009: Error, debe escribir un texto o adjuntar un fichero para realizar el envío 50010: Error al generar los parámetros de envío 50011: Error al generar la BBDD 50012: Error al generar la BBDD 50013: Error al generar la BBDD 50014: Error al generar el texto del email 50015: Error al generar el texto del sms 50016: Error al generar el texto del fax 50017: Error interno 50018: Error interno 50019: Error interno 50020: Error interno 50022: Error interno 50023: Error interno 50024: Error interno 50025: Error procesando el archivo local de lista 50026: Error interno


004FDED4

SERVICIOS WEB 2015

envioVoz Se utiliza para realizar envíos de voz Todos los parámetros son obligatorios y tienen que aparecer en la petición Los parámetros en verde no pueden ir vacíos. Los parámetros en negro pueden ir vacíos (con valor ‘’). En cada uno aparece el valor por defecto. Parámetros: Todos los parámetros son de tipo ‘string’ 'login' el usuario


'departamento' el código de facturación. Por defecto es "". Si se usa, la factura aparecerá desglosada por departamento.

'referencia' La referencia del envío. Por defecto es "". ‘estructura’ Nombre de la estructura a utilizar ‘certificado ' Este parámetro no es operativo y debe ser ‘’

‘tipoProgramacion’ El tipo de programación del envío. Debe ser uno de estos dos valores: “1” envío inmediato: el envío comienza inmediatamente “2” envío programado: el envío queda programado según el siguiente parámetro. El valor por defecto es “1”

‘fechaInicio' Fecha y hora de inicio del envío. El formato es ’dd/mm/YYYY hh:mm:ss’ Sólo se

utiliza si ‘tipoProgramacion' es “2”

‘fechaFin' Fecha y hora de finalización del envío. Si el envío no hubiese finalizado cuando

llegue ese momento, el resto del envío se cancelará. El formato es ’dd/mm/YYYY hh:mm:ss’ Por defecto se deja que el envío finalice.

‘horaInicio' Inicio del rango horario en el que se realizarán las llamadas. El formato es ’hh:mm’ Por defecto es ’00:00’

‘horaFin' Fin del rango horario en el que se realizarán las llamadas. El formato es ’hh:mm’ Por defecto es ’23:59’ Una vez alcanzada esa hora, las llamadas se detienen hasta el día siguiente a la hora indicada en el parámetro ‘horaInicio’

‘diasEnvio' Un string de 7 caracteres indicando los días de la semana en que se pueden realizar las llamadas. La primera posición corresponde al lunes y la última al domingo. El valor ‘1’ en una posición habilita el envío ese día. Un ‘0’ deshabilita el envío ese dia. El valor por defecto es ‘1111111’ (enviar todos los días)

‘maxLlamadas' El número máximo de llamadas que se realizarán cada cinco minutos. El número de llamadas realizadas puede ser menor que el indicado, pero nunca mayor.

'nombreListas' Nombre de la lista o filtro a la que realizar el envío. Puede haber varios,

separándolos por comas.


004FDED4

SERVICIOS WEB 2015

'listaLocal' Contiene una base de datos de destinatarios a los que también se enviará la

información. El formato debe ser csv delimitado por punto y coma. Debe tener una primera

línea con los nombres de los campos y los valores no deber ir entre comillas. Debe existir la

columna “fax”, que contiene el número de teléfono. Puede incluir columnas adicionales para

permitir la personalización.

Valor devuelto:





Códigos de resultado devueltos: 63000000: Envío realizado correctamente - Ref Web: XXXXX 63000001: El número de parámetros no es correcto 63000002: El parámetro 'login' es obligatorio 63000003: El parámetro 'password' es obligatorio 63000004: El parámetro 'login' contiene caracteres no permitidos 63000005: El parámetro 'password' contiene caracteres no permitidos 63000006: El usuario no es válido 63000007: El usuario no tiene permiso para utilizar este servicio web 63000008: El parámetro 'tipoProgramacion' tiene un valor no valido 63000009: Error procesando lista local 63300101: El usuario no es valido 63300401: La estructura no existe 63301601: El parámetro 'tipoProgramacion' tiene un valor no valido 632XXXXX: Error interno


004FDED4

SERVICIOS WEB 2015

consultaHLR Se utiliza para consultar el HLR de un número móvil Para números internacionales es necesario que el número incluya el prefijo del país. Opcionalmente se puede incluir el indicador de prefijo internacional (+prefijoPais o 00prefijoPais). Para números de España no es necesario, pero puede incluirse Todos los parámetros son obligatorios y tienen que aparecer en la petición

Parámetros: Todos los parámetros son de tipo ‘string’ 'login' el usuario


'numero' El número a consultar. Sólo puede incluirse un único número Valor devuelto:

Se devuelven cuatro valores:



‘refWeb’ (tipo ‘string’) Contiene la referencia asociada a la consulta. Si la petición no se ha procesado, puede ser ‘’

‘idGms’ (tipo ‘string’) Si la petición se ha procesado correctamente, contiene el identificador de operador. En caso contrario será ‘’. Para una lista actualizada de operadores, consultar a GMS.

Códigos de resultado devueltos: 64000: Solicitud correcta - Ref Web: XXXXX 64001: El número de parámetros no es correcto 64002: El parámetro 'login' es obligatorio 64003: El parámetro 'password' es obligatorio 64004: El parámetro 'login' contiene caracteres no permitidos 64005: El parámetro 'password' contiene caracteres no permitidos 64006: El usuario no es válido 64007: El usuario no tiene permiso para utilizar este servicio web 64008: Error en la configuración del perfil 64009: Error en la configuración del perfil 64206: El destino no está permitido 64208: No tiene créditos 64212: Timeout 64217: Numero erroneo 64218: Destino no permitido 64219: Timeout consultando HLR 64220: Error consultando HLR 64231: Not delivered - unknown reason 64232: Unknown subscriber 64233: Absent subscriber 64234: Call barred 64235: HLR abort 64236: Cancelled


004FDED4

SERVICIOS WEB 2015

64237: No existe / No valido 64___: Error interno


004FDED4

SERVICIOS WEB 2015

crearConsultaHLRMasiva Se utiliza para crear una consulta de HLR de una lista de números Para números internacionales es necesario que el número incluya el prefijo del país. Opcionalmente se puede incluir el indicador de prefijo internacional (+prefijoPais o 00prefijoPais). Para números de España no es necesario, pero puede incluirse Todos los parámetros son obligatorios y tienen que aparecer en la petición

Parámetros: El parámetro ‘lista’ es de tipo ‘base64Binary’ Los demás son de tipo ‘string’ 'login' el usuario.

‘password' la contraseña codificada en MD5.

'lista' La lista de números a consultar. Sólo puede tener una columna con los números a consultar separados por saltos de línea. Debe incluir la cabecera ‘numero’ en la primera línea.

Valor devuelto:




‘refWeb’ (tipo ‘string’) Contiene la referencia asociada a la consulta. Si la petición no se ha procesado, puede ser ‘’

Códigos de resultado devueltos: 68000: Operacion creada 68001: El número de parámetros no es correcto 68002: El parámetro 'login' es obligatorio 68003: El parámetro 'password' es obligatorio 68004: El parámetro 'login' contiene caracteres no permitidos 68005: El parámetro 'password' contiene caracteres no permitidos 68006: El usuario no es válido 68007: El usuario no tiene permiso para utilizar este servicio web 68020: El parametro 'lista' es obligatorio 68021: Error procesando lista 68101: Error creando la consulta 68112: La cabecera no es válida 68115: No hay registros 68___: Error interno


004FDED4

SERVICIOS WEB 2015

estadoConsultaHLRMasiva Se utiliza para obtener el estado de una consulta de HLR masiva. Todos los parámetros son obligatorios y tienen que aparecer en la petición

Parámetros: Todos los parámetros son de tipo ‘string’ 'login' el usuario.


' refWeb' Referencia devuelta por la función ‘crearConsultaHLRMasiva’. Valor devuelto:




‘estado’ (tipo ‘string’) Indica el estado de la consulta. Puede ser uno de estos valores: o Creando o Pausado o Procesando o Finalizado o En error o Desconocido

Códigos de resultado devueltos: 66000: Ok 66001: El número de parámetros no es correcto 66002: El parámetro 'login' es obligatorio 66003: El parámetro 'password' es obligatorio 66004: El parámetro 'login' contiene caracteres no permitidos 66005: El parámetro 'password' contiene caracteres no permitidos 66006: El usuario no es válido 66007: El usuario no tiene permiso para utilizar este servicio web 66020: El parametro 'refWeb' es obligatorio 66101: Consulta no encontrada 66___: Error interno


004FDED4

SERVICIOS WEB 2015

descargarConsultaHLRMasiva Se utiliza para descargar el resultado de una consulta de HLR masiva. Sólo puede descargarse el resultado de consultas finalizadas. Todos los parámetros son obligatorios y tienen que aparecer en la petición

Parámetros: Todos los parámetros son de tipo ‘string’ 'login' el usuario.


' refWeb' Referencia devuelta por la función ‘crearConsultaHLRMasiva’. Valor devuelto:




‘datos’ (tipo ‘base64Binary’) Contiene el resultado de la consulta. Es un archivo CSV con los campos separados por punto y coma. Incluye una primera línea de cabecera.

Códigos de resultado devueltos: 67000: Ok 67001: El número de parámetros no es correcto 67002: El parámetro 'login' es obligatorio 67003: El parámetro 'password' es obligatorio 67004: El parámetro 'login' contiene caracteres no permitidos 67005: El parámetro 'password' contiene caracteres no permitidos 67006: El usuario no es válido 67007: El usuario no tiene permiso para utilizar este servicio web 67020: El parametro 'refWeb' es obligatorio 67101: Consulta no encontrada 67104: La consulta no ha finalizado 67201: Error procesando la descarga 67___: Error interno


004FDED4

SERVICIOS WEB 2015

crearContacto Se utiliza para realizar altas de contactos en listas en el sistema

Parámetros: Todos los parámetros son obligatorios y, excepto ‘campos’, son de tipo ‘string’

'login' el usuario


‘nombre_lista’ el nombre de la lista en la que incluir el contacto

'campos’ El contenido del contacto. Este parámetro es un elemento de tipo ‘campos’ ‘campos’ está formado por al menos un elemento ‘campo’ que, a su vez, está compuesto de dos elementos: • ‘columna’: el nombre de la columna • ’valor’: el valor definido para esa columna. Deben existir al menos las siguientes columnas: ‘nombre’, ‘fax’, ‘email’ y ‘sms’ Deben incluirse los demás campos de la tabla. Se puede poner el valor “” para dejarlo en blanco.

Valor devuelto:

‘resultado’ (tipo ‘string’) Si se ha creado el contacto se devuelve el código 51000 seguido del identificador del contacto. En caso de error se devuelve el código de error seguido de la explicación. Consultar documentación sobre errores.

Códigos de resultado devueltos: 51000: ok 51001: Imposible insertar contacto 51002: No existe la lista 51003: Imposible insertar el contacto en la lista 51004: Imposible actualizar los datos adicionales del contacto 51005: No tiene permisos para crear contactos 51006: Introduzca los campos obligatorios: id, fax, email y sms


004FDED4

SERVICIOS WEB 2015

modificarContacto Se utiliza para realizar modificaciones de contactos en el sistema

Parámetros: Todos los parámetros son obligatorios y, excepto ‘campos’, son de tipo ‘string’

'login' el usuario


‘id_contacto’ el identificador del contacto

'campos’ El contenido del contacto. Este parámetro es un elemento de tipo ‘campos’ ‘campos’ está formado por al menos un elemento ‘campo’ que, a su vez, está compuesto de dos elementos: • ‘columna’: el nombre de la columna • ’valor’: el valor definido para esa columna. Deben incluirse todos los campos de la tabla. Se puede poner el valor “” para dejarlo en blanco.

Valor devuelto:

‘resultado’ (tipo ‘string’) Si el contacto se ha modificado correctamente devuelve el código 52000. En caso de error se devuelve el código de error seguido de la explicación. Consultar documentación sobre errores.

Códigos de resultado devueltos: 52000: Contacto modificado con éxito 52001: Imposible actualizar los datos adicionales del contacto 52002: Introduzca los campos obligatorios: id, fax, email y sms 52003: No tiene permisos para modificar contactos 52004: Imposible actualizar el contacto 52005: No se ha podido recuperar el identificador de la lista 52006: No se ha podido recuperar los datos de la lista 52007: El identificador del contacto es obligatorio


004FDED4

SERVICIOS WEB 2015

borrarContacto Se utiliza para realizar bajas de contactos en el sistema

Parámetros: Todos los parámetros son obligatorios y son de tipo ‘string’

'login' el usuario


‘id_contacto’ el identificador del contacto

Valor devuelto:

‘resultado’ (tipo ‘string’) Si el contacto se ha eliminado correctamente devuelve el código 53000. En caso de error se devuelve el código de error seguido de la explicación. Consultar documentación sobre errores.

Códigos de resultado devueltos: 53000: Contacto eliminado con éxito 53001: No tiene permisos para modificar contactos 53002: Imposible eliminar el contacto 53003: El identificador del contacto es obligatorio


004FDED4

SERVICIOS WEB 2015

crearFiltro Se utiliza para crear un filtro sobre una lista mediante una serie de condiciones. Parámetros:

Todos los parámetros son obligatorios y de tipo ‘string’

’login’ el usuario ‘password’ la contraseña codificada en MD5 ‘nombreFiltro’ Nombre del nuevo filtro. No puede ser igual al nombre de otro filtro o lista

existente.

‘textofiltro’ Definición del filtro. Consultar la sintaxis en la documentación correspondiente

‘nombreLista’ Nombre de la lista sobre la que se aplica el filtro

Valor devuelto:

‘resultado’ (tipo ‘string’) Si el filtro se crea correctamente, contiene el código 57000. En caso de error contiene el código de error seguido de la explicación. Consultar documentación sobre errores

Códigos de resultado devueltos: 57000: Filtro creado 57001: el parámetro 'login' es obligatorio 57002: el parámetro 'pass' es obligatorio 57003: el parámetro 'nombreLista' es obligatorio 57004: el parámetro 'textoFiltro' es obligatorio 57005: No tiene permisos para solicitar datos 57006: el parámetro 'nombreFiltro' es obligatorio 57007: Error Interno 57008: Descripcion del error 57009: Error Interno 57010: La lista no existe 57101: Debe asignar un nombre al filtro 57102: El filtro está vacío 57103: Error procesando el filtro, por favor compruebe que es correcto 57104: Ya existe una lista con ese nombre 57105: Ya existe un filtro con ese nombre 57106: Error creando el filtro


004FDED4

SERVICIOS WEB 2015

comprobarFiltro Se utiliza para comprobar su un filtro es correcto. Parámetros:


’login’ el usuario ‘password’ la contraseña codificada en MD5

‘nombreLista’ Nombre de la lista sobre la que se aplica el filtro

‘textoFiltro’ Definición del filtro. Consultar la sintaxis en la documentación correspondiente Valor devuelto:

‘resultado’ (tipo ‘string’) Si el filtro es correcto contiene el código 56000. En caso de error contiene el código de error seguido de la explicación. Consultar documentación sobre errores

Códigos de resultado devueltos: 56000: ok 56001: el parámetro 'login' es obligatorio 56002: el parámetro 'pass' es obligatorio 56003: el parámetro 'nombreLista' es obligatorio 56004: el parámetro 'textoFiltro' es obligatorio 56005: No tiene permisos para solicitar datos 56006: Error Interno 56007: Error Interno


004FDED4

SERVICIOS WEB 2015

actualizarFiltro Se utiliza para modificar un filtro existente. Parámetros:


’login’ el usuario ‘password’ la contraseña codificada en MD5 ‘nombreFiltro’ Nombre del filtro a modificar.

‘textofiltro’ Definición del filtro. Consultar la sintaxis en la documentación correspondiente

‘nombreLista’ Nombre de la lista sobre la que se aplica el filtro. Valor devuelto:

‘resultado’ (tipo ‘string’) Si el filtro se ha actualizado correctamente contiene el código 58000. En caso de error contiene el código de error seguido de la explicación. Consultar documentación sobre errores

Códigos de resultado devueltos: 58000: Filtro modificado 58001: el parámetro 'login' es obligatorio 58002: el parámetro 'pass' es obligatorio 58003: el parámetro 'nombreLista' es obligatorio 58004: el parámetro 'textoFiltro' es obligatorio 58005: No tiene permisos para solicitar datos 58006: el parámetro 'nombreFiltro' es obligatorio 58007: Error Interno 58008: Descripcion del error 58009: La lista no existe 58101: Debe asignar un nombre al filtro 58102: El filtro está vacío 58103: Error procesando el filtro, por favor compruebe que es correcto 58104: Error interno 58105: Ya existe una lista con ese nombre 58106: El filtro no existe 58107: Error interno 58108: Error interno 58109: Error creando el filtro


004FDED4

SERVICIOS WEB 2015

borrarFiltro Se utiliza para eliminar un filtro. Parámetros:


’login’ el usuario ‘password’ la contraseña codificada en MD5 ‘nombreFiltro’ Nombre del filtro a eliminar

Valor devuelto:

‘resultado’ (tipo ‘string’) Si el filtro se ha eliminado contiene el código 59000. En caso de error contiene el código de error seguido de la explicación. Consultar documentación sobre errores

Códigos de resultado devueltos: 59000: Filtro eliminado 59001: el parámetro 'login' es obligatorio 59002: el parámetro 'pass' es obligatorio 59003: el parámetro 'nombreFiltro' es obligatorio 59004: No tiene permisos para solicitar datos 59005: Error Interno 59101: Error Interno 59102: Debe indicar el nombre del filtro 59103: Error Interno 59104: Error borrando el filtro


004FDED4

SERVICIOS WEB 2015

contenidoFiltro Se utiliza para recuperar la definición de un filtro. Parámetros:


’login’ el usuario ‘password’ la contraseña codificada en MD5 ‘nombreFiltro’ Nombre del filtro

Valor devuelto:

‘resultado’ (tipo ‘string’) Si el filtro es correcto contiene el código 60000 seguido de la definición del filtro. En caso de error contiene el código de error seguido de la explicación. Consultar documentación sobre errores

Códigos de resultado devueltos: 60000: ok 60001: el parámetro 'login' es obligatorio 60002: el parámetro 'pass' es obligatorio 60003: el parámetro 'nombreFiltro' es obligatorio 60004: No tiene permisos para solicitar datos 60005: Error Interno 60006: El filtro no existe


004FDED4

SERVICIOS WEB 2015

listarFiltros Se utiliza para listar los filtros existentes. Parámetros:


’login’ el usuario ‘password’ la contraseña codificada en MD5

Valor devuelto:

‘resultado’ (tipo ‘string’) Si el filtro es correcto devuelve el código 61000 seguido de los nombres de los filtros separados por punto y coma “;”. En caso de error contiene el código de error seguido de la explicación. Consultar documentación sobre errores

Códigos de resultado devueltos: 61000: ok 61001: el parámetro 'login' es obligatorio 61002: el parámetro 'pass' es obligatorio 61003: No tiene permisos para solicitar datos 61004: Error Interno


004FDED4

SERVICIOS WEB 2015

descargarInforme Se utiliza para descargar informes de estado y trazas. Esta función puede tardar en devolver los datos, por lo debe llamarse con un time-out de al menos 120 segundos

Parámetros: Todos los parámetros son obligatorios y son de tipo ‘string’

'login' el usuario


‘referencia’ la referencia del informe a descargar. Puede ser la referencia Gms o la referencia Web.

‘tipoInforme’ El tipo de informe solicitado. Debe ser uno de estos valores: • ‘final’: Informe de resultado del envío • ‘trazas’: Informe de trazas del envío (aperturas, clicks y bajas)

Valores devueltos: Se devuelven tres valores:

‘resultado’ (tipo ‘string’) Si el informe se ha descargado correctamente contiene el código 54000. En caso de error contiene el código de error seguido de la explicación. Consultar documentación sobre errores.

‘resumen’ (tipo ‘base64Binary’) Contiene datos estadísticos del envío en formato CSV.

‘detalle’ (tipo ‘base64Binary’) Contiene el detalle del envío en formato CSV.

Códigos de resultado devueltos: 54000: ok 54001: error interno 54002: error interno 54003: error interno 54004: error interno 54005: error recuperando el informe 54006: error interno 54007: error recuperando el informe 54008: error interno 54009: error interno 54010: el parámetro 'login' es obligatorio. 54010: el parámetro 'password' es obligatorio. 54010: el parámetro 'referencia' es obligatorio. 54010: el parámetro 'tipoInforme' es obligatorio. 54011: El parámetro 'login' contiene caracteres no permitidos 54011: El parámetro 'password' contiene caracteres no permitidos 54011: El parámetro 'referencia' contiene caracteres no permitidos 54011: El parámetro 'tipoInforme' contiene caracteres no permitidos 54012: No tiene permisos para descargar informes. 54013: El tipo de informe solicitado no es valido 54014: Error interno 54015: Error interno

54016: Error interno


004FDED4

SERVICIOS WEB 2015

descargarInformeCertificado Se utiliza para descargar informes de envíos certificados. Parámetros: Todos los parámetros son obligatorios y son de tipo ‘string’

'login' el usuario


‘referencia’ la referencia del informe a descargar. Puede ser la referencia Gms o la referencia Web.

Valores devueltos: Se devuelven cuatro valores:

‘resultado’ (tipo ‘string’) Si el informe se ha descargado correctamente contiene el código 62000. En caso de error contiene el código de error seguido de la explicación. Consultar documentación sobre errores.

‘resumen’ (tipo ‘base64Binary’) Contiene el resumen del envío.

‘certificado’ (tipo ‘base64Binary’) Contiene el PDF certificado.

‘adjuntos’ (tipo ‘base64Binary’) Para envíos de email, contiene el detalle del mensaje enviado y del resultado en formato RAR. Para otros tipos de envío estará vacío.

Códigos de resultado devueltos: 62000: ok 62002: Informe no encontrado 62004: Configuracion erronea 62005: Error recuperando el informe 62006: Configuracion erronea 62007: Error recuperando el informe 62008: Envio no encontrado 62009: Error accediendo a los datos 62010: El parámetro 'login' es obligatorio. 62010: El parámetro 'password' es obligatorio. 62010: El parámetro 'referencia' es obligatorio. 62011: El parámetro 'login' contiene caracteres no permitidos 62011: El parámetro 'password' contiene caracteres no permitidos 62011: El parámetro 'referencia' contiene caracteres no permitidos 62012: No tiene permisos para descargar informes certificados. 62013: No se han encontrado datos 62___: Error interno


004FDED4

SERVICIOS WEB 2015

consultaMensaje Se utiliza para consultar los envíos de fax, email y/o SMS. No puede utilizarse para consultar envíos de voz Esta función puede tardar en devolver los datos, por lo debe llamarse con un time-out de al menos 180 segundos Parámetros: Todos los parámetros son obligatorios y de tipo ‘string’ Los parámetros en verde no pueden ir vacíos. Los parámetros en negro pueden ir vacíos (con valor ‘’). En cada uno aparece el valor por defecto. ’login’ el usuario ‘password’ la contraseña codificada en MD5

Los siguientes parámetros sirven para filtrar el resultado de la consulta de mensaje.

‘ref_gms’ Referencia de Gms

‘ref_web’ Referencia Web

‘ref_cliente’ Referencia del Cliente

‘Dpto’ Departamento

‘fec_ini’ Fecha de inicio (formato dd/mm/aaaa)

‘fec_fin’ Fecha de fin (formato dd/mm/aaaa)

Si sólo se utiliza ‘fec_ini’ se busca en ese día Si se utilizan ‘fec_ini’ y ‘fec_fin’ se busca entre las dos fechas. Si sólo se utiliza ‘fec_fin’ se busca desde el día 1 del mes de ‘fec_fin’ hasta ‘fec_fin’. Si no se utiliza ninguna de las dos fechas se busca en el mes en curso. Valores devueltos: Se devuelven dos valores:

‘resultado’ (tipo ‘string’) Si se devuelven datos, contiene el código 55000. En caso de error contiene el código de error seguido de la explicación. Consultar documentación sobre errores

‘datos’ (tipo ‘base64Binary’) contiene el resultado de la consulta en formato csv.

Ejemplo: “Fecha Entrada;Fecha Salida;Ref.Cliente;Nombre de la lista;Asunto;Estado;Ref.Web;Ref.GMS;Usuario;Dpto;Entregados;Destinos;Nombr

e Doc\r\n10/11-8:45;10/11-

08:45;TEST;destino;;CONFIRMADO;xxxxxxxxxxxxx;Mxxxxxxxx;;TEST;0;1;Test.pdf\

r\n19/11-19:41;19/11-19:42;Prueba;destino;prueba de envio;CANCELADO;

xxxxxxxxxxxxx; Mxxxxxxxx;;Dpt. prueba;0;1;prueba.pdf\r\n20/12-11:16;20/12-

12:17;otra prueba;destino;;CONFIRMADO; xxxxxxxxxxxxx; Mxxxxxxxx;;;0;1;\r\n”

Códigos de resultado devueltos: 55001: No tiene permisos para solicitar datos 55002: el parámetro 'login' es obligatorio 55003: el parámetro 'pass' es obligatorio 55004: El parámetro 'login' contiene caracteres no permitidos 55005: El parámetro 'pass' contiene caracteres no permitidos" 55006: No hay resultados


004FDED4

SERVICIOS WEB 2015

55007: El parámetro ref_gms contiene caracteres no permitidos 55008: El parámetro ref_web contiene caracteres no permitidos 55009: El parámetro ref_cliente contiene caracteres no permitidos 55010: El parámetro Dpto contiene caracteres no permitidos 55011: El parámetro fec_ini contiene caracteres no permitidos 55012: El parámetro fec_fin contiene caracteres no permitidos 55013: El parámetro fec_ini no tiene formato correcto. dd/mm/aaaa 55014: El parámetro fec_fin no tiene formato correcto. dd/mm/aaaa 55015: La fecha final no es válida 55016: La fecha inicial no es válida


004FDED4

SERVICIOS WEB 2015

descargarRestringidos Se utiliza para consultar los números restringidos de fax, email o SMS Esta función puede tardar en devolver los datos, por lo debe llamarse con un time-out de al menos 180 segundos Parámetros:


’login’ el usuario ‘password’ la contraseña codificada en MD5 ‘tipo’ Tipo de restringidos solicitado. Debe ser uno de estos valores “fax”, “email” o “sms”

Valores devueltos: Se devuelven dos valores:

‘resultado’ (tipo ‘string’) Si se devuelven datos, contiene el código 61000. En caso de error contiene el código de error seguido de la explicación. Consultar documentación sobre errores

‘datos’ (tipo ‘base64Binary’) contiene los destinos restringidos en formato csv Códigos de resultado devueltos: 61000: ok 61001: El tipo de restringido solicitado no es valido 61002: Error Interno 61003: Error Interno 61004: Error Interno 61005: Error Interno 61006: Error Interno 61007: error recuperando el informe 61007: error interno 61008: error interno 61009: error recuperando el informe 61010: error interno 61011: el parámetro 'login' es obligatorio 61012: el parámetro 'password' es obligatorio 61013: el parámetro 'tipo' es obligatorio 61014: El parámetro 'login' contiene caracteres no permitidos 61015: El parámetro 'password' contiene caracteres no permitidos 61016: El parámetro 'tipo' contiene caracteres no permitidos 61017: No tiene permisos para descargar restringidos


004FDED4

SERVICIOS WEB 2015

Anexo 1

Comunicación de estado a través de CallBack Es posible configurar la cuenta de usuario para que el sistema ejecute una llamada (callBack) al servidor web del cliente cuando se reciba la notificación de resultado del envío SMS por parte del operador. Si el cliente lo solicita, también se ejecutará cuando el mensaje sea entregado al operador. La llamada se realizará mediante una petición GET a la URL configurada, pasando los parámetros necesarios para identificar el envío y notificar el resultado del mismo. Los parámetros enviados son los siguientes:

type El tipo de notificación. Los valores posibles son: o 1 – Entregado. o 2 – No entregado. o 4 – Entregado al operador.

id referencia devuelta por el sistema al realizar el envío mediante envioSmsDirecto.

submitdate Fecha y hora de envío del mensaje (en formato Unix TimeStamp)

donedate Fecha y hora de la notificación (en formato Unix TimeStamp)

status Código de resultado.

errorcode Código de resultado.

txtstatus Texto correspondiente al resultado. Puede tener los siguientes valores: o DELIVRD – Mensaje entregado. o UNDELIV – Mensaje no entregado. o EXPIRED – Mensaje expirado (no entregado). o UNKNOWN – Estado desconocido. o ACCEPTD – Mensaje entregado al operador.

errortext No usado. Siempre está vacío.

msgparts Número de partes para mensajes largos.

receiver Número de destino.

sender Remitente del mensaje.

customerReference Contiene la referencia indicada por el cliente al realizar el envío.

department Contiene el departamento indicado por el cliente al realizar el envío. Notas: En el campo "status" aparecerá el mismo valor que en "errorcode". Los valores posibles de “errorcode“ son los mismos que se devuelven en la función “consultaEstadoSms”. Para un listado actualizado de los posibles valores, por favor contactar con GMS.


004FDED4

SERVICIOS WEB 2015

Anexo 2

Formato del parámetro "expiracion" El parámetro "expiracion" permite limitar el tiempo durante el cual se intenta entregar el SMS. Una vez transcurrido ese tiempo, el SMS expira y no se entrega al terminal. Puede indicarse un tiempo relativo (por ejemplo intentar durante las próximas 2 horas) o un tiempo absoluto (intentar hasta las 11:00 del día 10/03/2015). En ambos casos es posible indicar el tiempo en formato “fecha-hora” o en formato timestamp Unix (más información en http://es.wikipedia.org/wiki/Tiempo_Unix) Formato fecha-hora Tiempo absoluto: Se indica la fecha y hora a la que el mensaje expirará (hora española). AAAA-MM-DD hh:mm:ss

Tiempo relativo: Se indican los días, horas, minutos y segundos que deben transcurrir antes de que el mensaje expire. El año y el mes deben tener el valor cero. 0000-00-DD hh:mm:ss Formato timestamp Unix Tiempo absoluto: Se indica usando la letra “u” seguida de la fecha y hora, en formato timestamp Unix, en el que el mensaje expirará. uTimestamp

Tiempo relativo: Se indica usando la letra “u” seguida del número de segundos que deben transcurrir antes de que el mensaje expire. uSegundos

Ejemplos Para indicar que el mensaje debe expirar a las 11:00 del día 10/03/2015: 2015-03-10 11:00:00 u1425981600 Para indicar que el mensaje expire dentro de 1 día, 10 horas y 30 minutos: 0000-00-01 10:30:00

u124200

http://es.wikipedia.org/wiki/Tiempo_Unix


004FDED4

SERVICIOS WEB 2015

Control de cambios

v06 2010-06-08 Creado control de cambios

Añadidos nuevos errores en multienvio02

v07 2010-09-22 Añadida descripción del formato para destinos internacionales

Modificada la descripción de los parámetros para aclarar que son obligatorios aunque pueden ir vacíos.

v08 2010-10-06 Añadido nuevo código de error en multienvio02

v09 2010-11-16 Añadida nueva función multienvio03 para adjuntar listas .csv

Cambio en la descripción del parámetro ‘nombrelista’ en la función ‘multienvio03’ para indicar que la separación es por comas en lugar de punto y comas.

v10 2011-09-20 Creado índice

Añadido nuevo código de error en multienvio03

Quitado el aviso de parámetro no operativo para ‘emailResponderA’ en multienvio03

Añadida función envioSmsDirecto

Añadida función envioVoz

v11 2011-11-02 Añadida nueva función multienvio04. Cambios respecto a multienvio03:

o Cambia el tipo de valor devuelto o El parámetro ‘adjuntos’ es operativo

Cambiado el orden de las funciones para agruparlas por funcionalidad

Añadida advertencia en consultaMensaje para hacer notar que no puede utilizarse para consultar envíos de voz

v12 2012-03-07

Añadida introducción

Añadida función consultaHLR

Añadido acceso a través de servidorSms.php

Añadido ejemplo de valor devuelto en consultaMensaje

Cambiado el orden de las funciones para agruparlas por funcionalidad

v13 2012-04-02 Añadida nueva función multienvio05. Cambios respecto a multienvio04:

o Añadidos parámetros para permitir solicitar la certificación del envío.

Añadida función envioSmsCertificado

v14 2013-10-17 Añadida funcionalidad adicional al parámetro ‘certificadoA’ en ‘multienvio05’.

Cambio en la explicación del valor devuelto para facilitar la comprensión en las funciones envioSms y envioMms

Añadido el resultado 50000 a la lista de resultados posibles

Añadidas funciones ‘crearConsultaHLRMasiva’, 'estadoConsultaHLRMasiva', 'descargarConsultaHLRMasiva' y 'consultarSaldoSms'


004FDED4

SERVICIOS WEB 2015

v15 2013-10-24 Error tipográfico en consultaEstadoSms y consultaHLR. Añadida función consultaEstadoSms en la lista de funciones de “Acceso”

v16 2014-04-25 Añadidos nuevos códigos de error en consultaHLR.

Añadida información en el anexo 1 relativa a la notificación de entrega al operador.

V17 2014-10-06 Cambiado nombre de parámetro “remitente” en EnvioSms

Cambios en envioSmsDirecto para reflejar la posibilidad de solicitar la notificación de entrega al operador y documentar la funcionalidad de envío UCS2.

V18 2014-11-06 Añadidos parámetros “customerReference” y “department” en la documentación del

callback

Cambio en “descargarInforme” para incluir el nuevo tipo ‘certificado’ e indicar que se puede devolver el PDF en el campo ‘detalle’ si el envío es certificado

V19 2014-11-19 Creada función “descargarInformeCertificado”

Cambio en “descargarInforme” para quitar el tipo ‘certificado’.

V20 2014-12-16 Incluido nuevo valor de resultado en “envioSmsDirecto” para números restringidos.

Agrupados códigos de error interno.

V21 2015-03-10 Añadidas funciones multienvio06, envioSms02, envioSmsCertficado02,

envioSmsDirecto02 para dar soporte a expiración de SMS

Creado Anexo 2 con información relativa al parámetro “expiración”

V22 2015-05-26 Añadida función multienvio07 para permitir guardar plantillas y borradores y usarlos a

posteriori para realizar envíos.

Añadidos vínculos a las funciones en la introducción

Servicios web gms v22 2015 05 26

Documents

Transcript of Servicios web gms v22 2015 05 26