El paso Hacer llamada de API permite que un bot de conversación 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.
- Tarea 1: Verificar la configuración
- Tarea 2: Crear una conexión de API
- Tarea 3: Crear un campo de ticket personalizado
- Tarea 4: Elaborar una respuesta del bot
- Tarea 5: Probar los cambios
Tarea 1: Verificar la configuración
Para completar esta receta, se necesita lo siguiente:
- Una cuenta de Zendesk con un bot de conversación publicado. Si lo desea, puede usar un entorno de pruebas de sandbox para probar el bot de conversación antes de usarlo en producción.
Para configurar un bot de conversación en un canal de mensajería por web y móvil, consulte Creación de un bot de conversación para los canales web y móvil. 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 conversación puede usar esta conexión para autenticar las llamadas a la API de OpenWeather.
- En el Centro de administración, haga clic en
Aplicaciones e integraciones en la barra lateral y luego seleccione Conexiones > Conexiones. - Haga clic en Crear conexión.
- Seleccione el tipo de autenticación Clave API.
- Ingrese openweather_api_key como el Nombre de la conexión.
- Ingrese x-api-key como el Nombre del encabezado.
- Ingrese la clave de API de OpenWeather como el Valor.
- Ingrese api.openweathermap.org como el Dominio permitido.
- 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.
- En el Centro de administración, haga clic en
Objetos y reglas en la barra lateral y luego seleccione Tickets > Campos. - Haga clic en Agregar campo.
- Seleccione el tipo de campo Texto.
- Ingrese Ubicación como el Nombre mostrado.
- Bajo Permisos, seleccione Los clientes pueden editar.
- Bajo Clientes, ingrese Ubicación como el Título mostrado a los clientes.
- 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: Elaborar una respuesta del bot
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 bots. 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
Utilice el generador de bots para crear una respuesta para su bot de conversación.
- En el Centro de administración, haga clic en
Canales en la barra lateral y luego seleccione Agentes IA y automatización > Agentes IA. - Haga clic en Administrar bots de conversación.
- Haga clic en el bot de conversación con el que desee trabajar.
- En la pestaña Respuestas, 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.
- En la pestaña Respuestas de la página de edición del bot, haga clic en Crear respuesta.
- Haga clic en Cree su propia respuesta y luego en Siguiente.
- Ingrese Obtener tiempo como la Intención de la respuesta.
- Bajo Frases de capacitación, ingrese Obtener pronóstico del tiempo y Obtener temperatura actual.
- Haga clic en Siguiente.
La respuesta se abre en el generador de bots, donde se puede desarrollar la respuesta.
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.
- En el generador de bots, haga clic en Agregar paso.
- Bajo Elegir paso, seleccione Enviar mensaje.
- 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.
- En el generador de bots, haga clic en el icono Agregar paso (
). - Bajo Elegir paso, seleccione Solicitar detalles.
- Ingrese Obtener ubicación como el Nombre.
- 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.
- En el generador de bots, haga clic en Agregar paso.
- Bajo Elegir paso, seleccione Hacer llamada de API.
- Ingrese Obtener tiempo como el Nombre de la respuesta.
- Bajo Detalles de la API, ingrese
https://api.openweathermap.org/data/2.5/weather?units=metric&q=como URL de extremo. - 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í:
- En Autenticación, seleccione la conexión openweather_api.
- Para probar la solicitud de API, haga clic en Hacer llamada de API.
- Bajo Datos de prueba, ingrese Melbourne, AU como Ubicación.
- Haga clic en Hacer llamada de API
- 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.
- En el generador de bots, haga clic en Agregar paso bajo la rama La llamada a la API se realizó correctamente del paso Obtener tiempo.
- Bajo Elegir paso, seleccione Enviar mensaje.
- En Mensaje de bot, ingrese el siguiente texto:
It's {{temp}}° C with {{description}} in - 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.
- En el generador de bots, haga clic en Agregar paso bajo la rama Error de llamada de API del paso Obtener tiempo.
- Bajo Elegir paso, seleccione Enviar mensaje.
- En Mensaje de bot, ingrese el siguiente texto:
I'm sorry. I wasn't able to get weather data for - 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.
- Haga clic en Terminado en la esquina superior derecha del generador de bots.
- En la página del bot, haga clic en Publicar bot.
- 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 conversación, consulte Pruebas de la experiencia de mensajería del usuario final.