Composant prédéfini d'état de la commande

Le composant prédéfini de l'état de la commande vérifie le niveau d'authentification d'un client, puis fournit des informations sur ses commandes passées ou les plus récentes à un client authentifié. Ce composant utilise le composant prédéfini d'authentification Retail pour authentifier les utilisateurs. Il utilise également des générateurs pour la synthèse post-appel.

Limites

En plus des limites courantes des composants prédéfinis, ce composant prédéfini présente les limites suivantes:

  • Ce composant ne chiffre aucune donnée.

Exemples de boîtes de dialogue

Les exemples de boîtes de dialogue suivants illustrent des scénarios courants gérés par ce composant prédéfini. Les exemples de boîtes de dialogue illustrent le comportement lorsque le composant est appelé à l'aide de la téléphonie, ce qui déclenche l'intent d'accueil par défaut et la première réponse de l'agent au début de la conversation.

Commande récente

Un utilisateur final passe un appel à partir d'un numéro non enregistré. L'agent authentifie l'utilisateur, puis fournit des informations détaillées sur les expéditions de la commande. L'utilisateur confirme qu'il souhaite recevoir un SMS contenant des informations supplémentaires au numéro de téléphone enregistré.

Entrée utilisateur Réponse de l'agent
L'agent authentifie l'utilisateur à l'aide du composant prédéfini d'authentification Retail
OK, John. Vous appelez-vous au sujet de votre dernière commande pour Jean Dupont contenant une lampe, une chemise et 10 autres articles passées le 10/11/2023 à 18h ?
Oui
Votre commande comporte deux envois, qui seront livrés d'ici le 15 janvier 2024.

Voulez-vous en savoir plus sur ces livraisons ?
Oui
Le colis 1, qui contient des jeans, une ceinture et deux autres articles, est en transit et sera livré d'ici le 12/01/2024.

L'expédition 2 contenant une lampe, une chemise et six autres articles a été livrée le 12/11/2023.

Souhaitez-vous recevoir un SMS contenant plus d'informations sur vos articles ?
Oui
Nous vous avons envoyé un SMS contenant un lien vous permettant de suivre l'état de toutes vos expéditions. Merci de nous avoir contactés.

Ordres en double

L'utilisateur final a déjà été authentifié. L'utilisateur demande des informations sur une commande et fournit les cinq derniers chiffres de celle-ci. L'agent identifie que plusieurs commandes passées par cet utilisateur partagent les cinq derniers chiffres. Il confirme donc la commande dont l'utilisateur souhaite connaître l'état et lui fournit l'état de la commande.

Entrée utilisateur Réponse de l'agent
OK, Amber. Vous appelez-vous au sujet de votre dernière commande d'Amber Doe contenant une lampe, une chemise et deux autres articles passées le 10/11/2023 à 18h ?
Non
Pourriez-vous fournir les cinq derniers chiffres de l'ID de commande que vous souhaitez suivre ?
12355
Les cinq derniers chiffres de notre ID de commande sont 12355. C'est bien cela ?
Oui, c'est ça
Parfait, nous avons terminé de récupérer l'ID de commande.
Selon nos informations, nous avons trouvé deux commandes se terminant par les mêmes cinq chiffres, 12355. Quelle commande recherchez-vous ?

Commande 1 passée le 10/11/2023 à 18h ou commande 2 passée le 09/11/2023 à 20h00 ?

Pour sélectionner la commande numéro 1, dites 1, et pour sélectionner la commande numéro 2, dites 2. Sinon, répondez "Non".
Commander un
Votre commande comporte deux envois, qui seront livrés d'ici le 15 janvier 2024.

Voulez-vous en savoir plus sur ces livraisons ?
Oui
La livraison 1 contenant des jeans est en transit et sera livrée d'ici le 15/01/2024.

L'expédition 2 contenant une lampe, une chemise et 1 autre article a été annulée.

Voulez-vous recevoir un SMS contenant plus d'informations sur vos articles ?
Non, c'est tout
Merci de nous avoir contactés.

Conventions de nommage

Ce composant prédéfini utilise les conventions d'attribution de noms suivantes:

Sélection Format Exemple
Flow [Nom du composant] État de la commande
Webhook prebuilt_components_[component_name]:[webhook_action] prebuilt_components_order_status:get_order_details

Paramètres d'entrée

Les paramètres d'entrée sont des paramètres utilisés pour configurer certains comportements du composant. Les paramètres seront utilisés par une ou plusieurs conditions dans le flux pour déterminer le comportement du composant. Les paramètres de portée flux doivent être définis sur la page d'accueil du composant. Les paramètres de portée session peuvent être définis par un flux d'appel ou sur la page d'accueil de ce composant.

Ce composant prédéfini accepte les paramètres d'entrée suivants:

