Conexión de llamadas en ActionBot

Breve descripción general

La opción Conexiones de llamada en ActionBot permite llamar a una API externa predefinida durante una conversación.

Al llamar a una API, el bot puede enviar parámetros a la API y obtener parámetros en la respuesta.

¿Por qué utilizar este conector?

El uso de una API externa permite que el ActionBot se integre con varios sistemas y proporciona una variedad de opciones al crear una conversación.

La API se puede utilizar para enviar información a una API externa (por ejemplo, abrir un ticket de TI), recibir información de una API externa (por ejemplo, obtener un número de ticket) o ambos.

Cómo utilizar la conexión de llamadas.

Tutorial en video

Consulta este breve tutorial sobre el uso de ActionBot para abrir un ticket en ServiceNow.

Paso 1: Crea una conexión

Esta sección describe cómo añadir una nueva conexión a la cuenta del editor de ActionBot. El uso de la conexión durante una conversación se realizará en el siguiente paso.

1. En la sección Conexiones, haz clic en "AÑADIR NUEVA CONEXIÓN".
2. Elige "Añadir nuevo destino".

3. Define todos los parámetros necesarios en la ventana de diálogo y haz clic en "Crear" (Este es un paso de configuración y estos parámetros deben ser proporcionados por el propietario de la API).

1. 1. Nombre del destino-
      • Proporciona un nombre fácil de usar que se utilizará para identificar la conexión más adelante en el proceso.
      • Puedes elegir el nombre que desees.
   2. Tipo de solicitud-
      • Puede ser GET/POST/DELETE/PUT.
      • Debe ser proporcionado por el propietario de la API.
   3. URL de destino-
      • Debe ser una URL de API legal.
      • Debe ser proporcionado por el propietario de la API.
      • La URL de destino puede contener parámetros de consulta dinámicos.
      • Para crear un parámetro de consulta dinámico dentro de una URL de destino, envuelve el valor de cadena con llaves.
      • Por ejemplo: https://test.api/{production}/
      • La URL de destino también puede contener variables de BBcode que permiten a los usuarios asignar los parámetros de URL dinámica a las respuestas del usuario final o utilizar variables de entorno compatibles con BBcode, como wm-data, cookies y jquery.
   4. Tipo de autorización: actualmente solo admitimos tres tipos de autenticación.
      1. Sin autenticación: no requiere ninguna información.
      2. Bearer Token: requiere un token de autenticación.
      3. Autenticación básica: requiere usuario + contraseña.
         • Ten en cuenta que la contraseña para la autenticación básica no puede contener el símbolo de dos puntos:
   5. Encabezados (opcional): algunas API requieren o permiten encabezados.
   6. Se recomienda probar la conexión a la API para asegurarse de que todos los detalles sean correctos.

4. Se debe añadir Nueva Conexión a la lista de conexiones.

Paso 2: añade la acción "Llamar a la conexión" durante una conversación.

Esta sección describirá cómo utilizar una conexión, que se definió en el paso anterior, durante una conversación.

1. Añade una nueva acción.
2. Elige el tipo de acción "Call Connection" y selecciona el destino de la conexión. El destino de la conexión de llamada es el nombre de la conexión que se definió en el paso anterior.

• Al utilizar Call Connections con parámetros de consulta dinámicos, variables de BBcode o ambos, los usuarios pueden asignar las respuestas del usuario final a la URL de destino como variables dinámicas.
  1. Los parámetros de consulta dinámica y las variables de BBcode se mostrarán debajo de la entrada Selecciona conexión de llamada al destino cuando el destino contenga un parámetro de consulta dinámico o una variable de BBcode.
  2. Los parámetros de consulta dinámica o las variables de BBcode enumeradas se pueden asignar a elementos de conversación desde el menú desplegable.
  3. 

3. Define los datos que envía la llamada de conexión de WalkMe (opcional).

Es posible enviar algunos parámetros de conversación a la llamada a la API. En cada fila, el lado izquierdo define qué datos de conversación se deben enviar, y el lado derecho definirá el nombre del parámetro que la API espera recibir.

En el siguiente ejemplo, la API espera obtener un parámetro llamado "base" y definiremos que el valor de "base" contendrá la respuesta del usuario a una pregunta anterior (en este caso, "¿Qué moneda?").

Al hacer clic en "raw" se permitirá la edición libre de los parámetros en formatos XML o JSON.

4. Define el mapeo de datos de respuesta (opcional).

Algunas API devuelven una respuesta. Si la respuesta está en formato XML o JSON, es posible utilizar esa respuesta y guardarla en nuevas variables que podrían utilizarse más tarde en la conversación.

Mapeo de la respuesta en una nueva variable.

El usuario puede añadir tantas variables como desee. Para cada variable, se debe definir lo siguiente:

• Nombre: elige un nombre para la nueva variable.
  • No añadas caracteres especiales en los nombres de variables, por ejemplo, guiones, puntos, (), !*, - {} @
• Tipo: define el tipo de la nueva variable. Actualmente, solo admitimos tipos primitivos Cadena/Número/Booleano/Matriz.
• Ruta: define la ruta en la respuesta JSON/XML que conduce a la información deseada. Para ayudar al usuario a definir la ruta, se ha añadido una herramienta de "constructor de rutas". Al hacer clic en él, el editor enviará un ping a la API de destino para recibir una respuesta de ejemplo y permitirá al usuario navegar a través de la respuesta de ejemplo para definir fácilmente la ruta. Si la API requiere que se envíe un parámetro, el constructor de rutas pedirá que se proporcionen parámetros de muestra............................
• Valor predeterminado: este valor se almacenará en la variable en caso de que la ruta definida en la respuesta no conduzca a datos válidos.
• Valor de error: este valor se almacenará en la variable en caso de que falle la llamada a la API.

Paso 3: usando las variables de datos de respuesta durante la conversación.

En caso de que se haya creado una nueva variable a partir de los datos de respuesta, se podría utilizar más adelante en la conversación utilizando "@" en los siguientes casos:

1. En un mensaje: muestra la variable al usuario como parte del texto del mensaje.
2. En una pregunta, la variable se muestra al usuario como parte del texto de la pregunta.
3. En una pregunta de elección, muestra la variable como parte de la sugerencia que se mostrará al usuario. Para una variable de tipo array, cada campo del array se mostrará como una sugerencia separada. Si el array contiene objetos (en lugar de un solo atributo para cada elemento), puedes definir qué atributo se mostrará al usuario y qué atributo se almacenará.
4. En una condición: el generador de condiciones puede utilizar la variable como base para una condición.
5. En un contenido de WM (por ejemplo, SWT), al reproducir un contenido de WalkMe (a través de una acción), las variables se pueden utilizar para los datos que requiere el contenido.

Vídeo de consejos del martes