Punto de acceso directo a la API para el chat

El punto de acceso directo (DAP) de la API para el chat te permite enrutar automáticamente las sesiones de chat entrantes a una cola según una respuesta de un extremo de API externo que configures. Esto elimina la necesidad de que los usuarios finales seleccionen una opción del menú de filas. El extremo puede ser tuyo o de un servicio de terceros.

Cuando esta capacidad está habilitada, cuando un usuario final inicia un chat, la plataforma de la CCAI envía una solicitud a tu extremo de API. La API devuelve datos de enrutamiento (pares clave-valor), que la plataforma de CCAI usa para asignar el usuario final a la cola correcta. Si no se encuentra ninguna coincidencia, aparecerá el menú estándar de la fila como alternativa.

La DAP de la API funciona para lo siguiente:

  • Chats web y para dispositivos móviles

  • Chats nuevos y reanudados

Antes de comenzar

De forma predeterminada, esta capacidad está inactiva. Comunícate con el equipo de asistencia de Google Cloud para activarlo en tu instancia.

Tipos de DAP

Existen dos tipos de DAP: respuesta de API y respuesta de webhook. Cada tipo de DAP tiene un flujo de trabajo diferente.

Respuesta de la API

Este es el flujo de trabajo de respuesta de la API:

  1. Un usuario final inicia un chat nuevo o reanuda uno existente.

  2. Antes de que aparezca el menú de la fila, la Plataforma de la CCAI envía una solicitud al extremo de API, incluidos los parámetros que hayas definido, como los metadatos de la sesión o los datos personalizados.

  3. La API devuelve uno o más pares clave-valor.

  4. La Plataforma de CCAI correlaciona estos pares con los pares clave-valor configurados en tus colas de chat. Todos los pares deben coincidir para que el chat se dirija a una cola.

  5. Si se encuentra una coincidencia, se enruta al usuario final directamente a esa cola.

  6. Aparecerá el menú de la cola estándar si ocurre alguna de las siguientes situaciones:

    • No se encuentra ninguna coincidencia.

    • La API no responde dentro del tiempo de espera configurado para la solicitud a la API.

Respuesta de webhook

Este es el flujo de trabajo de respuesta del webhook:

  1. Un usuario final inicia un chat nuevo o reanuda uno existente.

  2. Antes de que aparezca el menú de la fila, la Plataforma de CCAI envía una solicitud al extremo de API, que incluye una URL de webhook.

  3. La API devuelve una respuesta de confirmación (HTTP 200) dentro del tiempo de espera de la solicitud a la API.

  4. Tu sistema procesa la solicitud y envía datos de enrutamiento (pares clave-valor) a la plataforma de la CCAI a través del webhook.

  5. La Plataforma de CCAI correlaciona estos pares con los pares clave-valor configurados en tus colas de chat. Todos los pares deben coincidir para que el chat se dirija a una cola.

  6. Si se encuentra una coincidencia, se enruta al usuario final directamente a esa cola.

  7. El menú de la cola estándar aparece si ocurre alguna de las siguientes situaciones:

    • No se encuentra ninguna coincidencia.

    • No se recibe la confirmación dentro del tiempo de espera de la solicitud a la API.

    • No se recibe la respuesta del webhook dentro del tiempo de espera de la devolución de llamada de la API.

Configura un DAP de la API para el chat de forma global

