Schémas

Cette page définit les schémas à utiliser dans une intégration d’agent virtuel.NiCE CXone Swagger A square with an arrow pointing from the center outward. pour les intégrations d’agent virtuel personnalisées afin de vous assurer que vous utilisez la version la plus récente du schéma.

Demande : ExternalIntegrationBotExchangeRequest

Paramètre

Type

Description

virtualAgentId Chaîne

Le nom attribué à l'application Custom Exchange Endpoint dans Virtual Agent Hub. Ce nom identifie l’agent virtuel que l’application invoque.

botConfig Objet

Un objet de configuration enregistré auprès de l’agent virtuel.

userInput Chaîne Le texte saisi par l’utilisateur, reçu du point de contactClosed The entry point that an inbound contact uses to initiate an interaction, such as a phone number or email address. auquel est assigné le script.
userInputType Énumération

Le type de saisie d’entrée utilisateur fourni par le script. Valeurs possibles : NO_INPUT, TEXT, BASE64_ENCODED_G711_ULAW_WAV_FILE, USER_INPUT_ARCHIVED_AS_SPECIFIED, USER_ENDED_SESSION, AUTOMATED_TEXT, DTMF_AS_TEXT

executionInfo ActionExecutionInfo Données de télémétrie pour l'exécution d'une actionClosed Performs a process within a Studio script, such as collecting customer data or playing music. au sein d'un script.
systemTelemetryData SystemTelemetryData Les données qui peuvent servir au débogage. Contient des informations sur l’infrastructure NiCE CXone.
base64wavFile Chaîne Contient le fichier WAV codé en base 64 qui contient l’en-tête de la demande.
botSessionState Objet Peut être utilisé pour les variables d’informations sur la session aller-retour reçues de l’agent virtuel.
customPayload Objet Peut être utilisé pour envoyer des variables et paramètres supplémentaires tirés du contexte du script Studio.
mediaType Chaîne Indique le type DE support du script en cours d’exécution.

Demande : ActionExecutionInfo

Contient des informations sur l’action et le script en cours d’exécution.

Paramètre

Type

Détails

contactId Entier L’identifiant unique de l’interaction.
busNo Entier L'id du NiCE CXoneunité commercialeClosed High-level organizational grouping used to manage technical support, billing, and global settings for your NiCE CXone system. où se trouve le script.
requestId Entier

Un numéro itératif qui identifie chaque demande dans une interaction particulière. Si vous incluez un requestId dans les demandes, il peut être inclus dans les réponses.

Cela peut être utile pour le dépannage ou la résolution de problèmes. Si requestID est une valeur unique, il peut servir à localiser une demande/réponse dans les fichiers journaux.

actionType

Chaîne de caractères

Le type d’action qui effectue la demande au point de terminaison personnalisé.
actionId

Entier

Le numéro d’identification de l’action Studio au sein du script. Les identifiants d’actions se fondent sur l’ordre dans lequel les actions ont été ajoutées au script.
scriptName

Chaîne de caractères

Le chemin et le nom du script effectuant la demande.

Demande : SystemTelemetryData

Contient des informations sur l’action et le script en cours d’exécution.

Paramètre

Type

Détails

contactId Entier L’identifiant unique de l’interaction.
busNo Entier L'id du NiCE CXoneunité commercialeClosed High-level organizational grouping used to manage technical support, billing, and global settings for your NiCE CXone system. où se trouve le script.
requestId Entier

Un numéro itératif qui identifie chaque demande dans une interaction particulière. Si vous incluez un requestId dans les demandes, il peut être inclus dans les réponses.

Cela peut être utile pour le dépannage ou la résolution de problèmes. Si requestID est une valeur unique, il peut servir à localiser une demande/réponse dans les fichiers journaux.

actionType

Chaîne de caractères

Le type d’action qui effectue la demande au point de terminaison personnalisé.
actionId

Entier

Le numéro d’identification de l’action Studio au sein du script. Les identifiants d’actions se fondent sur l’ordre dans lequel les actions ont été ajoutées au script.
scriptName

Chaîne de caractères

Le chemin et le nom du script effectuant la demande.

Réponse : CustomExchangeResponse_V1

Paramètre

Type

Description

branchName Énumération La branche que doit prendre le script. Peut contenir les valeurs suivantes : DoNotBegin, PromptAndCollectNextResponse, ReturnControlToScript, EndContact, AudioInputUntranscribeable, Error, DTMFBreakout, UserInputTimeout, UserInputNotUnderstood
nextPromptSequence PromptSequence Spécifie la séquence d’invites à lire pour le contact. Peut être utilisé directement dans une action Play.
intentInfo IntentInfo Peut être utilisé pour remplir des informations concernant l’intention reconnue par le point de terminaison dans une intégration incluant la compréhension du langage naturelClosed This process expands on Natural Language Processing (NLP) to make decisions or take action based on what it understands..
nextPromptBehaviors PromptBehaviors Configuration pour la collecte du son et le contrôle du silence. Pour les intégrations de canal voix channelClosed Various voice and digital communication mediums that facilitate customer interactions in a contact center. uniquement.
customPayload Objet

