De Centro de Conocimientos DANA

Web service SOAP que permite enviar mensajes por diferentes canales de comunicación de DANA.

Acceso

Se recomienda utilizar el protocolo HTTPS.

Cómo empezar a utilizar el Web Service

1. La compañía que va a utilizar el Web Service debe estar autorizada para hacerlo, para solicitar la autorización comuníquese con soporte técnico.
2. Se debe crear un usuario con el perfil apropiado que será utilizado por el sistema que consume el Web Service, para más información véase Perfil.
3. 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

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 los métodos

void send(String idCompany, 
          String login, 
          String password, 
          String idChannel, 
          String idCampaign, 
          String recipientAddress,
          StringMap values)

Detalle de los métodos

send

Envía un mensaje a través de un canal partiendo de una campaña comunicacional.

Sintaxis

public void send(String idCompany, 
                 String login, 
                 String password, 
                 String idChannel, 
                 String idCampaign, 
                 String recipientAddress,
                 StringMap values)
          throws InternalDanaException,
                 InsufficientBalanceException,
                 InvalidCampaignException,
                 MissingParameterException,
                 InvalidRecipientAddressException,
                 LockRecipientAddressException,
                 UnautorizedSendMessageException,
                 MessageTemporarilyRejectedException,
                 LimitMessagesReachedException,
                 UnableSendMessageException,
                 InvalidUserException,
                 InvalidCompanyException,
                 InvalidChannelException

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 - 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.

Valor devuelto

No retorna valor alguno.

Excepciones

• 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.

Volver

Ejemplos

Para descargar los ejemplos presione aquí

Volver