Receta de mensajería: Obtener datos externos para el bot de mensajería

El paso Hacer llamada de API del generador de flujos permite que un bot de mensajería utilice una solicitud de API de REST para extraer datos de un sistema externo como Shopify o Salesforce.

Esta receta sirve de guía para crear una respuesta de bot encargada de extraer información meteorológica para un lugar proporcionado por el usuario final. La respuesta obtiene los datos de la API de OpenWeather. El flujo de respuesta creado con esta receta se puede usar como un punto de partida para crear sus propias respuestas impulsadas por la API.

La receta incluye las siguientes tareas:

• Tarea 1: Verificar la configuración
• Tarea 2: Crear una conexión de API
• Tarea 3: Crear un campo de ticket personalizado
• Tarea 4: Crear una respuesta usando el generador de flujos
• Tarea 5: Probar los cambios

Nota: Zendesk ofrece este artículo con fines de instrucción únicamente. Zendesk no ofrece soporte para los ejemplos presentados en este artículo, ni tampoco para las tecnologías de terceros, como la API de OpenWeather.

Tarea 1: Verificar la configuración

Para completar esta receta, se necesita lo siguiente:

• Una cuenta de Zendesk con un bot de mensajería publicado. Si desea, puede usar un entorno de pruebas de sandbox para probar el bot antes de usarlo en producción.

  Para configurar un bot de mensajería en un canal de mensajería por web y móvil, consulte Trabajar con bots de mensajería para los canales web y móvil. Para configurar un bot de mensajería en un canal de redes sociales, consulte Uso del generador de flujos para crear un bot de mensajería por redes sociales. Si desea información sobre cómo usar la mensajería en un entorno de sandbox, consulte Uso de la mensajería en un sandbox.

• Una clave de API para una cuenta de OpenWeather. La API que se usa en esta receta está disponible en el plan gratuito de OpenWeather.

  Para registrarse para una cuenta gratis de OpenWeather, consulte la página Create New Account (Crear nueva cuenta) del sitio web openweathermap.org. Después de iniciar sesión, puede obtener una clave de API en la página de su cuenta de OpenWeather.

  Para activar las claves de API de OpenWeather, debe verificar la dirección de correo electrónico de su cuenta. Después de la verificación, las claves de API pueden demorar hasta dos horas para activarse. Si desea más información, consulte las preguntas frecuentes en openweathermap.org.

Tarea 2: Crear una conexión de API

Para comenzar, cree una conexión de API para guardar su clave de API de OpenWeather. Su bot de mensajería puede usar esta conexión para autenticar las llamadas a la API de OpenWeather.

Para crear la conexión

1. En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y luego seleccione Conexiones > Conexiones.
2. Haga clic en Crear conexión.
3. Seleccione el tipo de autenticación Clave API.
4. Ingrese openweather_api_key como el Nombre de la conexión.
5. Ingrese x-api-key como el Nombre del encabezado.
6. Ingrese la clave de API de OpenWeather como el Valor.
7. Ingrese api.openweathermap.org como el Dominio permitido.
8. Haga clic en Guardar para crear la conexión.

Tarea 3: Crear un campo de ticket personalizado

Luego cree un campo de ticket personalizado para capturar la ubicación proporcionada por el usuario final.

Para crear el campo de ticket personalizado

1. En el Centro de administración, haga clic en Objetos y reglas en la barra lateral y luego seleccione Tickets > Campos.
2. Haga clic en Agregar campo.
3. Seleccione el tipo de campo Texto.

   

4. Ingrese Ubicación como el Nombre mostrado.
5. Bajo Permisos, seleccione Los clientes pueden editar.
6. Bajo Clientes, ingrese Ubicación como el Título mostrado a los clientes.
7. Haga clic en Guardar.

Si su cuenta usa un solo formulario de ticket, el campo nuevo aparece automáticamente en el formulario de ticket. Para eliminar el campo, consulte Editar formularios de ticket.

Tarea 4: Crear una respuesta usando el generador de flujos

Esta sección le guía a través de la creación de la respuesta, la definición de su intención y la adición de pasos para la respuesta en el generador de flujos. A continuación se describe el proceso paso a paso.

• Paso 1: Crear la respuesta
• Paso 2: Definir la intención de la respuesta
• Paso 3: Agregar un paso de mensaje inicial
• Paso 4: Solicitar una ubicación al usuario final
• Paso 5: Obtener información meteorológica para la ubicación
• Paso 6: Enviar un mensaje sobre el tiempo al usuario final
• Paso 7: Agregar un mensaje de falla
• Paso 8: Publicar el bot actualizado

Paso 1: Crear la respuesta

Use el generador de flujos para crear una respuesta para su bot de mensajería.

Para crear la respuesta

1. En el Centro de administración, haga clic en Canales en la barra lateral y luego seleccione Bots y automatización > Bots.
2. Pase el cursor por encima del bot con el cual desea trabajar y haga clic en Editar.
3. Haga clic en Crear respuesta.

Paso 2: Definir la intención de la respuesta