Para configurar un DAP de API para el chat de forma global, sigue estos pasos:

  1. En el portal de la Plataforma de CCAI, haz clic en Configuración > Configuración del desarrollador. Si no ves el menú Configuración, haz clic en Menú.

  2. Ve al panel Punto de acceso directo a la solicitud de API y, luego, haz clic en Administrar el punto de acceso directo a la solicitud de API.

  3. Haz clic en la pestaña Chat.

  4. Haz clic en el botón de activación API Request Direct Access Point for Chat para activarlo.

  5. En Direct Access Point Type, selecciona uno de los siguientes tipos de DAP:

    • Respuesta de la API: La API devuelve datos de rutas en su respuesta.

    • Respuesta de webhook: La API confirma la solicitud y, luego, envía datos de enrutamiento a un webhook.

  6. Para especificar qué tipos de chat activan la DAP de la API, en Tipos de chat, selecciona uno o ambos de los siguientes:

    • Chats nuevos

    • Chats reanudados

  7. En el campo Solicitud a la API, ingresa la URL del extremo de API que se usará para la DAP.

  8. Para configurar la autenticación, haz una de las siguientes acciones:

    • Para configurar la autenticación básica, haz lo siguiente:

      1. En Método de autenticación, selecciona Autenticación básica.

      2. En Authentication Credentials, ingresa tu nombre de usuario y contraseña.

    • Para configurar un encabezado personalizado, haz lo siguiente:

      1. En Authentication Method, selecciona Custom Header.

      2. Haz clic en Agregar campo. Aparecerá el cuadro de diálogo Agregar campo.

      3. Ingresa una clave y un valor de campo, y, luego, haz clic en Guardar.

  9. Para configurar el tiempo de espera de la solicitud a la API, haz lo siguiente:

    1. En API Request Timeout, establece la cantidad de segundos que espera la plataforma de CCAI para que la API responda antes de que se agote el tiempo de espera.

    2. Opcional (aparece solo si seleccionaste el tipo de DAP Webhook Response): En API Callback Timeout, establece la cantidad de segundos que espera la plataforma de CCAI para recibir datos de enrutamiento del webhook (después de la confirmación inicial) antes de que se agote el tiempo de espera.

  10. Para configurar el método de solicitud, en API Request Method, selecciona POST o GET.

  11. Para configurar un parámetro de datos, haz lo siguiente:

    1. Haz clic en el botón de activación Pasar parámetros de datos para activarlo.

    2. Haz clic en Add Parameter. Aparecerá el cuadro de diálogo Agregar parámetro.

    3. Realiza una de las siguientes acciones:

      • Para configurar un parámetro de datos fijo, haz lo siguiente:

        1. En la lista Tipo, haz clic en Fijo.

        2. En el campo Destination Field, ingresa la clave de destino.

        3. En el campo Valor del destino, ingresa el valor del destino. En el campo Preview, aparecerá una vista previa de tu parámetro de datos.

      • Para configurar un parámetro de datos dinámicos, haz lo siguiente:

        1. En la lista Tipo, haz clic en Dinámica.

        2. Realiza una de las siguientes acciones:

          • Para configurar los metadatos de la sesión, haz lo siguiente:

            1. En la lista Fuente, selecciona Metadatos de sesión.

            2. En la lista Campo entrante, selecciona un tipo de metadatos.

          • Para configurar datos personalizados firmados, haz lo siguiente:

            1. En la lista Fuente, selecciona Datos personalizados firmados.

            2. En la lista Campo entrante, ingresa el campo entrante.

          • Para configurar datos personalizados sin firmar, haz lo siguiente:

            1. En la lista Fuente, selecciona Datos personalizados sin firmar.

            2. En la lista Campo entrante, ingresa el campo entrante.

        3. En el campo Campo de destino, ingresa el campo de destino. En el campo Preview, aparecerá una vista previa de tu parámetro de datos.

    4. Haz clic en Add Parameter. Tu parámetro de datos aparecerá en la lista Parámetros de datos.

  12. Opcional: Para probar tu configuración, haz lo siguiente:

    1. Ve a la sección Probar conexión. Tus parámetros de datos aparecerán en la lista.

    2. Opcional: Para probar diferentes valores de parámetros, edita los valores de los parámetros en la lista.

    3. Haz clic en Probar esta conexión.

  13. Haz clic en Guardar la API de Chat.

Cambia la lógica de enrutamiento

La lógica de enrutamiento es el orden en el que la Plataforma de CCAI intenta varios tipos de coincidencias para asignar un chat a una cola. CCAI Platform evalúa cada tipo de coincidencia en orden y enruta el chat a la primera fila de espera coincidente. Si no se encuentra ninguna coincidencia, aparecerá el menú estándar de la fila.

Estos son los tres tipos de concordancia:

  • Respuesta de la API: Coincide según los pares clave-valor de la respuesta de la API.

  • Etiqueta de punto de acceso general: Coincide según la etiqueta de punto de acceso general de la fila.

  • Segmentación de usuarios: Se generan coincidencias en función de los datos de segmentos de usuarios.

Para cambiar la lógica de enrutamiento, sigue estos pasos:

  1. En el portal de la Plataforma de CCAI, haz clic en Configuración > Configuración del desarrollador. Si no ves el menú Configuración, haz clic en Menú.

  2. Ve al panel Punto de acceso directo a la solicitud de API y, luego, haz clic en Administrar el punto de acceso directo a la solicitud de API.

  3. Haz clic en la pestaña Chat.

  4. En Lógica de enrutamiento, mantén el puntero sobre un tipo de coincidencia y arrástralo a una nueva posición.

  5. Repite este paso si es necesario.

  6. Haz clic en Guardar la API de Chat.

Configura un DAP para el chat a nivel de la cola

Para configurar un DAP para el chat a nivel de la fila, sigue estos pasos:

  1. En el portal de CCAI Platform, haz clic en Configuración > Queue. Si no ves el menú Configuración, haz clic en Menú. Aparecerá la página Queue Menu Settings.

  2. Según el canal que quieras, realiza una de las siguientes acciones:

    • En el panel Dispositivos móviles, haz clic en Editar o ver.

    • En el panel Web, haz clic en Editar o ver.

  3. Haz clic en la cola que deseas editar.

  4. En el panel Configuración, ve a la sección Access Point.

  5. Haz clic en Crear punto de acceso directo. Aparecerá el diálogo Create Direct Access Point.

  6. En la lista Access Point Type, haz clic en API Response.

  7. En el campo Nombre del punto de acceso, ingresa un nombre para el punto de acceso.

  8. Haz clic en Agregar clave y valor. Ingresa un par clave-valor para que coincida con un par clave-valor que se devuelva en la respuesta de la API.

  9. Repite el paso anterior para agregar más pares clave-valor.

  10. Opcional: En el campo Mensaje de saludo, ingresa el mensaje de saludo que deseas usar cuando se dirija a un usuario final a esta opción del menú.

  11. Haz clic en Crear. Tu DAP aparecerá en la lista Access Point.