DOCUMENTACIÓN DEL CONECTOR SMS-PUSH

Table of Contents

Conector SMS-PUSH

Description

SOAP Web Services

Remarks

Este documento proporciona instrucciones para integrar servicios de mensajería SMS en cualquier solución usando la API de 160World. Le proporcionará la descripción de nuestros Web Services para el conector SMS-PUSH.

Sources
Name Description
ServiceSms Descriptor de nuestro Web Service

 

ServiceSms Web Service

Description

Descriptor de nuestro Web Service

Remarks

La API de 160World está basada en estándares abiertos como Simple Object Access Protocol (SOAP), Web Services Definition Language (WSDL) o XML Schema Definition Language (XSD).

A través de la API usted podrá desarrollar sus propias aplicaciones y usar 160World para enviar mensajes SMS, Telegram y Whatsapp en cualquier parte del mundo.

Los servicios de mensajería mediante Telegram y Whatsapp, así como el servicio VozBoomerang deben ser activados previamente para tenerlos disponibles en su cuenta de 160World. Contacte con nosotros para obtener más información sobre el proceso de activación.

Telegram ha sido integrado de manera transparente para el usuario mediante el servicio delegado @Notificame. Está, por tanto, disponible directamente en los métodos de envío de mensajes SMS y no requiere integración adicional. Nuestra integración combina Telegram con SMS para asegurar la entrega al cliente final por la vía más adecuada.

Whatsapp Busines API (WABA) es el nuevo servicio para empresas producido por Meta. La integración que hemos realizado en nuestra plataforma abstrae la complejidad de esta API para su uso en mensajería transaccional mediante el uso de plantillas. Podrá hacer uso de esta característica mediante el servicio delegado @Notificame o directamente con su cuenta de empresa en Meta, consulte con nosotros para recibir más información al respecto. En este caso también combinamos Whatsapp con SMS para asegurar la entrega al cliente final por la vía más adecuada.

VozBoomerang es nuestra propuesta de recordatorio de cita por voz automatizando el proceso de llamada a pacientes para recordarles su cita y recogiendo mediante VoiceBot la confirmación o cancelación de esta. Se trata de un servicio realmente útil para perfiles de pacientes no muy formados en las nuevas tecnologías.

Para usar nuestra API, necesitará conocer el funcionamiento de los Web Services SOAP. En la actualidad, la mayoría de los lenguajes de programación proporcionan librerías para acceso SOAP.

WSDL
Name Description
https://www.160world.net/servicios/ServiceSms.svc?wsdl URL del descriptor de nuestro Web Service
See Also

Methods | Complex Types

Methods: ServiceSms

Description

La API SOAP de 160World pone a su disposición los siguientes métodos

Methods
Name Description
EnviarSms Envía un mensaje SMS/Telegram compuesto por Remitente y Texto a uno o varios números de teléfono.
EnviarListaSms Permite enviar uno o más mensajes SMS/Telegram diferentes para cada número de destino
EnviarWhatsapp Envía un mensaje de plantilla mediante Whatsapp Business API. Las plantillas deben ser validadas previamente por Meta.
EnviarVoz Permite enviar un mensaje de voz mediante Text-to-Speech a uno o varios números de teléfono
GetEstado Consulta el estado de un mensaje determinado por su ID
GetSaldo Consulta el saldo actual de una cuenta final en valor moneda

Method: EnviarSms
Description

Permite enviar uno o más mensajes diferentes para cada número de destino

Parameters
Name Type Direction Description
Usuario string Input Nombre de usuario facilitado por 160World
PassWord string Input Contraseña facilitada por 160World
Remitente string Input Cadena alfanumérica con una longitud máxima de 11 caracteres, cadenas de longitud superior serán truncadas. Solamente son válidos caracteres del alfabeto (a..z,A..Z) y numéricos (0..9)
Texto string Input Cuerpo del mensaje con una longitud de 160 caracteres ajustados a los estándares GSM o hasta 765 usando mensajes concatenados.
Telefonos ArrayOfstring Input Array con uno o más teléfonos de destino.
– Para envíos al país propio no es necesario introducir el código de país.
– Para envíos a países distintos al propio, se debe usar el siguiente formato:
CodigoPais NumeroTelefono
Ej: 32 8765432
Url string Input Dirección web para agregar al campo Texto (se agregará al final del mismo).
Esta Url puede tener cualquier longitud ya que antes de agregarse, pasará por el acortador de Url’s de 160World, proporcionando una Url corta del tipo “http://160s.co/XXX”.
La Url debe incluir necesariamente “http://” o “https://” para ser reconocida como válida.
Al ser un parámetro opcional, se puede omitir, pero si se incluye, su posición en el xml de la petición es fijo y se debe respetar.
Returns

La respuesta devuelta por EnviarSms contiene un bloque ReturSms para cada uno de los mensajes enviados

Name Type Description
ReturSms ReturSms

Method: EnviarListaSms
Description

Envía un mensaje compuesto por Remitente y Texto a uno o varios números de teléfono

