Composant prédéfini de relevé de compte

Le composant prédéfini de l'état de compte vérifie le niveau d'authentification d'un client, puis envoie l'état de compte pour une période spécifiée à un client authentifié. Si le client possède plusieurs comptes, le composant confirme le compte spécifique pour lequel le client souhaite récupérer un relevé. Ce composant utilise le composant prédéfini Authentication (Authentification) pour authentifier les utilisateurs et une version personnalisée de la collection de la date de naissance pour collecter les dates de début et de fin de la période de relevé.

Limites

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

  • Ce composant ne chiffre aucune donnée.

Exemples de boîtes de dialogue

Les exemples de boîtes de dialogue suivants illustrent les 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é via 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.

Un seul compte

L'utilisateur final dispose d'un seul compte. L'agent collecte les dates de début et de fin de l'état, et demande à l'utilisateur s'il souhaite le chiffrer. Il lui envoie ensuite l'état du compte.

Entrée utilisateur Réponse de l'agent
L'agent authentifie l'utilisateur à l'aide du composant prédéfini Authentication (Authentification).
Merci. Votre authentification a bien été effectuée.
Veuillez patienter, le temps que nous récupérions les informations de votre compte.

Nous avons trouvé un numéro de compte se terminant par 1001 associé à votre numéro.

Veuillez indiquer la date de début du relevé du compte, en commençant par le mois, suivi du jour, puis de l'année. Veuillez noter que la période de l'état de compte ne couvre que les 90 derniers jours.
L'agent collecte la date de début de l'état à l'aide du composant prédéfini Date de naissance.
Parfait. Nous avons bien noté la date de début de votre relevé.

Veuillez indiquer la date de fin du relevé, en commençant par le mois, puis le jour et l'année. Veuillez noter que la période de l'état de compte ne couvre que les 90 derniers jours.
L'agent collecte la date de fin de l'état à l'aide du composant prédéfini Date de naissance.
Merci. Veuillez confirmer que vous recherchez l'état de compte entre le 12/07/2023 et le 24/07/2023.
Oui
Veuillez patienter pendant que nous récupérons les détails de votre relevé.

Nous avons trouvé des transactions du 12/07/2023 au 24/07/2023. Souhaitez-vous le recevoir par e-mail, SMS ou WhatsApp ?
SMS
Voulez-vous chiffrer le document avant que nous le partagions avec vous ?
Non, merci
Vous recevrez le relevé dans un délai de 15 minutes sur votre téléphone mobile enregistré.

Plusieurs comptes

L'utilisateur final possède plusieurs comptes. L'agent confirme le compte pour lequel l'utilisateur demande un relevé. L'agent collecte les dates de début et de fin de l'état, et demande à l'utilisateur s'il souhaite le chiffrer. Il lui envoie ensuite l'état du compte.

Entrée utilisateur Réponse de l'agent
L'agent authentifie l'utilisateur à l'aide du composant prédéfini Authentication (Authentification).
Merci. Votre authentification a bien été effectuée.
Veuillez patienter pendant que nous récupérons les informations de votre compte.

Nous avons constaté que deux comptes étaient associés à votre numéro.

Pouvez-vous nous indiquer les quatre derniers chiffres du compte auquel vous faites référence ?
2002
Les quatre derniers chiffres du numéro de compte que nous avons reçus sont 2002. C\'est bien cela ?
oui
Veuillez indiquer la date de début du relevé du compte, en commençant par le mois, suivi du jour, puis de l'année. Veuillez noter que la période de l'état de compte ne couvre que les 90 derniers jours.
L'agent collecte la date de début de l'état à l'aide du composant prédéfini Date de naissance.
Parfait. Nous avons bien noté la date de début de votre relevé.

Veuillez indiquer la date de fin du relevé, en commençant par le mois, puis le jour et l'année. Veuillez noter que la période de l'état de compte ne couvre que les 90 derniers jours.
L'agent collecte la date de fin de l'état à l'aide du composant prédéfini Date de naissance.
Merci. Veuillez confirmer que vous recherchez le relevé de compte entre le 18/07/2023 et le 22/07/2023.
Oui
Veuillez patienter pendant que nous récupérons les détails de votre relevé.

Nous avons trouvé des transactions du 18/07/2023 au 22/07/2023. Souhaitez-vous le recevoir par e-mail, SMS ou WhatsApp ?
WhatsApp
Voulez-vous chiffrer le document avant que nous vous le fassions parvenir ?
Oui
Les informations sur le mot de passe seront partagées sur votre compte WhatsApp enregistré.

Vous recevrez le relevé dans un délai de 15 minutes sur votre compte WhatsApp enregistré.

Conventions d'attribution de noms

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

