MessageSenderHTTP/S
De Centro de Conocimientos DANA
| Centro de Conocimientos DANA > Interfaces de conexión con DANA (API) > MessageSenderHTTP/S |
Interfaz HTTP/S que permite integrar sistemas externos con la plataforma DANA para enviar mensajes de SMS, Email y Llamadas Automáticas por diferentes canales de comunicación.
Contenido |
Acceso
Cómo empezar a realizar la integración
- La compañía que va a utilizar la interfaz http debe estar autorizada para hacerlo, para solicitar la autorización comuníquese con soporte técnico.
- Se requiere crear un usuario en el sistema DANA de la compañía y asignarle acceso a las aplicaciones Email Masivo, SMS Masivo y Llamadas Masivas.
- Crear una campaña desde la aplicación Email Masivo, SMS Masivo o Llamadas Masivas de acuerdo al caso correspondiente.
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.
Resumen de funcionamiento
Parámetros requeridos
- idcompany - Identificador de la compañía propietaria de la campaña.
- login - Login del usuario que hace el envío.
- pwd - Clave del usuario que hace el envío.
- idcampaign - Campaña que contiene la plantilla del mensaje.
- recipientaddress - Dirección del destinatario.
- values - Valor de los parámetros que recibe la campaña, es un diccionario donde la clave contiene el nombre del parámetro y el valor contiene el valor del parámetro.
Ejemplos
- Envío de un SMS.
-
- idcompany: xyz
- login: userabc
- pwd: D4E24fhHZq
- idcampaign: 123
- recipientaddress: 58416XXXXXXX
- values[message]: Test (Parámetro dinámico en la campaña)
https://apihttp.danacrm.com/sendsmsv2/http_send.php?idcompany=xyz&idcampaign=123&login=userabc&pwd=D4E24fhHZq&values[message]=Test&recipientaddress=58416XXXXXXX
Valores devueltos
- 1 - Mensaje enviado satisfactoriamente.
- 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.
