Recette pour la messagerie : obtention de données externes pour votre assistant de messagerie

L’étapeEffectuer un appel APIdu Créateur de workflow permet à un assistant de messagerie d’obtenir des données d’un système externe comme Shopify ou Salesforce.

Dans cette recette, vous créerez une réponse d’assistant pour récupérer des données météorologiques pour un lieu fourni par l’utilisateur final. La réponse obtient les données de l’API OpenWeather. Vous pouvez utiliser le workflow de réponse créé dans cette recette comme point de départ pour vos propres réponses alimentées par l’API.

La recette inclut les tâches suivantes :

Remarque –Cet article est fourni à titre informatif uniquement. Zendesk ne prend pas en charge les exemples dans cet article. Zendesk ne prend pas non plus en charge les technologies tierces, comme l’API OpenWeather.

Tâche 1 : vérification de votre configuration

Pour suivre cette recette, vous avez besoin des choses suivantes :

联合国考虑Zende亚博sk aplha de messagerie助理publié. Si vous le souhaitez, vous pouvez utiliser unenvironnement de test de type sandboxpour tester l’assistant avant de l’utiliser dans votre environnement de production.
Pour configurer un assistant de messagerie pour un canal de messagerie Web ou mobile, consultezUtilisation des assistants de messagerie pour vos canaux Web et mobiles. Pour configurer un assistant de messagerie pour un canal de messagerie sociale, consultezUtilisation du Créateur de workflow pour créer un assistant de messagerie sociale. Pour en savoir plus sur l’utilisation de la messagerie dans un environnement de sandbox, consultezUtilisation de la messagerie dans votre sandbox.
Une clé API pour un compteOpenWeather. L’API utilisée dans cette recette est disponible dans l’édition gratuite d’OpenWeather.
Pour vous inscrire pour un compte OpenWeather gratuit, rendez-vous sur la page de création d’un nouveau compte suropenweathermap.org. Une fois inscrit, vous pouvez obtenir une clé API sur lapage de votre compte OpenWeather.
Pour activer les clés API OpenWeather, vous devez vérifier l’adresse e-mail de votre compte. Après la vérification, l’activation des clés API peut prendre jusqu’à deux heures. Pour en savoir plus, consultez les FAQ suropenweathermap.org.

Tâche 2 : création de la connexion d’API

Pour commencer, créez une connexion d’API pour stocker votre clé API OpenWeather. Votre assistant de messagerie peut utiliser cette connexion pour authentifier les appels à l’API OpenWeather.

Pour créer la connexion

Dans leCentre d’administration, cliquez sur l’icôneApplications et intégrationsdans la barre latérale, puis sélectionnezConnexions > Connexions.
Cliquez surCréer une connexion.
Sélectionnez le type d’authentificationClé API.
Saisissezopenweather_api_keycommenom de connexion.
Saisissezx-api-keycommenom d’en-tête.
Saisissez votre clé API OpenWeather commevaleur.
Saisissezapi.openweathermap.orgcommedomaine autorisé.
Cliquez surEnregistrerpour créer la connexion.

Tâche 3 : création d’un champ de ticket personnalisé

Ensuite, créez un champ de ticket personnalisé pour capturer le lieu fourni par l’utilisateur final.

Pour créer le champ de ticket personnalisé

Dans leCentre d’administration, cliquez surObjets et règles() dans la barre latérale, puis sélectionnezTickets > Champs.
Cliquez surAjouter un champ.
Sélectionnez le type de champTexte.
SaisissezLieucommenom d’affichage.
SousPermissions, sélectionnezLes clients peuvent apporter des modifications.
SousClients, saisissezLieucommeTitre visible pour les clients.
Cliquez surEnregistrer.

Si votre compte utilise un seul formulaire de ticket, le nouveau champ s’affiche automatiquement dans votre formulaire de ticket. Pour savoir comment supprimer le champ, consultezModification des formulaires de ticket.

Tâche 4 : création d’une réponse avec le Créateur de workflow

Cette section vous explique comment créer la réponse, définir son intention et ajouter des étapes pour la réponse dans le Créateur de workflow. Voici les différentes étapes :

Étape 1 : création de la réponse

Utilisez le Créateur de workflow pour créer une réponse pour votre assistant de messagerie.

Pour créer la réponse

Dans leCentre d’administration, cliquez surCanaux() dans la barre latérale, puis sélectionnezAssistants et automatismes > Assistants.
Placez votre curseur sur l’assistant que vous voulez utiliser et cliquez surModifier.
Cliquez surCréer une réponse.

Étape 2 : définition de l’intention de la réponse

Définissez l’intention de la réponse et les expressions d’apprentissage. Cela inclut les expressions et les mots utilisés pour déclencher la réponse dans une conversation.

Pour définir l’intention de la réponse