Caractéristique Format Exemple
Flux [Component Name] Relevé de compte
Intent spécifique au composant prebuilt_components_[component_name]_[intent_name] prebuilt_components_account_number_collection_four_digit_account_number
Type d'entité prebuilt_components_[component_name]_[entity_type] prebuilt_components_account_statement_channelall
Webhook prebuilt_components_[component_name]:[webhook_action] prebuilt_components_account_statement:request_statement

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 de portée de flux doivent être définis sur la page de démarrage du composant, comme décrit ci-dessous. Les paramètres de portée de 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.auth_level (Facultatif) Indique le niveau d'authentification de l'appelant. entier
$session.params.auth_level_req Indique le niveau d'authentification requis avant qu'un utilisateur puisse accéder à son relevé de compte. Cette valeur est configurée dans les préréglages de paramètres du traitement de l'entrée de page sur la page check auth level. La valeur par défaut est 1. entier
$session.params.account_auth_enabled Indique si l'utilisateur doit être authentifié en tant que titulaire de compte, comme décrit dans la section Types d'authentification. Cette valeur est configurée dans les préréglages de paramètres du traitement de l'entrée de page sur la page check auth level. La valeur par défaut est true. booléen
$session.params.card_auth_enabled Indique si l'utilisateur doit être authentifié en tant que titulaire de la carte, comme décrit dans la section Types d'authentification. Cette valeur est configurée dans les préréglages de paramètres du traitement de l'entrée de page sur la page check auth level. La valeur par défaut est false. booléen
$session.params.phone_number (Facultatif) Numéro de téléphone enregistré du client utilisé pour l'authentification. chaîne
$session.params.account_count (Facultatif) Nombre de comptes associés à l'utilisateur authentifié. entier
$session.params.last_four_digit_of_account_number (Facultatif) Quatre derniers chiffres du numéro de compte client pour lequel le relevé doit être fourni. Si le client ne possède qu'un seul compte, ces informations sont récupérées automatiquement après l'authentification. Si le client possède plusieurs comptes, le numéro de compte spécifique est collecté auprès de lui. chaîne
$session.params.account_statement_max_days Indique le nombre maximal de jours avant la date actuelle autorisé pour une date de début de relevé. Par défaut, cette valeur est -90, ce qui signifie que les dates de début des relevés ne peuvent pas être antérieures à 90 jours avant la date actuelle. Ce paramètre est configuré dans l'itinéraire true de la page de démarrage. entier
$flow.max_retry_count Spécifie le nombre de nouvelles tentatives autorisées lorsque l'utilisateur final est invité à fournir une date de fin de relevé valide. La valeur par défaut est 3. entier
$flow.max_retry_confirm_period_counter Indique le nombre de tentatives autorisées lors de la confirmation de la période de facturation avec l'utilisateur final. La valeur par défaut est 3. entier
$flow.max_retry_statement_counter Indique le nombre de nouvelles tentatives autorisées lorsque la période de relevé fournie ne permet pas de récupérer de transactions. La valeur par défaut est 3. entier

Pour configurer les paramètres d'entrée de ce composant, développez cette 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 Flux.
  6. Cliquez sur la page de démarrage dans la section Pages.
  7. Cliquez sur la route true (vraie) sur la page de démarrage.
  8. Dans la fenêtre "Itinéraire", modifiez les valeurs des préréglages de 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 restent 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
auth_level Indique le niveau d'authentification de l'appelant. entier
phone_number Numéro de téléphone local de l'utilisateur, sans code pays, utilisé pour l'identifier. chaîne
account_count Nombre de comptes associés au numéro de téléphone enregistré. Il peut s'agir de comptes personnels ou de comptes pour lesquels l'utilisateur dispose d'une procuration. entier
last_four_digit_of_account_number Si un utilisateur ne possède qu'un seul compte, les quatre derniers chiffres du numéro de compte sont renvoyés. Si un utilisateur possède plusieurs comptes, la valeur de ce paramètre correspond aux quatre derniers chiffres du numéro de compte pour lequel l'utilisateur a sélectionné de recevoir les informations de relevé. chaîne
transfer_reason Ce paramètre indique la raison de l'arrêt du flux, 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 tentatives pour les événements sans entrée. Consultez la section Événements intégrés sans entrée.

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

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

webhook_not_found: une URL de webhook était inaccessible. Voir É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. Pour en savoir plus, consultez la section "Configuration des webhooks" ci-dessous.

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 la page Configurer un webhook d'authentification.

Valider le compte

Le webhook prebuilt_components_account_services:validate_account est utilisé par le composant pour vérifier qu'un compte existe en fonction du numéro de téléphone enregistré de l'utilisateur et des quatre derniers chiffres du numéro de compte fourni. Le webhook renvoie également le solde du compte, le cas échéant.