Peut être utilisé pour envoyer des variables personnalisées supplémentaires entre le terminal et NiCE CXone. Il s’agit d’un conteneur général pour toute variable ou tout paramètre requis par le point de terminaison. Les cas d'utilisation courants incluent :

  • Authentification, pour envoyer au point de terminaison des clés ou jetons de sécurité servant à la validation.
  • Rapports personnalisés, incluant des métriques personnalisées ou des calculs destinés à être utilisés pour générer des KPIClosed An established metric used to measure agent performance. et ainsi de suite.

Plus d'informations sur l'inclusion de charges utiles personnalisées sont disponibles sur les pages d'aide relatives à l'action Textbot Exchange et à l'action Voicebot Exchange.

{
	 "param1": "value1"
"param2": "value2"
}
errorDetails BotErrorDetails

Configurations destinées au traitement des erreurs, notamment pour déterminer comment signaler et traiter les erreurs dans le script.

botSessionState Objet

Peut être utilisé pour envoyer les variables de contexte de session que NiCE CXone conserve.

Vous pouvez en savoir plus sur ce paramètre sur la page d'aide Bot Session State.

Réponse : PromptSequence

Paramètre

Type

Description

prompts PromptDefinition Un tableau de PromptDefinition objets, utilisé pour renvoyer plusieurs invites depuis le terminal. Pour les interactions voix, la séquence peut être une combinaison de synthèse vocale et de fichiers audio préenregistrés.

Réponse : PromptDefinition

Pour plus d'informations sur la définition des séquences d'Invites, voir la page d'aide Prompts.

Paramètre

Type

Description

transcript Chaîne

Le texte de réponse de l'agent virtuel qui sera présenté à l’utilisateur dans le chat ou synthétisé par reconnaissance vocaleClosed Also called STT, this process converts spoken language to text..

base64EndcodedG711ulawWithWavHeader Chaîne Le fichier WAV codé en base 64 pour la réponse provenant du point de terminaison si le point de terminaison est capable de renvoyer un fichier audio dans la réponse qui doit être lue à la prochaine étape. Les réponses audio doivent suivre le codec G-711 loi µ.
audioFilePath Chaîne Peut être utilisé par le terminal pour préciser tout fichier audio existant dans le locataire NiCE CXone qui est accessible et dont le format est correct pour être lu à la prochaine étape.
textToSpeech Chaîne Peut être utilisé pour renvoyer la réponse à synthétiser par le service de synthèse vocale de NiCE CXone.
mediaSpecificObject Objet Contient le contenu média enrichi pour une interaction se déroulant sur un canalClosed Various voice and digital communication mediums that facilitate customer interactions in a contact center. textuel Digital Experience (DX).

Réponse : IntentInfo

Paramètre

Type

Description

intent Chaîne Permet de renvoyer l’intentionClosed The meaning or purpose behind what a contact says/types; what the contact wants to communicate or accomplish. que le composant NLUClosed This process expands on Natural Language Processing (NLP) to make decisions or take action based on what it understands. a identifié dans l’entrée du contact.
context Chaîne Permet de renvoyer les informations de contexte ou le nom que le composant NLU utilise actuellement pour traiter l’intention.
intentConfidence Chaîne Permet de renvoyer le niveau de confiance que le composant NLU a associé à l’intention.
lastUserUtterance Chaîne Contient le dernier énoncé du contact. Ce paramètre est envoyé à l’agent virtuel via le tunnel de proxy et renvoyé à NiCE CXone dans la charge utile contenant la réponse de l'agent virtuel. Ce paramètre est utile lors des tests et du débogage.
slots Objet Utilisez cet objet pour envoyer des informations ou des valeurs de slot (entités ou paramètres utilisés avec l’intention).

Réponse : PromptBehaviors

Plus d'informations sur la définition des comportements de Prompt dans un script Studio sont disponibles sur la page d'aide Next Prompt Behaviors.

Paramètre

Type

Description

silenceRules SilenceRules Une configuration permettant de contrôler le dépassement DE délai pour certaines parties de la conversation.
audioCollectionRules AudioCollectionRules Une configuration permettant de contrôler les modalités de collecte audio. Inclut des paramètres supplémentaires pour la collecte Dtmf.

Réponse : SilenceRules

Les règles de silence représentent un ensemble de paramètres définis dans les comportements d’invite. Plus d'informations sur la définition de ces règles dans un script Studio est disponible sur le Next Prompt Behaviors de l'aide.

Paramètre

Type

Description