Nom du paramètre Description Format d'entrée
$session.params.phone_number (Facultatif) Numéro de téléphone local de l'utilisateur, sans l'indicatif du pays, qui permet d'identifier l'utilisateur. chaîne
$session.params.all_recent_order_id (Facultatif) Ce paramètre liste les ID de commande associés à l'utilisateur authentifié, triés par date de placement de la commande dans l'ordre décroissant. Le premier élément du tableau représente la commande la plus récente. Si un utilisateur n'a aucune commande, la valeur de ce paramètre est null. Liste (chaîne)
$session.params.email (Facultatif) L'adresse e-mail associée au compte. chaîne
$session.params.user_first_name (Facultatif) Prénom de l'utilisateur, permettant d'accueillir et de confirmer que vous êtes le propriétaire du compte. chaîne
$flow.max_shipment Spécifie le nombre d'envois affichés simultanément à l'intention de l'utilisateur. La valeur par défaut est 2. entier
$flow.tracking_status_deliveryed Spécifie la valeur renvoyée par le webhook, indiquant l'état d'une commande livrée. La valeur par défaut est "delivered". chaîne
$flow.tracking_status_cancelled. Spécifie la valeur renvoyée par le webhook, indiquant l'état de la commande annulée. La valeur par défaut est "cancelled". chaîne
$flow.tracking_status_returned Spécifie la valeur renvoyée par le webhook, indiquant l'état d'une commande renvoyée. La valeur par défaut est "returned". chaîne
$flow.tracking_status_partially_returned Spécifie la valeur renvoyée par le webhook, indiquant un état de commande partiellement renvoyé. La valeur par défaut est "partially returned". chaîne
$flow.max_retry_alternate_profile Spécifie le nombre de tentatives autorisées lorsque vous demandez l'état de la commande à partir d'un numéro de téléphone non enregistré ou d'un profil secondaire. La valeur par défaut est 3. entier
$flow.max_retry_order_number Spécifie le nombre de tentatives autorisées lorsque vous fournissez un numéro de commande. La valeur par défaut est 3. entier
$flow.max_retry_another_order_id Spécifie le nombre de tentatives autorisées après avoir fourni un numéro de commande non valide. La valeur par défaut est 3. entier

Pour configurer les paramètres d'entrée de ce composant, développez les instructions.

  1. Ouvrez la console Dialogflow CX.
  2. Choisissez votre projet Google Cloud.
  3. Sélectionnez votre agent.
  4. Sélectionnez l'onglet Build (Compiler).
  5. Cliquez sur le composant importé dans la section Flux.
  6. Cliquez sur "Page d'accueil" dans la section Pages.
  7. Cliquez sur la route true (vraie) sur la page d'accueil.
  8. Dans la fenêtre "Route", modifiez les valeurs Parameter Presets (Préréglages) si nécessaire.
  9. Cliquez sur Enregistrer.

Paramètres de sortie

Les paramètres de sortie sont des paramètres de session qui restent actifs après la fermeture du composant. Ces paramètres contiennent des informations importantes collectées par le composant. Ce composant prédéfini fournit des valeurs pour les paramètres de sortie suivants:

Nom du paramètre Description Format de sortie
phone_number Numéro de téléphone local de l'utilisateur, qui permet d'identifier l'utilisateur, sans l'indicatif du pays. chaîne
all_recent_order_id Ce paramètre répertorie les ID de commande associés à l'utilisateur authentifié, triés en fonction de la date de la commande (ordre décroissant). Le premier élément du tableau représente la commande la plus récente. Si un utilisateur n'a aucune commande, la valeur de ce paramètre est null. Liste (chaîne)
email Adresse e-mail associée au compte. chaîne
user_first_name Prénom de l'utilisateur, permettant d'accueillir et de confirmer que le compte vous appartient. chaîne
transfer_reason Ce paramètre indique la raison pour laquelle le flux a été interrompu, en cas d'échec. La valeur renvoyée est l'une des suivantes:

agent: l'utilisateur final a demandé un agent humain à un moment donné au cours de la conversation.

denial_of_information: l'utilisateur final a refusé de partager les informations demandées par le composant.

max_no_input: la conversation a atteint le nombre maximal de tentatives pour les événements sans saisie. Consultez les événements intégrés sans entrée.

max_no_match: la conversation a atteint le nombre maximal de tentatives pour les événements sans correspondance. Consultez les événements intégrés sans correspondance.

webhook_error: une erreur de webhook s'est produite. Consultez Événement intégré webhook.error.

webhook_not_found: une URL de webhook est inaccessible. Consultez Événement intégré webhook.error.not-found.
chaîne

Configuration de base

Pour configurer ce composant prédéfini:

  1. Importez le composant prédéfini.
  2. Configurez les webhooks flexibles fournis avec une configuration décrivant vos services externes Dialogflow. Consultez la section "Configurer des webhooks".

