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

Le composant prédéfini d'état de la commande vérifie le niveau d'authentification d'un client, puis fournit des informations sur les commandes les plus récentes ou passées de l'utilisateur à un client authentifié. Ce composant utilise le composant prédéfini Retail authentication (Authentification pour le commerce) pour authentifier les utilisateurs. Le composant utilise également des générateurs pour le résumé après l'appel.

Limites

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

• Ce composant ne chiffre aucune donnée.

Exemples de dialogues

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é par téléphonie, ce qui déclenche l'intent de bienvenue par défaut et la première réponse de l'agent au début de la conversation.

Commande récente

L'utilisateur final appelle depuis un numéro non enregistré. L'agent l'authentifie, puis lui fournit des informations détaillées sur les envois de la commande. L'utilisateur confirme qu'il souhaite recevoir un SMS contenant des informations supplémentaires sur son 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 Authentification pour le commerce
	OK, John. Appelez-vous au sujet de votre dernière commande pour John Doe, contenant une lampe, une chemise et 10 autres articles, passée le 10/11/2023 à 18h ?
Oui
	Votre commande comprend deux envois, qui seront livrés d'ici le 15/01/2024. Voulez-vous en savoir plus sur ces envois ?
Oui
	Le colis 1 contenant un jean, une ceinture et deux autres articles est en cours d'acheminement et sera livré d'ici le 12/01/2024. Le colis 2 contenant une lampe, une chemise et six autres articles a été livré 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 pour suivre l'état de tous vos envois. Merci de nous avoir appelés.

Commandes 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 la commande. L'agent identifie que plusieurs commandes passées par cet utilisateur partagent les cinq mêmes derniers chiffres. Il confirme donc l'état de la commande que l'utilisateur souhaite connaître et lui fournit l'état de la commande.

Entrée utilisateur	Réponse de l'agent
	D'accord, Amber. Appelez-vous au sujet de votre commande la plus récente pour Amber Doe, contenant une lampe, une chemise et deux autres articles, passée le 10/11/2023 à 18h00 ?
Non
	Pourriez-vous m'indiquer les cinq derniers chiffres de l'ID de la commande que vous souhaitez suivre ?
12355
	Les cinq derniers chiffres de l'ID de commande que nous avons reçu sont 12355, n'est-ce pas ?
Oui, c'est exact
	Nous avons terminé de collecter l'ID de commande.
	D'après nos informations, nous avons trouvé deux commandes se terminant par les mêmes cinq chiffres : 12355. Quelle commande recherchez-vous ? La commande numéro 1 passée le 10/11/2023 à 18h00 ou la commande numéro 2 passée le 09/11/2023 à 20h00 ? Pour sélectionner la commande numéro 1, dites "1". Pour sélectionner la commande numéro 2, dites "2". Sinon, dites "Non".
Commander
	Votre commande comprend deux envois, qui seront livrés d'ici le 15/01/2024. Voulez-vous en savoir plus sur ces envois ?
Oui
	Le colis 1 contenant un jean est en cours d'acheminement et sera livré d'ici le 15/01/2024. Le colis 2 contenant une lampe, une chemise et un autre article est annulé. Souhaitez-vous recevoir un SMS contenant plus d'informations sur vos articles ?
Non, merci.
	Merci de nous avoir appelés.

Conventions d'attribution de noms

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

Fonctionnalité	Format	Exemple
Flow	[Component Name]	Order Status
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 du flux pour déterminer le comportement du composant. Les paramètres limités au flux doivent être définis sur la page de démarrage du composant. Les paramètres de portée session peuvent être définis par un flux d'appel ou sur la page de démarrage 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 le code pays, utilisé pour identifier l'utilisateur.	string
$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 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 pas de commande, la valeur de ce paramètre est null.	Liste (chaîne)
$session.params.email	(Facultatif) Adresse e-mail enregistrée avec le compte.	string
$session.params.user_first_name	(Facultatif) Prénom de l'utilisateur, utilisé pour l'accueillir et confirmer qu'il est bien le propriétaire du compte.	string
$flow.max_shipment	Spécifie le nombre d'envois affichés à l'utilisateur à la fois. La valeur par défaut est 2.	entier
$flow.tracking_status_delivered	Spécifie la valeur renvoyée par le webhook indiquant l'état de la commande livrée. La valeur par défaut est "delivered".	string
$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".	string
$flow.tracking_status_returned	Spécifie la valeur renvoyée par le webhook indiquant l'état de la commande retournée. La valeur par défaut est "returned".	string
$flow.tracking_status_partially_returned	Spécifie la valeur renvoyée par le webhook indiquant l'état de la commande partiellement retournée. La valeur par défaut est "partially returned".	string
$flow.max_retry_alternate_profile	Spécifie le nombre de tentatives autorisées lors de la demande de l'état d'une commande à partir d'un numéro de téléphone non enregistré ou d'un autre profil. La valeur par défaut est 3.	entier
$flow.max_retry_order_number	Spécifie le nombre de tentatives autorisées lors de la saisie d'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 la section 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 Compilation.
5. Cliquez sur le composant importé dans la section Flows (Flux).
6. Cliquez sur la page de démarrage dans la section Pages.
7. Cliquez sur la route true (vrai) sur la page d'accueil.
8. Dans la fenêtre "Route", modifiez les valeurs des préréglages des paramètres si nécessaire.
9. Cliquez sur Enregistrer.

Paramètres de sortie