Parameters
Name Type Direction Description
Usuario string Input Nombre de usuario facilitado por 160World
PassWord string Input Contraseña facilitada por 160World
ListaSms ArrayOfSms Input Lista de mensajes a enviar. Cada mensaje es un bloque con los parámetros necesarios
Returns

La respuesta devuelta por EnviarListaSms contiene un bloque ReturSms para cada uno de los mensajes enviados

Name Type Description
ReturSms ReturSms

Method: EnviarWhatsapp
Description

Envía un mensaje de plantilla mediante Whatsapp Business API. Las plantillas deben ser validadas previamente por Meta.

Parameters
Name Type Direction Description
Usuario string Input Nombre de usuario facilitado por 160World
PassWord string Input Contraseña facilitada por 160World
Remitente string Input Cadena alfanumérica con una longitud máxima de 11 caracteres, cadenas de longitud superior serán truncadas. Solamente son válidos caracteres del alfabeto (a..z,A..Z) y numéricos (0..9)
Plantilla string Input Nombre de la plantilla. Cada plantilla en Whatsapp tiene un nombre único. Estas plantillas se deben habilitar en la cuenta final para poder usarse desde la API.
Cabecera WhatsappCabecera Input Contiene los parámetros necesarios para especificar la forma de la cabecera según definición de la plantilla.
Cuerpo ArrayOfstring Input Array con una o más cadenas de texto que serán asignadas dinámicamente a cada uno de los parámetros del cuerpo de la plantilla. En caso de no coincidir el número de cadenas de texto, el envío fallará
BotonUrl string Input Url del único botón permitido de tipo llamada a la acción con URL dinámica. Permite personalizar dinámicamente un botón con enlace a un recurso externo.
Telefonos ArrayOfstring Input Array con uno o más teléfonos de destino.
– Para envíos al país propio no es necesario introducir el código de país.
– Para envíos a países distintos al propio, se debe usar el siguiente formato:
CodigoPais NumeroTelefono
Ej: 32 8765432
Returns

La respuesta devuelta por EnviarWhatsapp contiene un bloque ReturSms para cada uno de los mensajes enviados

Name Type Description
ReturSms ReturSms

Method: EnviarVoz
Description

VozBoomerang ha sido diseñado para cubrir las necesidades de ciertos perfiles de pacientes no muy preparados para manejar las nuevas tecnologías y para los que es más aconsejable recordarles sus citas mediante una llamada de teléfono usando voz. Nuestro sistema automatiza esta función llamando al paciente y entregándole el mensaje mediante voz neuronal usando las últimas tecnologías Text-to-Speech al tiempo que interactúa con él para recoger la Confirmación o Cancelación de la cita.

Parameters
Name Type Direction Description
Usuario string Input Nombre de usuario facilitado por 160World
PassWord string Input Contraseña facilitada por 160World
Remitente string Input Cadena alfanumérica con una longitud máxima de 11 caracteres, cadenas de longitud superior serán truncadas. Solamente son válidos caracteres del alfabeto (a..z,A..Z) y numéricos (0..9)
Texto string Input Cuerpo del mensaje SMS con una longitud de 160 caracteres ajustados a los estándares GSM o hasta 765 usando mensajes concatenados. En caso de no estar presente, se utilizará el mismo texto indicado en el campo Voz.
Voz string Input Texto que será convertido a voz utilizando Text-to-Speech y emitido en el teléfono de destino.
Telefonos ArrayOfstring Input Array con uno o más teléfonos de destino.
– Para envíos al país propio no es necesario introducir el código de país.
– Para envíos a países distintos al propio, se debe usar el siguiente formato:
CodigoPais NumeroTelefono
Ej: 32 8765432
Returns

La respuesta devuelta por EnviarSms contiene un bloque ReturSms para cada uno de los mensajes enviados

Name Type Description
ReturSms ReturSms

Method: GetEstado
Description

Consulta el estado de un mensaje determinado por su ID

Parameters
Name Type Direction Description
Usuario string Input Nombre de usuario facilitado por 160World
PassWord string Input Contraseña facilitada por 160World
Id int Input Identificador asignado por 160World al mensaje
Returns

La respuesta devuelta por GetEstado contiene un único parámetro con el estado del mensaje

Method: GetSaldo
Description

Consulta el saldo actual de una cuenta final en valor moneda

Parameters
Name Type Direction Description
Usuario string Input Nombre de usuario facilitado por 160World
PassWord string Input Contraseña facilitada por 160World
Returns

La respuesta devuelta por GetSaldo contiene un único parámetro con el saldo de la cuenta final o -1 en caso de ser una cuenta en pago mensual

Complex Types: ServiceSms

Complex Types
Name Description
ArrayOfSms Lista de mensajes para enviar con EnviarListaSms
ArrayOfstring Contenedor de teléfonos para EnviarSms o parámetros para EnviarWhatsapp
WhatsappCabecera Estructura con los parámetros de definición de la cabecera Whatsapp
ReturSms Respuesta devuelta por EnviarSms
Sms

Complex Type: ArrayOfSms
Description