Configuration du webhook

Pour utiliser ce composant, vous devez configurer les webhooks flexibles inclus afin de récupérer les informations nécessaires à partir de vos services externes.

Authentification

Si vous n'avez pas encore configuré les services externes requis pour l'authentification, vous devez les configurer pour activer l'authentification des utilisateurs pour ce composant. Pour obtenir des instructions détaillées, consultez Configurer le webhook d'authentification pour la vente au détail.

Obtenir les détails de la commande

Le webhook prebuilt_components_order_status:get_order_details permet au composant de récupérer les détails d'une commande spécifiée.

Paramètres de requête API

Les paramètres suivants sont fournis par le composant en tant qu'entrées dans la requête API.

Nom du paramètre Description Format d'entrée
$flow.order_id ID de commande pour lequel vous souhaitez obtenir des informations. chaîne

Paramètres de réponse de l'API

Les paramètres suivants sont extraits de la réponse de l'API et utilisés par le composant.

Nom du paramètre Description Format de sortie
order_date Date à laquelle la commande a été passée, au format YYYY-MM-DD. chaîne
order_time Heure à laquelle la commande a été passée, au format HH:MM. chaîne
order_status Indique l'état de la commande. Voici quelques exemples de valeurs : "pending", "processing", "in-transit", "on-hold", "cancelled", "delivered", "returned" et "partially returned". chaîne
order_product_name Liste des noms de produits figurant dans la commande. Liste (chaîne)
order_product_quantity Nombre total de produits commandés pour chaque produit dans une commande. entier
order_product_count Nombre de produits uniques dans une commande. entier
order_status_notification Indique si les notifications sont activées pour cette commande. boolean
return_eligibility_date Liste des dates auxquelles chaque produit de la commande peut être retourné, au format YYYY-MM-DD. Liste (chaîne)
order_customer_billing_name Prénom du nom de facturation du client pour la commande. chaîne
order_latest_delivery_date Date limite de livraison pour toutes les dates de livraison estimées pour les envois de la commande, au format YYYY-MM-DD. chaîne
order_shipment_multiple Indique si la commande contient plusieurs livraisons. boolean
order_shipment_count Nombre d'envois dans la commande. entier
order_shipment_product_count Nombre total de produits dans chaque envoi de la commande. Liste (entier)
order_shipment_product_name Liste des noms de produits présents dans chaque envoi de la commande. Liste (chaîne)
order_estimated_delivery_date Liste des dates de livraison estimées pour chaque envoi de la commande, au format YYYY-MM-DD. Liste (chaîne)
order_shipment_status Liste indiquant l'état de chaque envoi de la commande. Voici quelques exemples de valeurs : "pending", "processing", "in-transit", "on-hold", "cancelled", "delivered", "returned" et "partially returned". Liste (chaîne)

Pour configurer le webhook "Obtenir les détails de la commande" pour ce composant, développez les instructions.

  1. Ouvrez la console Dialogflow CX.
  2. Choisissez votre projet Google Cloud.
  3. Sélectionnez votre agent.
  4. Sélectionnez l'onglet Gérer.
  5. Cliquez sur Webhooks.
  6. Sélectionnez le webhook prebuilt_components_order_status:get_order_details.
  7. Remplacez l'URL indiquée dans le champ URL du webhook Dialogflow par le point de terminaison du service que vous souhaitez intégrer. Sélectionnez la méthode appropriée dans le menu déroulant.
  8. Examinez et mettez à jour le corps de la requête pour qu'il crée le format de requête approprié pour votre webhook.
  9. Examinez et mettez à jour la configuration des réponses pour extraire des champs spécifiques de la réponse du webhook. Ne modifiez pas les noms des paramètres, car le composant en a besoin pour accéder aux valeurs de champ renvoyées.
  10. Vérifiez les paramètres d'authentification et modifiez-les si nécessaire.
  11. Cliquez sur Enregistrer.

Obtenir les commandes en double

Le composant utilise le webhook prebuilt_components_retail_services:get_duplicate_order pour récupérer des informations détaillées afin de distinguer les commandes lorsque plusieurs numéros de commande ont les cinq derniers chiffres.

Paramètres de requête API

Les paramètres suivants sont fournis par le composant en tant qu'entrées dans la requête API.

Nom du paramètre Description Format d'entrée
$flow.duplicate_order_id Liste contenant les cinq derniers chiffres des numéros de commande partagés entre une ou plusieurs commandes pour l'utilisateur. Liste (chaîne)

Paramètres de réponse de l'API

Les paramètres suivants sont extraits de la réponse de l'API et utilisés par le composant.

Nom du paramètre Description Format de sortie
all_order_date Liste des dates de commande pour les commandes en double, avec les cinq derniers chiffres spécifiés au format YYYY-MM-DD. Chaque élément de ce tableau correspond au même élément du tableau all_order_time. boolean
all_order_time Liste des heures de commande pour les commandes en double, avec les cinq derniers chiffres spécifiés au format HH:MM. Chaque élément de ce tableau correspond au même élément du tableau all_order_date. Nombre