Les paramètres de sortie sont des paramètres de session qui resteront actifs après la sortie 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, sans le code pays, utilisé pour l'identifier.	string
all_recent_order_id	Ce paramètre liste les ID de commande associés à l'utilisateur authentifié, triés par date de 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 pas de commande, la valeur de ce paramètre est null.	Liste (chaîne)
e-mail	L'adresse e-mail enregistrée avec le compte.	string
user_first_name	Prénom de l'utilisateur, utilisé pour l'accueillir et confirmer qu'il est bien le titulaire du compte.	string
transfer_reason	Ce paramètre indique la raison pour laquelle le flux s'est arrêté, s'il n'a pas abouti. La valeur renvoyée est l'une des suivantes : agent : l'utilisateur final a demandé un agent humain à un moment donné 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 nouvelles tentatives pour les événements sans entrée. Consultez Événements intégrés no-input. max_no_match : la conversation a atteint le nombre maximal de nouvelles tentatives pour les événements no-match. Consultez É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 était inaccessible. Consultez Événement intégré webhook.error.not-found.	string

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. Consultez la section "Configuration 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 auprès de vos services externes.

Authentification

Si vous n'avez pas encore configuré les services externes requis pour l'authentification, vous devrez les configurer pour permettre l'authentification des utilisateurs pour ce composant. Pour obtenir des instructions détaillées, consultez Configurer le webhook d'authentification Retail.

Obtenir les détails des commandes

Le webhook prebuilt_components_order_status:get_order_details est utilisé par le composant pour 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 de la requête API.

Nom du paramètre	Description	Format d'entrée
$flow.order_id	ID de commande pour lequel récupérer les détails.	string

Paramètres de réponse de l'API

Les paramètres suivants sont extraits de la réponse de l'API pour être 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.	string
order_time	Date et heure auxquelles la commande a été passée, au format HH:MM.	string
order_status	Indique l'état de la commande. Exemples de valeurs : "pending", "processing", "in-transit", "on-hold", "cancelled", "delivered", "returned", "partially returned".	string
order_product_name	Liste des noms de produits de la commande.	Liste (chaîne)
order_product_quantity	Nombre total de produits commandés pour chaque produit d'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.	booléen
return_eligibility_date	Liste des dates jusqu'auxquelles chaque produit de la commande peut être retourné, au format YYYY-MM-DD.	Liste (chaîne)
order_customer_billing_name	Prénom du client pour la commande.	string
order_latest_delivery_date	Date de livraison la plus tardive parmi toutes les dates de livraison estimées pour les expéditions de la commande, au format YYYY-MM-DD.	string
order_shipment_multiple	Indique si la commande contient plusieurs envois.	booléen
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 dans chaque envoi de la commande.	Liste (chaîne)
order_estimated_delivery_date	Liste des dates de livraison estimées pour chaque colis de la commande, au format YYYY-MM-DD.	Liste (chaîne)
order_shipment_status	Liste indiquant l'état de chaque envoi de la commande. Exemples de valeurs : "pending", "processing", "in-transit", "on-hold", "cancelled", "delivered", "returned", "partially returned".	Liste (chaîne)

Pour configurer le webhook "Obtenir les détails de la commande" pour ce composant, développez pour afficher 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 dans le champ URL du webhook de Dialogflow CX 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 créer le format de requête approprié pour votre webhook.
9. Examinez et mettez à jour la configuration de la réponse pour extraire des champs spécifiques de la réponse de votre webhook. Ne modifiez pas les noms des paramètres, car ils sont requis par le composant pour accéder aux valeurs de champ renvoyées.
10. Vérifiez et modifiez les paramètres d'authentification si nécessaire.
11. Cliquez sur Enregistrer.

Obtenir les commandes en double

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

Paramètres de requête API

Les paramètres suivants sont fournis par le composant en tant qu'entrées de 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 de 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 pour être 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.	booléen
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 "Get duplicate orders" (Obtenir les commandes en double) pour ce composant, développez la section 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 dans le champ URL du webhook de Dialogflow CX 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 créer le format de requête approprié pour votre webhook.
9. Examinez et mettez à jour la configuration de la réponse pour extraire des champs spécifiques de la réponse de votre webhook. Ne modifiez pas les noms des paramètres, car ils sont requis par le composant pour accéder aux valeurs de champ renvoyées.
10. Vérifiez et modifiez les paramètres d'authentification si nécessaire.
11. Cliquez sur Enregistrer.

Envoyer un SMS

Le webhook prebuilt_components_order_status:send_sms est utilisé par le composant pour 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 de 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, sans le code pays, utilisé pour l'identifier.	string
$flow.order_id	ID de commande (Order ID) pour laquelle envoyer les détails.	string

Pour configurer le webhook "Envoyer un SMS" pour ce composant, développez la section 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 dans le champ URL du webhook de Dialogflow CX 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 créer le format de requête approprié pour votre webhook.
9. Examinez et mettez à jour la configuration de la réponse pour extraire des champs spécifiques de la réponse de votre webhook. Ne modifiez pas les noms des paramètres, car ils sont requis par le composant pour accéder aux valeurs de champ renvoyées.
10. Vérifiez et modifiez les paramètres d'authentification si nécessaire.
11. Cliquez sur Enregistrer.

Activer les notifications

Le webhook prebuilt_components_order_status:enable_notification est utilisé par le composant pour 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 de 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, sans le code pays, utilisé pour l'identifier.	string
$flow.order_notification	Indique si les notifications doivent être activées pour l'utilisateur.	booléen

Pour configurer le webhook d'activation des notifications pour ce composant, développez la section 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 dans le champ URL du webhook de Dialogflow CX 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 créer le format de requête approprié pour votre webhook.
9. Examinez et mettez à jour la configuration de la réponse pour extraire des champs spécifiques de la réponse de votre webhook. Ne modifiez pas les noms des paramètres, car ils sont requis par le composant pour accéder aux valeurs de champ renvoyées.
10. Vérifiez et modifiez les paramètres d'authentification si nécessaire.
11. Cliquez sur Enregistrer.

Terminé

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