Paramètres de requête de l'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 code pays, utilisé pour l'identifier. chaîne
$session.params.last_four_digit_of_account_number Quatre derniers chiffres du numéro de compte pour lequel l'utilisateur a sélectionné et confirmé recevoir les informations du relevé de compte. 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
account_found Indique si un compte avec les quatre derniers chiffres fournis existe pour le compte enregistré de l'utilisateur. booléen
solde Montant du solde actuel du compte, le cas échéant. Nombre

Pour configurer le webhook de validation du compte pour ce composant, développez cette 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_account_services:validate_account.
  7. Remplacez l'URL dans le champ URL du webhook des agents conversationnels (Dialogflow CX) par le point de terminaison du service avec lequel vous souhaitez vous intégrer. Sélectionnez la méthode appropriée dans le menu déroulant.
  8. Examinez et modifiez le corps de la requête pour obtenir 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 des champs renvoyées.
  10. Examinez et modifiez les paramètres Authentification si nécessaire.
  11. Cliquez sur Enregistrer.

Obtenir des transactions

Le webhook prebuilt_components_account_statement:get_transactions est utilisé par le composant pour récupérer les transactions d'un compte en fonction du numéro de téléphone enregistré de l'utilisateur, des quatre derniers chiffres du numéro de compte et de la période de relevé.

Paramètres de requête de l'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 code pays, utilisé pour l'identifier. chaîne
$session.params.last_four_digit_of_account_number Quatre derniers chiffres du numéro de compte pour lequel l'utilisateur a sélectionné et confirmé recevoir les informations du relevé de compte. chaîne
$flow.statement_start_date Date de début de l'état demandé au format AAAA-MM-JJ. chaîne
$flow.statement_end_date (facultatif) Date de début de l'état demandé au format AAAA-MM-JJ. Si l'utilisateur ne fournit aucune valeur ou refuse de fournir une date de fin, la valeur par défaut est la date actuelle. 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
transactions_count Nombre de transactions trouvées pour le compte spécifié au cours de la période de relevé donnée. entier

Pour configurer le webhook "Get transactions" (Obtenir les transactions) pour ce composant, développez cette 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_account_statement:get_transactions.
  7. Remplacez l'URL dans le champ URL du webhook des agents conversationnels (Dialogflow CX) par le point de terminaison du service avec lequel vous souhaitez vous intégrer. Sélectionnez la méthode appropriée dans le menu déroulant.
  8. Examinez et modifiez le corps de la requête pour obtenir 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 des champs renvoyées.
  10. Examinez et modifiez les paramètres Authentification si nécessaire.
  11. Cliquez sur Enregistrer.

Demander un relevé

Le webhook prebuilt_components_account_statement:request_statement est utilisé par le composant pour envoyer une facture pour un compte à un canal sélectionné en fonction du numéro de téléphone enregistré de l'utilisateur, des quatre derniers chiffres du numéro de compte et de la période de facturation.

Paramètres de requête de l'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 code pays, utilisé pour l'identifier. chaîne
$session.params.last_four_digit_of_account_number Quatre derniers chiffres du numéro de compte pour lequel l'utilisateur a sélectionné et confirmé recevoir les informations du relevé de compte. chaîne
$flow.statement_start_date Date de début de l'état demandé au format AAAA-MM-JJ. chaîne
$flow.statement_end_date (facultatif) Date de début de l'état demandé au format AAAA-MM-JJ. Si l'utilisateur ne fournit aucune valeur ou refuse de fournir une date de fin, la valeur par défaut est la date actuelle. chaîne
$flow.channel_medium Canal sur lequel l'utilisateur a sélectionné recevoir le message. Les valeurs valides sont définies par les entités personnalisées prebuilt_components_account_statement_channelphn et prebuilt_components_account_statement_channelall, selon que l'utilisateur dispose d'une adresse e-mail enregistrée. Par défaut, email, mobile et WhatsApp sont compatibles. chaîne
$flow.encryption_status Indique si l'utilisateur souhaite que le document soit chiffré avant d'être envoyé au canal spécifié. Si l'utilisateur ne fournit aucune valeur ou refuse de fournir une date de fin, la valeur par défaut est true. booléen

Pour configurer le webhook d'instruction de requête pour ce composant, développez cette 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_account_statement:request_statement.
  7. Remplacez l'URL dans le champ URL du webhook des agents conversationnels (Dialogflow CX) par le point de terminaison du service avec lequel vous souhaitez vous intégrer. Sélectionnez la méthode appropriée dans le menu déroulant.
  8. Examinez et modifiez le corps de la requête pour obtenir 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 des champs renvoyées.
  10. Examinez et modifiez les paramètres 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.