Le point d'accès direct (PAD) de l'API pour le chat vous permet de router automatiquement les sessions de chat entrantes vers une file d'attente en fonction de la réponse d'un point de terminaison d'API externe que vous configurez. Les utilisateurs finaux n'ont donc plus besoin de sélectionner une option dans un menu de file d'attente. Le point de terminaison peut être le vôtre ou celui d'un service tiers.
Lorsque cette fonctionnalité est activée et qu'un utilisateur final démarre une discussion, CCAI Platform envoie une requête à votre point de terminaison d'API. L'API renvoie des données de routage (paires clé/valeur) que CCAI Platform utilise pour associer l'utilisateur final à la file d'attente appropriée. Si aucune correspondance n'est trouvée, le menu de file d'attente standard s'affiche par défaut.
Le PAD de l'API fonctionne pour les éléments suivants :
Chats Web et mobiles
Chats nouveaux et repris
Avant de commencer
Par défaut, cette fonctionnalité est désactivée. Contactez l'assistance pour l'activer pour votre instance. Google Cloud
Types de PAD
Il existe deux types de PAD : la réponse de l'API et la réponse du webhook. Chaque type de PAD a un workflow différent.
Réponse de l'API
Voici le workflow de réponse de l'API :
Un utilisateur final démarre une discussion ou en reprend une.
Avant que le menu de file d'attente ne s'affiche, CCAI Platform envoie une requête à votre point de terminaison d'API, y compris tous les paramètres que vous avez définis, tels que les métadonnées de session ou les données personnalisées.
L'API renvoie une ou plusieurs paires clé/valeur.
CCAI Platform associe ces paires aux paires clé/valeur configurées dans vos files d'attente de chat. Toutes les paires doivent correspondre pour que le chat soit routé vers une file d'attente.
Si une correspondance est trouvée, l'utilisateur final est routé directement vers cette file d'attente.
Le menu de file d'attente standard s'affiche dans les cas suivants :
Aucune correspondance n'est trouvée.
L'API ne répond pas dans le délai avant expiration de la requête d'API configuré.
Réponse de webhook
Voici le workflow de réponse du webhook :
Un utilisateur final démarre une discussion ou en reprend une.
Avant que le menu de file d'attente ne s'affiche, CCAI Platform envoie une requête à votre point de terminaison d'API, y compris une URL de webhook.
L'API renvoie une réponse d'accusé de réception (HTTP 200) dans le délai avant expiration de la requête d'API.
Votre système traite la requête et envoie des données de routage (paires clé/valeur) à CCAI Platform à l'aide du webhook.
CCAI Platform associe ces paires aux paires clé/valeur configurées dans vos files d'attente de chat. Toutes les paires doivent correspondre pour que le chat soit routé vers une file d'attente.
Si une correspondance est trouvée, l'utilisateur final est routé directement vers cette file d'attente.
Le menu de file d'attente standard s'affiche dans les cas suivants :
Aucune correspondance n'est trouvée.
L'accusé de réception n'est pas reçu dans le délai avant expiration de la requête d'API.
La réponse du webhook n'est pas reçue dans le délai avant expiration du rappel de l'API.
Configurer un PAD d'API pour le chat de manière globale
Pour configurer un PAD d'API pour le chat de manière globale, procédez comme suit :
Dans le portail CCAI Platform, cliquez sur Settings > Developer Settings (Paramètres > Paramètres du développeur). Si le menu Settings (Paramètres) ne s'affiche pas, cliquez sur Menu.
Accédez au volet API Request Direct Access Point (Point d'accès direct de la requête d'API), puis cliquez sur Manage API Request Direct Access Point (Gérer le point d'accès direct de la requête d'API).
Cliquez sur l'onglet Chat.
Cliquez sur le bouton API Request Direct Access Point for Chat (Point d'accès direct de la requête d'API pour le chat) pour l'activer.
Dans le champ Direct Access Point Type (Type de point d'accès direct), sélectionnez l'un des types de PAD suivants :
API Response (Réponse de l'API) : l'API renvoie des données de routage dans sa réponse.
Webhook Response (Réponse du webhook) : l'API accuse réception de la requête, puis envoie des données de routage à un webhook.
Pour spécifier les types de chat qui déclenchent le PAD d'API, pour Chat Types, sélectionnez une ou les deux options suivantes :
New chats (Nouveaux chats)
Resumed chats (Chats repris)
Dans le champ API Request (Requête d'API), saisissez l'URL du point de terminaison de l'API à utiliser pour le PAD.
Pour configurer l'authentification, effectuez l'une des opérations suivantes :
Pour configurer l'authentification de base :
Dans le champ Authentication Method (Méthode d'authentification), sélectionnez Basic Authentication (Authentification de base).
Dans le champ Authentication Credentials (Identifiants d'authentification), saisissez votre nom d'utilisateur et votre mot de passe.
Pour configurer un en-tête personnalisé :
Dans le champ Authentication Method (Méthode d'authentification), sélectionnez Custom Header (En-tête personnalisé).
Cliquez sur Add field (Ajouter un champ). La boîte de dialogue Add Field (Ajouter un champ) s'affiche.
Saisissez une clé de champ et une valeur de champ, puis cliquez sur Save (Enregistrer).
Pour configurer le délai avant expiration de la requête d'API :
Dans le champ API Request Timeout (Délai avant expiration de la requête d'API), définissez le nombre de secondes pendant lesquelles CCAI Platform attend la réponse de l'API avant d'expirer.
Facultatif (s'affiche uniquement si vous avez sélectionné le type de PAD Webhook Response (Réponse du webhook)) : dans le champ API Callback Timeout (Délai avant expiration du rappel de l'API), définissez le nombre de secondes pendant lesquelles CCAI Platform attend les données de routage du webhook (après l'accusé de réception initial) avant d'expirer.
Pour définir la méthode de requête, sélectionnez POST ou GET dans le champ API Request Method (Méthode de requête d'API).
Pour configurer un paramètre de données :
Cliquez sur le bouton Pass Data Parameters (Transmettre les paramètres de données) pour l'activer.
Cliquez sur Add Parameter (Ajouter un paramètre). La boîte de dialogue Add Parameter (Ajouter un paramètre) s'affiche.
Effectuez l'une des opérations suivantes :
Pour configurer un paramètre de données fixe :
Dans la liste Type, cliquez sur Fixed (Fixe).
Dans le champ Destination Field (Champ de destination), saisissez la clé de destination.
Dans le champ Destination Value (Valeur de destination), saisissez la valeur de destination. Un aperçu de votre paramètre de données s'affiche dans le champ Preview (Aperçu).
Pour configurer un paramètre de données dynamique :
Dans la liste Type, cliquez sur Dynamic (Dynamique).
Effectuez l'une des opérations suivantes :
Pour configurer les métadonnées de session :
Dans la liste Source, sélectionnez Session Metadata (Métadonnées de session).
Dans la liste Incoming Field (Champ entrant), sélectionnez un type de métadonnées.
Pour configurer des données personnalisées signées :
Dans la liste Source, sélectionnez Signed Custom Data (Données personnalisées signées).
Dans la liste Incoming Field (Champ entrant), saisissez le champ entrant.
Pour configurer des données personnalisées non signées :
Dans la liste Source, sélectionnez Unsigned Custom Data (Données personnalisées non signées).
Dans la liste Incoming Field (Champ entrant), saisissez le champ entrant.
Dans le champ Destination Field (Champ de destination), saisissez le champ de destination. Un aperçu de votre paramètre de données s'affiche dans le champ Preview (Aperçu).
Cliquez sur Add Parameter (Ajouter un paramètre). Votre paramètre de données s'affiche dans la liste Data Parameters (Paramètres de données).
Facultatif : pour tester votre configuration :
Accédez à la section Test Connection (Tester la connexion). Vos paramètres de données s'affichent dans la liste.
Facultatif : pour essayer différentes valeurs de paramètres, modifiez les valeurs des paramètres dans la liste.
Cliquez sur Test this connection (Tester cette connexion).
Cliquez sur Save Chat API (Enregistrer l'API Chat).
Modifier la logique de routage
La logique de routage correspond à l'ordre dans lequel CCAI Platform essaie différents types de correspondance pour associer un chat à une file d'attente. CCAI Platform évalue chaque type de correspondance dans l'ordre et route le chat vers la première file d'attente correspondante. Si aucune correspondance n'est trouvée, le menu de file d'attente standard s'affiche.
Voici les trois types de correspondance :
Réponse de l'API : correspondance basée sur les paires clé/valeur de la réponse de l'API.
General access point label (Libellé du point d'accès général) : correspondance basée sur le libellé du point d'accès général de la file d'attente.
User segmentation (Segmentation des utilisateurs) : correspondance basée sur les données de segment d'utilisateur.
Pour modifier la logique de routage, procédez comme suit :
Dans le portail CCAI Platform, cliquez sur Settings > Developer Settings (Paramètres > Paramètres du développeur). Si le menu Settings (Paramètres) ne s'affiche pas, cliquez sur Menu.
Accédez au volet API Request Direct Access Point (Point d'accès direct de la requête d'API), puis cliquez sur Manage API Request Direct Access Point (Gérer le point d'accès direct de la requête d'API).
Cliquez sur l'onglet Chat.
Dans le champ Routing Logic (Logique de routage), pointez le curseur sur un type de correspondance et faites-le glisser vers un nouvel emplacement.
Répétez cette étape si nécessaire.
Cliquez sur Save Chat API (Enregistrer l'API Chat).
Configurer un PAD pour le chat au niveau de la file d'attente
Pour configurer un PAD pour le chat au niveau de la file d'attente, procédez comme suit :
Dans le portail CCAI Platform, cliquez sur Settings > Queue (Paramètres > File d'attente). Si le menu Settings (Paramètres) ne s'affiche pas, cliquez sur Menu. La page Queue Menu Settings (Paramètres du menu de file d'attente) s'affiche.
Selon le canal souhaité, effectuez l'une des opérations suivantes :
Dans le volet Mobile, cliquez sur Edit / View (Modifier/Afficher).
Dans le volet Web, cliquez sur Edit / View (Modifier/Afficher).
Cliquez sur la file d'attente que vous souhaitez modifier.
Dans le volet Settings (Paramètres), accédez à la section Access Point (Point d'accès).
Cliquez sur Create direct access point (Créer un point d'accès direct). La boîte de dialogue Create Direct Access Point (Créer un point d'accès direct) s'affiche.
Dans la liste Access Point Type (Type de point d'accès), cliquez sur API Response (Réponse de l'API).
Dans le champ Access Point Name (Nom du point d'accès), saisissez un nom de point d'accès.
Cliquez sur Add Key &Value (Ajouter une clé et une valeur). Saisissez une paire clé/valeur à associer à une paire clé/valeur renvoyée dans la réponse de l'API.
Répétez l'étape précédente pour ajouter d'autres paires clé/valeur.
Facultatif : dans le champ Greeting Message (Message d'accueil), saisissez le message d'accueil que vous souhaitez utiliser lorsqu'un utilisateur final est redirigé vers cette option de menu.
Cliquez sur Create (Créer). Votre PAD s'affiche dans la liste Access Point (Point d'accès).