Lista de mensajes para enviar con EnviarListaSms

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description
1..1
Sms Sms 0..* Lista de mensajes a enviar

Complex Type: ArrayOfstring
Description

Contenedor de teléfonos para EnviarSms o parámetros para EnviarWhatsapp

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description
1..1
string string 0..* Array con uno o más teléfonos/parámetros de destino.

Complex Type: WhatsappCabecera
Description

Estructura con los parámetros de definición de la cabecera Whatsapp

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description
1..1
Tipo string 0..1 Tipo de la cabecera: texto, imagen, video, document.
Valor string 0..1 texto: Valor textual del parámetro permitido
imagen, video, documento: URL dinámica del elemento.

Complex Type: ReturSms
Description

Respuesta devuelta por EnviarSms

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description
1..1
Id int 0..1 Identificador asignado por 160World al mensaje y que se puede usar posteriormente para consultar su estado
Resultado string 0..1 Código asignado al mensaje
Telefono string 0..1 Número de teléfono al que se envió el mensaje

Complex Type: Sms
Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description
1..1
Remitente string 0..1 Cadena alfanumérica con una longitud máxima de 11 caracteres, cadenas de longitud superior serán truncadas. Solamente son válidos caracteres del alfabeto (a..z,A..Z) y numéricos (0..9)
Telefono string 0..1 Array con uno o más teléfonos de destino.
– Para envíos al país propio no es necesario introducir el código de país.
– Para envíos a países distintos al propio, se debe usar el siguiente formato:
CodigoPais NumeroTelefono
Ej: 32 8765432
Texto string 0..1 Cuerpo del mensaje con una longitud de 160 caracteres ajustados a los estándares GSM o hasta 765 usando mensajes concatenados.

Tabla de Códigos internos

En la siguiente tabla puede consultar los posibles códigos internos devueltos por la API SOAP de 160World

Código Descripción
W160OK Entregado a 160World
W10002 Error cuenta inactiva
W10003 Error MVas Bloqueado
W10004 Error Proveedor
W10005 Error País Proveedor
W10006 Error País NO Permitido
W10007 Error Teléfono
W10008 Error Mensaje
W10009 Error Saldo
W10010 Error Whatsapp desactivado
W10011 Error Servicio de Voz desactivado

Tabla de Códigos de estado

160World asume el compromiso de ofrecer una alta calidad en el servicio de entrega de mensajes SMS, cerrando acuerdos con los principales Operadores y Agregadores de mensajería SMS, estableciendo el servicio en más de 180 países. Siempre que las condiciones técnicas de los Operadores lo permitan, 160World solicitara la confirmación de entrega de los mensajes, para poder ofrecer una trazabilidad del envío aportando valor al servicio.

En la siguiente tabla puede consultar los posibles códigos de estado devueltos por la API SOAP de 160World:

Código Descripción
W00OK Entregado a destino
W0TOK Entregado y visto en Telegram
W0W00 Entregado a destino por Whatsapp
W0W01 Leído y esperando acción en Whatsapp
W0WSI Confirmación en Whatsapp
W0WNO Cancelación en Whatsapp
W0WOK Leído y finalizado en Whatsapp
W0V00 Llamado, en espera de actualización
W0V01 En espera de rellamada
W0V02 Rellamado, en espera de actualización
W0VSI Confirmación en servidor de Voz
W0VNO Cancelación en servidor de Voz
W0VOK Finalizado, ignorado en servidor de voz
W0000 Entregado al Operador
W0001 Entregado al Destino sin confirmación
W0002 Entregado a SMSC
W0003 Finalizado en Operador
W0010 Atasco en SMSC
W0012 Destinatario Desconocido en Operador
W0015 Error – Expirado en Operador
W0018 Rechazado en Operador
W0019 Fallo en Operador o Destino por Motivos Desconocidos
W0021 Finalizado – Cancelado en Plataforma
W0022 Pendiente – En Bandeja de Salida
W0025 Pendiente – Preparando Entrega a Operador
W0027 Fallo en Destino
W0029 Fallo en Operador por Saldo de Destino Insuficiente
W0059 Error al procesar el mensaje

CONTACTAR

Cuenta con nosotros

Si has llegado hasta Desarrolladores es porque estas interesado en conocer más detalles sobre cómo integrarte. En este caso te damos la bienvenida, puedes comunicarte con nosotros mediante el siguiente email de Soporte, llamándonos por teléfono o en el caso de ser cliente accediendo al portal de soporte.

E-mail: soportesms@160world.com

En la parte inferior de esta página encontraras toda la información de nuestra API, si deseas probarla ponte en contacto con nosotros y te facilitamos una cuenta totalmente operativa.

Datos de contacto

160World, S.L.U
E-mail: 160World Soporte
Telefono 868185585

Portal de soporte

Acceda a nuestro portal de soporte:
Portal de soporte: soporte.160World.com

Documentación SMS-PUSH

Descarga la documentación de nuestro conector SMS-PUSH:
PDF: Conector SMS-PUSH 160World

LE AYUDAMOS A ENCONTRAR LA MEJOR SOLUCIÓN