Defina la intención de la respuesta y las frases de capacitación. Aquí se incluyen frases y palabras que se usan para gatillar la respuesta en una conversación.

Para definir la intención de la respuesta

1. En la pestaña Respuestas de la página de edición del bot, haga clic en Crear respuesta.
2. Ingrese Obtener tiempo como la Intención de la respuesta.
3. Bajo Frases de capacitación, ingrese Obtener pronóstico del tiempo y Obtener temperatura actual.
4. Haga clic en Siguiente.

   La respuesta se abre en el generador de flujos donde puede crear la respuesta del bot.

Paso 3: Agregar un paso de mensaje inicial

Agregue un paso Enviar mensaje para solicitar al usuario final la ubicación que le interesa. Este es el primer paso en el flujo de respuesta.

Para agregar un paso de mensaje inicial

1. En el generador de flujos, haga clic en Agregar paso.
2. Bajo Elegir paso, seleccione Enviar mensaje.
3. En Mensaje de bot, ingrese el siguiente texto:

   What location would you like to get the weather for?
   
   Include the country code. For example: "Melbourne, AU" or  "San Francisco, US"

Paso 4: Solicitar una ubicación al usuario final

Después del mensaje inicial, agregue un paso Solicitar detalles para presentar un formulario básico al usuario final. El formulario incluye un cuadro de texto para el valor del campo de ticket Ubicación.

Para agregar un paso Solicitar detalles

1. En el generador de flujos, haga clic en el icono Agregar paso ().
2. Bajo Elegir paso, seleccione Solicitar detalles.
3. Ingrese Obtener ubicación como el Nombre.
4. En Campos, escriba y seleccione el campo de ticket Ubicación.

Paso 5: Obtener información meteorológica para la ubicación

Agregue un paso Hacer llamada de API para obtener la información meteorológica del extremo Current weather data de la API de OpenWeather.

Para agregar un paso Hacer llamada de API

1. En el generador de flujos, haga clic en Agregar paso.
2. Bajo Elegir paso, seleccione Hacer llamada de API.
3. Ingrese Obtener tiempo como el Nombre de la respuesta.
4. Bajo Detalles de la API, ingrese https://api.openweathermap.org/data/2.5/weather?units=metric&q= como el URL de extremo.
5. Use el icono Agregar una variable () para adjuntar la variable del campo Ubicación al valor de URL de extremo.

   El valor terminado de URL de extremo se debería ver así:

   

6. En Autenticación, seleccione la conexión openweather_api.
7. Para probar la solicitud de API, haga clic en Hacer llamada de API.
8. Bajo Datos de prueba, ingrese Melbourne, AU como la Ubicación.
9. Haga clic en Hacer llamada de API
10. Guarde las siguientes variables usando sus nombres predeterminados:
    • main > temp
    • weather > item 1 > description

Paso 6: Enviar un mensaje sobre el tiempo al usuario final

Después de obtener la información meteorológica, use un paso Enviar mensaje para enviársela al cliente.

Para agregar un mensaje de éxito de API

1. En el generador de flujos, haga clic en Agregar paso bajo la rama La llamada a la API se realizó correctamente del paso Obtener tiempo.
2. Bajo Elegir paso, seleccione Enviar mensaje.
3. En Mensaje de bot, ingrese el siguiente texto:

   It's {{temp}}° C with {{description}} in 

4. Use el icono Agregar una variable () para adjuntar la variable del campo Ubicación al valor de Mensaje de bot. Luego agregue un punto (.).

   El valor terminado de Mensaje de bot se debería ver así:

   

Paso 7: Agregar un mensaje de falla

La solicitud hecha durante el paso Hacer llamada de API puede fallar si, por ejemplo, la solicitud incluye una ubicación que no existe. Agregue un paso Enviar mensaje a la rama Error de llamada de API. Este paso devuelve un mensaje en caso de que la llamada de API de OpenWeather llegue a fallar.

Para agregar un mensaje de falla de la API

1. En el generador de flujos, haga clic en Agregar paso bajo la rama Error de llamada de API del paso Obtener tiempo.
2. Bajo Elegir paso, seleccione Enviar mensaje.
3. En Mensaje de bot, ingrese el siguiente texto:

   I'm sorry. I wasn't able to get weather data for 

4. Use el icono Agregar una variable () para adjuntar la variable del campo Ubicación al valor de Mensaje de bot. Luego agregue un punto (.).

   El valor terminado de Mensaje de bot se debería ver así:

   

Paso 8: Publicar el bot actualizado

Para hacer push de la respuesta en vivo, publique el bot actualizado.

Para publicar el bot

1. Haga clic en Terminado en la esquina superior derecha del generador de flujos.
2. En la página del bot, haga clic en Publicar bot.
3. Haga clic en Publicar.

Tarea 5: Probar los cambios

Después de publicar los cambios, puede probar la nueva respuesta haciendo la pregunta “¿Cómo está el tiempo?” en una conversación con el bot actualizado. Si desea más información sobre cómo probar los bots de mensajería, consulte Pruebas de la experiencia de mensajería del usuario final.