De Centro de Conocimientos DANA

Web service SOAP que permite enviar conversaciones inteligentes a un contacto o un segmento de contactos predeterminado. Una conversación inteligente es un proceso automatizado de envío mensajes por diversos canales.

Acceso

Cómo empezar a utilizar el Web Service

1. La compañía que va a utilizar el Web Service debe contar con un usuario y contraseña válidos. Para solicitar estas credenciales comuníquese con soporte técnico.
2. Por motivos de seguridad, el usuario que va a utilizar el Web Service debe contar con un permiso especial para el uso de las APIs de DANA. Para solicitar estas credenciales comuníquese con soporte técnico.
3. La conversación que se va a enviar debe estar creada y activada en el sistema (con estatus "Activa").
4. Es requisito indispensable que se haya predeterminado el segmento de contactos sobre el cuál actuará la conversación, y que se haya establecido la equivalencia de etiquetas con los campos correspondientes del segmento.

Resumen de los métodos

String startConversation(String idCompany, 
          String login, 
          String password, 
          Long idConversation, 
          Long idContact <opcional>)

String startConversationWithData(String idCompany, 
          String login, 
          String password,
          Long idConversation,
          String tableCode,
          StringMap values)

Detalle de los métodos

startConversation

Envía una conversación inteligente a un contacto o un segmento de contactos predeterminado.

Sintaxis

public String startConversation(String idCompany, 
                 String login, 
                 String password, 
                 Long idConversation, 
                 Long idContact <opcional>)
          throws InternalDanaException,
                 InvalidUserException,
                 InvalidAccessException,
                 InvalidCompanyException,
                 InvalidConversationException,
                 InvalidContactIdException,
                 InsufficientBalanceException,
                 RuntimeException)

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.
• idConversation - Identificador de la conversación inteligente que se desea enviar, la cual ha sido activada previamente en el sistema. El identificador de la conversación puede obtenerse de la aplicación Envío de Comunicaciones, accediendo al detalle de una conversación activa, y buscando el botón "i" de información ubicado a la derecha del nombre de la conversación.
• idContact - Parámetro opcional. Si está presente, identifica el contacto del segmento predeterminado al cual se desea enviar la conversación, y se obtiene de la columna UID de la tabla correspondiente en la aplicación Bases de Datos Web. Si no está presente, la conversación será enviada a todos los contactos del segmento predeterminado.

Valor devuelto

Retorna un string con los siguientes errores.

• "OK";
• "ERROR - Internal error";
• "ERROR - Invalid login or password";
• "ERROR - Access denied";
• "ERROR - Invalid company";
• "ERROR - Invalid id contact";
• "ERROR - Invalid id conversation";
• "ERROR - Insufficient balance";
• "ERROR - Runtime error";

Excepciones

• InternalDanaException - Si ocurrió un error interno.
• InvalidUserException - Si el usuario o la clave son inválidos.
• InvalidAccessException - Si el usuario no posee el permiso para ejecutar APIs de DANA.
• InvalidCompanyException - Si no existe una compañía registrada con el identificador suministrado.
• InvalidConversationException - Si no existe la conversación o no se encuentra activa en el sistema.
• InvalidContactIdException - Si el contacto suministrado no existe en el segmento de contactos predeterminado para la conversación.
• InsufficientBalanceException - Si la empresa no cuenta con el saldo suficiente para ejecutar la conversación.
• RuntimeException - Si la petición no puede realizarse por falta de disponibilidad de la plataforma.

Volver

startConversationWithData

Inserta la información de un contacto, contenida en un arreglo de valores, en una base de datos existente y envía una conversación inteligente a ese contacto.

Sintaxis

public String startConversationWithData(String idCompany, 
                 String login, 
                 String password, 
                 Long idConversation, 
                 String tableCode, 
                 StringMap values)
          throws InternalDanaException,
                 InvalidUserException,
                 InvalidAccessException,
                 InvalidCompanyException,
                 InvalidConversationException,
                 InvalidTableOrColumnException,
                 InsufficientBalanceException,
                 RuntimeException)

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.
• idConversation - Identificador de la conversación inteligente que se desea enviar, la cual ha sido activada previamente en el sistema. El identificador de la conversación puede obtenerse de la aplicación Envío de Comunicaciones, accediendo al detalle de una conversación activa, y buscando el botón "i" de información ubicado a la derecha del nombre de la conversación.
• tableCode - Código de la base de datos en la cual se insertará la información del contacto contenida en el arreglo "values". Este código se obtiene en la aplicación Base de Datos Web, en la sección "Ficha de la BD" de la tabla específica.
• values - Arreglo llave-valor que contiene la información que será insertada en la base de datos "tableCode". El arreglo incluye binomios llave-valor donde la llave es el código del campo de la base de datos. Estos códigos se obtienen en la aplicación Base de Datos Web, en la sección "Campos BD" de la tabla específica.

Valor devuelto

Retorna un string con los siguientes errores.

• "OK";
• "ERROR - Internal error";
• "ERROR - Invalid login or password";
• "ERROR - Access denied";
• "ERROR - Invalid company";
• "ERROR - Invalid id conversation";
• "ERROR - Invalid table or column";
• "ERROR - Insufficient balance";
• "ERROR - Runtime error";

Excepciones

• InternalDanaException - Si ocurrió un error interno.
• InvalidUserException - Si el usuario o la clave son inválidos.
• InvalidAccessException - Si el usuario no posee el permiso para ejecutar APIs de DANA.
• InvalidCompanyException - Si no existe una compañía registrada con el identificador suministrado.
• InvalidConversationException - Si no existe la conversación o no se encuentra activa en el sistema.
• InvalidTableOrColumnException - Si el código de la tabla o alguno de los campos no existe.
• InsufficientBalanceException - Si la empresa no cuenta con el saldo suficiente para ejecutar la conversación.
• RuntimeException - Si la petición no puede realizarse por falta de disponibilidad de la plataforma.

Volver

Ejemplos

Para descargar los ejemplos presione aquí.

Volver