Schémas

Cette page définit les schémas à utiliser dans une intégration personnalisée d’agents virtuels. Reportez-vous toujours à CXone Swagger Un carré avec une flèche pointant du centre vers l'extérieur. pour les intégrations personnalisées d’agents virtuels, afin de vous assurer que vous utilisez la version la plus à jour du schéma.

Demande : ExternalIntegrationBotExchangeRequest

Paramètre	Type	Description
virtualAgentId	Chaîne	Le nom donné à 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 contact Le point d'entrée qu'un contact entrant utilise pour initier une interaction, tel qu'un numéro de téléphone ou une adresse e-mail. 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	Les données de télémétrie destinées à l’exécution d’une action Exécute un processus dans un script Studio, tel que la collecte de données client, la lecture d'un message ou d'une musique, ou l'acheminement d'un contact vers un agent. dans un script.
systemTelemetryData	SystemTelemetryData	Les données qui peuvent servir au débogage. Contient des informations sur l’infrastructure 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 de l’unité commerciale Regroupement organisationnel de haut niveau utilisé pour gérer le support technique, la facturation et les paramètres globaux de votre CXone environnement CXone hébergeant 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	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	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 de l’unité commerciale Regroupement organisationnel de haut niveau utilisé pour gérer le support technique, la facturation et les paramètres globaux de votre CXone environnement CXone hébergeant 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	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	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 naturel Ce processus étend le traitement du langage naturel (TAL) pour prendre des décisions ou agir en fonction de ce qu'il comprend..
nextPromptBehaviors	PromptBehaviors	Configuration pour la collecte du son et le contrôle du silence. Pour les intégrations de canal Le moyen utilisé par les contacts pour interagir avec les agents ou les robots. Le canal peut être vocal, e-mail, chat, réseaux sociaux, etc. voix uniquement.
customPayload	Objet	Peut être utilisé pour envoyer des variables personnalisées supplémentaires entre le point de terminaison et CXone. Il s’agit d’un conteneur général pour toute variable ou tout paramètre requis par le point de terminaison. Cas d’utilisation courants : Authentification, pour envoyer au point de terminaison des clés ou jetons de sécurité servant à la validation. Création de rapports personnalisés, pour inclure des mesures ou calculs personnalisés qui doivent servir à générer des KPI Une métrique établie utilisée pour mesurer les performances des agents, etc. Des informations supplémentaires sur les charges utiles personnalisées sont disponibles sur les pages d’aide de l’action Textbot Exchange et de 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 CXone conserve. Vous trouverez davantage d’informations sur ce paramètre sur la page d’aide État de session du robot.

Réponses : PromptSequence

Paramètre	Type	Description
prompts	Tableau [PromptDefinition]	Un tableau des objets PromptDefinition utilisés pour renvoyer plusieurs invites à partir du point de terminaison. Pour les interactions voix, la séquence peut être une combinaison de reconnaissance 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 Invites.

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 vocale Également appelé STT, ce processus convertit la langue parlée en texte..
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 point de terminaison afin de spécifier l’audio à lire à la prochaine étape (tout fichier audio existant dans le unité d’exploitationNICE CXone qui est accessible et de format correct).
textToSpeech	Chaîne	Peut être utilisé pour renvoyer la réponse à synthétiser par le service de synthèse vocale de CXone.

Réponse : IntentInfo

Paramètre	Type	Description
intent	Chaîne	Permet de renvoyer l’intention La signification ou le but derrière ce qu'un contact dit/tape ; ce que le contact veut communiquer ou accomplir que le composant NLU Ce processus étend le traitement du langage naturel (TAL) pour prendre des décisions ou agir en fonction de ce qu'il comprend. 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é à CXone dans la charge utile contenant la réponse de l'agent virtuel. Ce paramètre est utile pour le test et le 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

Des informations supplémentaires sur la définition des comportements d’invite dans un script Studio sont disponibles sur la page d’aide Comportements d’invite suivante.

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. Comprend des réglages 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. Des informations supplémentaires sur la définition de ces règles dans un script Studio sont disponibles sur la page d’aide Comportements d'invite suivante.

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 prévoir la lecture d’une invite à l’intention du contact du type « veuillez patienter, je recherche l’information qu’il vous faut ».
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. Des informations supplémentaires sur la définition de ces règles dans un script Studio sont disponibles sur la page d’aide Comportements d'invite suivante.

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 DTMF Tonalités de signalisation générées lorsqu'un utilisateur appuie ou appuie sur une touche de son clavier téléphonique..
bargeConfiguration	PromptBargeConfiguration	Contient les paramètres de configuration du comportement d’intervention. L’intervention permet aux contacts d’interrompre l’invite 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. Des informations supplémentaires sur la définition de ces règles dans un script Studio sont disponibles sur la page d’aide Comportements d'invite suivante.

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

L’intervention est une option que vous définissez dans les comportements d’invite. Des informations supplémentaires sur l’inclusion de cette option dans un script Studio sont disponibles sur la page d’aide Comportements d'invite suivante.

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 CXone Transcription détaillée au lieu du service de transcription par défaut de votre agent virtuel, utilisez AudioTranscriptionConfig.

Paramètre	Type	Description
transcriptionProfileId	Chaîne	Spécifie l’identifiant d’un profil de transcription existant. Si vous spécifiez un profil ici, il remplace le paramétrage de 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 prévoir la lecture d’une invite à l’intention du contact en cas d’erreur.
systemErrorMessage	Chaîne	Sert au débogage. Le message d’erreur est visible dans la fenêtre de test de la page des propriétés Custom Exchange Endpoint dans Virtual Agent Hub.