engageComfortSequence Booléen Permet de déterminer si une invite doit être lue lorsque le traitement du point de terminaison est susceptible d’induire un temps d’attente important après collecte de l’entrée suivante du contact. Par exemple, vous pouvez définir un Prompt qui diffuse pour le contact le message « Veuillez patienter pendant que je recherche cette information pour vous. »
botResponseDelayTolerance Entier Spécifie le délai en millisecondes pendant lequel le script doit attendre la réponse du point de terminaison. Lorsque le délai est écoulé, la séquence de confort se déclenche. Ce paramètre est uniquement utilisé si engageComfortSequence à la valeur vrai.
comfortPromptSequence PromptSequence Lit un certain nombre d’invites par le biais de base64EndcodedG711ulawWithWavHeader, audioFilePath, textToSpeech ou transcript. Ce paramètre est uniquement utilisé si engageComfortSequence à la valeur vrai.
millisecondsToWaitForUserResponse Entier Permet de spécifier le délai en millisecondes pendant lequel le script doit attendre la réponse du contact. Lorsque le délai est écoulé, le script envoie une demande No_Input au point de terminaison.

Réponse : AudioCollectionRules

Les règles de collecte audio représentent un ensemble de paramètres définis dans les comportements d’invite. Plus d'informations sur la définition de ces règles dans un script Studio sont disponibles sur le Next Prompt Behaviors.

Paramètre

Type

Description

collectionType Énumération Permet de spécifier les modalités de collecte de l’entrée du contact à l’étape suivante. Valeurs possibles : DO_NOT_COLLECT_USER_RESPONSE, SEND_UTTERANCe_audio, SEND_DTMF_ONLY_AS_TEXT
dtmfRules CollectDtmfRules Contient les paramètres de configuration destinés à la collecte des tonalités DTMFClosed Signaling tones that are generated when a contact presses a key on the telephone keypad..
bargeConfiguration PromptBargeConfiguration Contient les paramètres de configuration pour le comportement d'intervention. L'Intervention permet aux contacts d'interrompre le Prompt en cours de lecture.

Réponse : CollectDtmfRules

Les règles de collecte DTMF représentent un ensemble de paramètres définis dans les comportements d’invite. Plus d'informations sur la définition de ces règles dans un script Studio sont disponibles sur le Next Prompt Behaviors page d'aide.

Paramètre

Type

Description

detectDtmf Booléen Détermine si les tonalités DTMF sont traitées et prises en compte.
clearDigits Booléen

Détermine si les tonalités DTMF précédemment détectées doivent être effacées du tampon.

terminationCharacters Chaîne

Permet de spécifier le caractère que le contact doit utiliser pour indiquer qu’il a terminé de saisir des chiffres. Par exemple, le signe dièse (#) est couramment utilisé comme terminateur.

stripTerminator Booléen Détermine si les caractères terminateurs doivent être concaténés dans l’entrée du contact qui est envoyée.
interDigitTimeoutMilliseconds Entier Permet de spécifier le délai d’attente en millisecondes que le script doit respecter entre les chiffres saisis par le contact.
maxDigits Entier Permet de spécifier le nombre maximal de chiffres DTMF à collecter. Si vous utilisez un terminateur, comptez-le comme un caractère lorsque vous déterminez le nombre maximal de chiffres.

Réponse : PromptBargeConfiguration

Intervention est une Option que vous pouvez définir dans le cadre des comportements du Prompt. Plus d'informations sur l'inclusion de cette Option dans un script Studio sont disponibles sur la page d'aide Next Prompt Behaviors.

Paramètre

Type

Description

enableSpeakerBarge Booléen Permet de déterminer si le contact peut intervenir pendant la lecture d’une invite.

Réponse : AudioTranscriptionConfig

Si vous souhaitez utiliser NiCE CXone Turn-by-Turn Transcription au lieu du service de transcription par défaut de votre agent virtuel, utilisez AudioTranscriptionConfig.

Paramètre

Type

Description

transcriptionProfileId Chaîne Précise l'ID d'un profil de transcription existant. Si vous précisez un profil ici, il remplace le paramètre défini dans l'application Custom Exchange Endpoint dans Virtual Agent Hub.
hintPhrases Tableau Fournit une liste facultative d’expressions pouvant apporter des indices au service de transcription. Par exemple, vous pouvez inclure des modèles de contexte, des noms de produits, des noms ou expressions couramment utilisés, etc.

Réponse : BotErrorDetails

Paramètre

Type

Description

errorLoopBehavior Énumération Permet de déterminer ce que fait le script si le point de terminaison renvoie une erreur. Peut contenir les valeurs suivantes : ReturnControlToScriptThroughErrorBranch, EndContact
errorPromptSequence PromptSequence Permet de faire jouer un Prompt à l'intention du contact en cas d'erreur d'événement.
systemErrorMessage Chaîne Sert au débogage. Le Message d’erreur est visible dans la fenêtre Test de la page des propriétés Custom Exchange Endpoints dans Virtual Agent Hub.