Dans l’onglet Réponses de la page de modification de l’assistant, cliquez surCréer une réponse.
SaisissezObtenir la météocommeintentionde la réponse.
SousExpressions d’apprentissage, saisissezObtenir les prévisions météoetObtenir la température actuelle.
Cliquez surSuivant.
La réponse ouvre le Créateur de workflow et vous pouvez y créer la réponse de l’assistant.

Étape 3 : ajout d’un message initial

Ajoutez une étapeEnvoyer un messagepour demander un lieu à l’utilisateur final. C’est la première étape du workflow de réponse.

Pour ajouter un message initial

Dans le Créateur de workflow, cliquez surAjouter une étape.
SousChoisissez une étape, sélectionnezEnvoyer un message.

DansMessage de l’assistant, saisissez le texte suivant :

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

Étape 4 : envoi d’une demande de lieu à l’utilisateur final

Après le message initial, ajoutez une étape要求者des细节pour présenter un formulaire élémentaire à l’utilisateur final. Le formulaire inclut un champ pour la valeur de champ de ticketLieu.

Pour ajouter une étape Demander des détails

Dans le Créateur de workflow, cliquez sur l’icôneAjouter une étape().
SousChoisissez une étape, sélectionnez要求者des细节.
SaisissezObtenir le lieucommenom.
DansChamps, tapez et sélectionnez le champ de ticketLieu.

Étape 5 : obtention des données météorologiques pour le lieu

Ajoutez une étapeEffectuer un appel APIpour obtenir les données météorologiques pour le lieu à partir du point de terminaisonDonnées météo actuellesde l’API OpenWeather.

Pour ajouter une étape Effectuer un appel API

Dans le Créateur de workflow, cliquez surAjouter une étape.
SousChoisissez une étape, sélectionnezEffectuer un appel API.
SaisissezObtenir la météocommenom.
SousDétails de l’API, saisissezhttps://api.openweathermap.org/data/2.5/weather?units=metric&q=commeURL du point de terminaison.
Utilisez l’icôneAjouter une variable() pour ajouter la variable de champLieuà la valeurURL du point de terminaison.
La valeur finale de l’URL du point de terminaisondevrait ressembler à ce qui suit :
DansAuthentification, sélectionnez la connexionopenweather_api.
Pour tester la demande API, cliquez surEffectuer un appel API.
SousDonnées test, saisissezMelbourne, AUcommeLieu.
Cliquez surEffectuer un appel API.
Enregistrez les variables suivantes en utilisant leurs noms par défaut :
- main>temp
- weather>item 1>description

Étape 6 : envoi d’un message sur la météo à l’utilisateur final

Une fois que vous avez obtenu les données météo, utilisez une étapeEnvoyer un messagepour répondre avec un message contenant ces données.

Pour ajouter un message de réussite de l’API

Dans le Créateur de workflow, cliquez surAjouter une étapesous la brancheréussite de l’appel APIde l’étapeObtenir la météo.
SousChoisissez une étape, sélectionnezEnvoyer un message.
DansMessage de l’assistant, saisissez le texte suivant :
```
It's {{temp}}° C with {{description}} in
```
Utilisez l’icôneAjouter une variable() pour ajouter la variable de champLieuà la valeurMessage de l’assistant. Puis ajoutez un point (.).
La valeurMessage de l’assistantfinale devrait ressembler à ce qui suit :

Étape 7 : ajout d’un message d’échec

Il est possible que la demande faite pendant l’étapeEffectuer un appel APIéchoue. Par exemple, la demande peut inclure un lieu qui n’existe pas. Ajoutez une étapeEnvoyer un messageà la brancheÉchec de l’appel API. Cette étape renvoie un message en cas d’échec de l’appel API OpenWeather.

Pour ajouter un message d’échec de l’appel API

Dans le Créateur de workflow, cliquez surAjouter une étapesous la brancheéchec de l’appel APIde l’étapeObtenir la météo.
SousChoisissez une étape, sélectionnezEnvoyer un message.
Dans Message de l’assistant, saisissez le texte suivant :
```
I'm sorry. I wasn't able to get weather data for
```
Utilisez l’icôneAjouter une variable() pour ajouter la variable de champLieuà la valeurMessage de l’assistant. Puis ajoutez un point (.).
La valeurMessage de l’assistantfinale devrait ressembler à ce qui suit :

Étape 8 : publication de votre assistant mis à jour

Pour que la réponse soit mise à la disposition des utilisateurs, publiez l’assistant mis à jour.

Pour publier l’assistant

Cliquez surTerminéen haut à droite du Créateur de workflow.
À la page de l’assistant, cliquez surPublier l’assistant.
Cliquez surPublier.

Tâche 5 : test de vos modifications

Une fois vos modifications publiées, vous pouvez tester la nouvelle réponse en demandant « Quel temps fait-il ? » dans une conversation avec l’assistant mis à jour. Pour en savoir plus sur les tests des assistants de messagerie, consultezTest de l’expérience de messagerie des utilisateurs finaux.