Pour configurer le webhook "Obtenir les commandes en double" pour ce composant, développez la section correspondante pour obtenir des instructions.

  1. Ouvrez la console Dialogflow CX.
  2. Choisissez votre projet Google Cloud.
  3. Sélectionnez votre agent.
  4. Sélectionnez l'onglet Gérer.
  5. Cliquez sur Webhooks.
  6. Sélectionnez le webhook prebuilt_components_retail_services:get_duplicate_order.
  7. Remplacez l'URL indiquée dans le champ URL du webhook Dialogflow par le point de terminaison du service que vous souhaitez intégrer. Sélectionnez la méthode appropriée dans le menu déroulant.
  8. Examinez et mettez à jour le corps de la requête pour qu'il crée le format de requête approprié pour votre webhook.
  9. Examinez et mettez à jour la configuration des réponses pour extraire des champs spécifiques de la réponse du webhook. Ne modifiez pas les noms des paramètres, car le composant en a besoin pour accéder aux valeurs de champ renvoyées.
  10. Vérifiez les paramètres d'authentification et modifiez-les si nécessaire.
  11. Cliquez sur Enregistrer.

Envoyer un SMS

Le webhook prebuilt_components_order_status:send_sms permet au composant d'envoyer les détails de la commande au numéro de téléphone spécifié par SMS.

Paramètres de requête API

Les paramètres suivants sont fournis par le composant en tant qu'entrées dans la requête API.

Nom du paramètre Description Format d'entrée
$session.params.phone_number Numéro de téléphone local de l'utilisateur, qui permet d'identifier l'utilisateur, sans l'indicatif du pays. chaîne
$flow.order_id ID de commande pour lequel envoyer les détails de la commande. chaîne

Pour configurer le webhook d'envoi de SMS pour ce composant, développez pour obtenir des instructions.

  1. Ouvrez la console Dialogflow CX.
  2. Choisissez votre projet Google Cloud.
  3. Sélectionnez votre agent.
  4. Sélectionnez l'onglet Gérer.
  5. Cliquez sur Webhooks.
  6. Sélectionnez le webhook prebuilt_components_order_status:send_sms.
  7. Remplacez l'URL indiquée dans le champ URL du webhook Dialogflow par le point de terminaison du service que vous souhaitez intégrer. Sélectionnez la méthode appropriée dans le menu déroulant.
  8. Examinez et mettez à jour le corps de la requête pour qu'il crée le format de requête approprié pour votre webhook.
  9. Examinez et mettez à jour la configuration des réponses pour extraire des champs spécifiques de la réponse du webhook. Ne modifiez pas les noms des paramètres, car le composant en a besoin pour accéder aux valeurs de champ renvoyées.
  10. Vérifiez les paramètres d'authentification et modifiez-les si nécessaire.
  11. Cliquez sur Enregistrer.

Activer les notifications

Le webhook prebuilt_components_order_status:enable_notification permet au composant d'activer les notifications pour le numéro de téléphone enregistré d'un utilisateur.

Paramètres de requête API

Les paramètres suivants sont fournis par le composant en tant qu'entrées dans la requête API.

Nom du paramètre Description Format d'entrée
$session.params.phone_number Numéro de téléphone local de l'utilisateur, qui permet d'identifier l'utilisateur, sans l'indicatif du pays. chaîne
$flow.order_notification Indique si les notifications doivent être activées pour l'utilisateur. boolean

Pour configurer le webhook de notifications pour ce composant, développez pour obtenir des instructions.

  1. Ouvrez la console Dialogflow CX.
  2. Choisissez votre projet Google Cloud.
  3. Sélectionnez votre agent.
  4. Sélectionnez l'onglet Gérer.
  5. Cliquez sur Webhooks.
  6. Sélectionnez le webhook prebuilt_components_order_status:enable_notification.
  7. Remplacez l'URL indiquée dans le champ URL du webhook Dialogflow par le point de terminaison du service que vous souhaitez intégrer. Sélectionnez la méthode appropriée dans le menu déroulant.
  8. Examinez et mettez à jour le corps de la requête pour qu'il crée le format de requête approprié pour votre webhook.
  9. Examinez et mettez à jour la configuration des réponses pour extraire des champs spécifiques de la réponse du webhook. Ne modifiez pas les noms des paramètres, car le composant en a besoin pour accéder aux valeurs de champ renvoyées.
  10. Vérifiez les paramètres d'authentification et modifiez-les si nécessaire.
  11. Cliquez sur Enregistrer.

Exhaustivité

Votre agent et ses webhooks doivent maintenant être configurés et prêts à être testés.