MessageSenderHTTP/HTTPS
De Centro de Conocimientos DANA
| Centro de Conocimientos DANA > Interfaces de conexión con DANA (API) > MessageSenderHTTP/HTTPS |
Página HTTP / HTTPS que permite enviar mensajes por diferentes canales de comunicación de DANA.
Contenido |
Acceso
| Protocolo | URL |
| HTTPS | https://ws.danacrm.com:18181/dana/messaging/http/messageSenderHTTPS |
| HTTP | http://ws.danacrm.com:18080/dana/messaging/http/messageSenderHTTP |
- Se recomienda utilizar el protocolo HTTPS.
Cómo empezar a utilizar la página
- La compañía que va a utilizar la página debe estar autorizada para hacerlo, para solicitar la autorización comuníquese con soporte técnico.
- Se debe crear un usuario con el perfil apropiado que será utilizado por el sistema que consume la página, para más información véase Perfil.
- Se debe otorgar los permisos necesarios al usuario para realizar el envío en las campañas deseadas, para más información véase Permisos.
Canales soportados
| Identificador | Aplicación DANA | Descripción |
| Email Masivo | Envía un correo electrónico personalizado a un destinatario. | |
| sms | SMS Masivo | Envía un mensaje de texto (SMS) personalizado a un destinatario. |
| call | Llamadas Masivas | Realiza una llamada telefónica personalizada y automatizada a un destinatario. |
Nota: véase la documentación de la aplicación DANA relacionada al canal para conocer cómo es el formato de la dirección del destinatario y cuáles son las limitaciones del canal.
Parámetros
- idCompany - Identificador de la compañía propietaria de la campaña.
- login - Login del usuario que hace el envío.
- password - Clave del usuario que hace el envío.
- idChannel - Identificador del canal (por ejemplo: email; véase la lista de canales soportados).
- idCampaign - Campaña que contiene la plantilla del mensaje.
- recipientAddress - Dirección del destinatario.
- values[param] - Valor del parámetro de nombre param que recibe la campaña, donde param corresponde al nombre del parámetro y el valor corresponde al valor del parámetro. Este parámetro se repite tantas veces como parámetros tenga la campaña.
Respuesta
Caso de éxito
Si el mensaje se pudo enviar sin ningún tipo de problemas la página retornará el texto:
ok
Caso de fracaso
Si ocurrió algún problema enviando el mensaje la página retornará el texto:
error errorCode message
donde:
- errorCode corresponde al código del error ocurrido.
- message corresponde a un mensaje informativo que explica las causas del error.
Nota: cada elemento indicado en la respuesta está en una línea diferente.
Códigos de error
Los códigos de error corresponden al nombre de una excepción en el sistema, y se listan a continuación:
- InternalDanaException - Si ocurrió un error interno.
- InsufficientBalanceException - Si no se posee suficiente saldo para enviar el mensaje.
- InvalidCampaignException - Si el identificador de campaña suministrado es inválido. Esto puede ocurrir porque:
- - la campaña no existe,
- - no se indicó la campaña (es nulo o vacío),
- - el usuario no tiene permiso para utilizar la campaña.
- MissingParameterException - Si en el diccionario con el valor de los parámetros no se indicaron todos los parámetros requeridos para construir el mensaje.
- InvalidRecipientAddressException - Si la dirección del destinatario es inválida.
- LockRecipientAddressException - Si la dirección del destinatario está bloqueada.
- UnautorizedSendMessageException - Si la compañía no está autorizada para realizar el envío por el canal.
- MessageTemporarilyRejectedException - Si el mensaje no fue enviado porque se está tratando de enviar el mensaje en un horario no permitido para la compañía en el canal.
- LimitMessagesReachedException - Si se alcanzó el límite de envío de mensajes en un día al destinatario por parte de la compañía.
- UnableSendMessageException - Si el mensaje so se pudo envíar debido a que el proxy de envío lo rechazó.
- InvalidUserException - Si el usuario indicado no es válido, esto puede ocurrir porque el usuario no existe en la compañía indicada o no tiene permiso de utilizar el canal bajo el perfil apropiado, también puede ocurrir porque la clave sea inválida.
- InvalidCompanyException - Si no existe una compañía registrada con el identificador suministrado.
- InvalidChannelException - Si no existe un canal asociado al identificador de canal suministrado.
Ejemplo
Parámetros
Información de la cuenta
- idCompany: myCompany
- login: myLogin
- password: myPassword
Información de la campaña
- idChannel: sms
- idCampaign: 1234
Información del destinatario
- recipientAddress: +584141234567
Parámetros requeridos por la campaña
- firstName: Fulanito
- lastName: De Tal
URL de envío
https://ws.danacrm.com:18181/dana/messaging/http/messageSenderHTTP?idCompany=myCompany&login=myLogin&password=myPassword&idChannel=sms&idCampaign=1234&recipientAddress=%2B584141234567&values[firstName]=Fulanito&values[lastName]=De%20Tal
Nota: Tenga el cuidado de aplicar la codificación URL a cada uno de los valores que se suministra, de forma tal que la URL construida sea correcta
Respuesta del sistema
Caso de éxito
Si el mensaje se envío sin ningún tipo de problemas la respuesta del sistema será:
ok
Caso de error
Si ocurrió un error al tratar de enviar el sistema, por ejemplo, la campaña posee un parámetro denominado age cuyo valor no fue suministrado; en este caso la respuesta del sistema será:
error MissingParameterException Unspecified parameter value for 'age'
Ejemplos
Para descargar los ejemplos presione aquí
