Schémas :
Cette page définit les schémas utilisés dans une intégration personnalisée d’agent virtuel. Reportez-vous toujours au document CXone Mpower Swagger pour les intégrations d’agents virtuels personnalisées afin de vous assurer que vous utilisez la version la plus récente du schéma.
Requête : ExternalIntegrationBotExchangeRequest
Paramètre |
Type |
Description |
---|---|---|
virtualAgentId | Chaîne |
Nom donné à l’application Terminal d’échange personnalisé dans Virtual Agent Hub. Ce nom identifie l’agent virtuel que l’application invoque. |
botConfig | Objet |
Objet de configuration enregistré avec l’agent virtuel. |
userInput | Chaîne | L’entrée de texte de l’utilisateur reçue du point d’accès![]() |
userInputType | Énumération |
Le type d’entrée utilisateur fourni par le script. Les valeurs possibles sont les suivantes : 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 télémétriques pour l’exécution d’une action![]() |
systemTelemetryData | SystemTelemetryData | Données pouvant être utilisées pour le débogage. Contient des informations sur l’infrastructure CXone Mpower. |
base64wavFile | Chaîne | Contient le fichier WAV codé en base 64 qui contient l’en-tête de la requête. |
botSessionState | Objet | Peut être utilisé pour les variables d’information de session aller-retour reçues de l’agent virtuel. |
customPayload | Objet | Peut être utilisé pour envoyer des variables et des paramètres supplémentaires à partir du contexte du script Studio. |
mediaType | Chaîne | Indique le type de support du script en cours d’exécution. |
Requête : ActionExecutionInfo
Contient des informations sur l’action et le script en cours d’exécution.
Paramètre |
Type |
Détails |
---|---|---|
contactId | Nombre entier | L’identifiant unique de l’interaction. |
busNo | Nombre entier | L’ID de l’CXone Mpowerunité commerciale |
requestId | Nombre entier |
Un numéro itératif qui identifie chaque demande dans une interaction particulière. Si vous incluez le site requestId dans les demandes, il peut être inclus dans les réponses. Cela peut s’avérer utile pour le dépannage ou la résolution d’autres problèmes. Si requestID est une valeur unique, elle peut être utilisée pour localiser une requête/réponse unique dans les fichiers journaux. |
actionType |
Chaîne |
Le type d’action qui effectue la requête auprès du terminal personnalisé. |
actionId |
Nombre entier |
L’ID de l’action Studio dans le script. Les ID des actions sont basés sur l’ordre dans lequel les actions ont été ajoutées au script. |
scriptName |
Chaîne |
Le chemin d’accès et le nom du script à l’origine de la requête. |
Requête : SystemTelemetryData
Contient des informations sur l’action et le script en cours d’exécution.
Paramètre |
Type |
Détails |
---|---|---|
contactId | Nombre entier | L’identifiant unique de l’interaction. |
busNo | Nombre entier | L’ID de l’CXone Mpowerunité commerciale |
requestId | Nombre entier |
Un numéro itératif qui identifie chaque demande dans une interaction particulière. Si vous incluez le site requestId dans les demandes, il peut être inclus dans les réponses. Cela peut s’avérer utile pour le dépannage ou la résolution d’autres problèmes. Si requestID est une valeur unique, elle peut être utilisée pour localiser une requête/réponse unique dans les fichiers journaux. |
actionType |
Chaîne |
Le type d’action qui effectue la requête auprès du terminal personnalisé. |
actionId |
Nombre entier |
L’ID de l’action Studio dans le script. Les ID des actions sont basés sur l’ordre dans lequel les actions ont été ajoutées au script. |
scriptName |
Chaîne |
Le chemin d’accès et le nom du script à l’origine de la requête. |
Réponse : CustomExchangeResponse_V1
Paramètre |
Type |
Description |
---|---|---|
branchName | Énumération | La branche que le script doit suivre. Peut contenir les valeurs suivantes : DoNotBegin, PromptAndCollectNextResponse, ReturnControlToScript, EndContact, AudioInputUntranscribeable, Error, DTMFBreakout, UserInputTimeout, UserInputNotUnderstood |
nextPromptSequence | PromptSequence | Spécifie la séquence des invites à lire pour le contact. Peut être utilisé directement dans une action Play. |
intentInfo | IntentInfo | Peut être utilisé pour remplir des informations sur l’intention reconnue par le terminal dans une intégration qui inclut CLN![]() |
nextPromptBehaviors | PromptBehaviors | Configuration pour la collecte de données audio et le contrôle du silence. Pour les intégrations du canal![]() |
customPayload | Objet |
Peut être utilisé pour envoyer des variables personnalisées supplémentaires entre le terminal et CXone Mpower. Il s’agit d’un conteneur général pour toute variable ou tout paramètre requis par le terminal. Les cas d’utilisation les plus courants sont les suivants :
De plus amples informations sur l’inclusion de charges utiles personnalisées sont disponibles dans les pages d’aide de l’action Textbot Exchange et de l’action Voicebot Exchange. { "param1": "value1" } |
errorDetails | BotErrorDetails |
Configurations pour la gestion des erreurs, y compris la manière d’inviter et de gérer les erreurs dans le script. |
botSessionState | Objet |
Peut être utilisé pour envoyer des variables de contexte de session que CXone Mpower maintient. Pour en savoir plus sur ce paramètre, consultez la page d’aide État de la session bot. |
Réponse : PromptSequence
Paramètre |
Type |
Description |
---|---|---|
prompts | Tableau [PromptDefinition] | Un tableau d’objetsPromptDefinition, utilisé pour renvoyer plusieurs invites à partir du terminal. Pour les interactions vocales, la séquence peut être une combinaison de synthèse texte-parole 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 affiché à l’utilisateur dans le clavardage ou synthétisé par STT |
base64EndcodedG711ulawWithWavHeader | Chaîne | Le fichier WAV codé en base 64 pour la réponse du point d’accès, si le point d’accès est capable de renvoyer de l’audio dans la réponse qui sera lue au tour suivant. Les réponses audio doivent utiliser le codec µ-law G711. |
audioFilePath | Chaîne | Peut être utilisé par le terminal pour spécifier tout fichier audio existant dans le CXone Mpower |
textToSpeech | Chaîne | Peut être utilisé pour renvoyer un texte qui sera synthétisé par le service de synthèse texte-parole CXone Mpower. |
mediaSpecificObject | Objet | Contient le contenu multimédia enrichi pour une interaction se déroulant sur un canal![]() |
Réponse : IntentInfo
Paramètre |
Type |
Description |
---|---|---|
intent | Chaîne | À utiliser pour renvoyer l’intention![]() ![]() |
context | Chaîne | À utiliser pour renvoyer les informations contextuelles ou le nom que le composant CLN utilise activement pour traiter l’intention. |
intentConfidence | Chaîne | À utiliser pour renvoyer la confiance que le composant CLN a déterminée pour l’intention. |
lastUserUtterance | Chaîne | Permet de conserver le dernier énoncé du contact. Ce paramètre est envoyé à l’agent virtuel par l’intermédiaire du tunnel mandataire et est renvoyé à CXone Mpower dans les données utiles de la réponse de l’agent virtuel. Ce paramètre est utile lors des tests et du débogage. |
slots | Objet | Cet objet permet d’envoyer des informations ou des valeurs d’emplacements (entités ou paramètres utilisés avec l’intention). |
Réponse : PromptBehaviors
De plus amples informations sur la définition des comportements d’invite dans un script Studio sont disponibles sur la page d’aide Comportements de l’invite suivante.
Paramètre |
Type |
Description |
---|---|---|
silenceRules | SilenceRules | Une configuration permettant de contrôler le dépassement de délai pour des parties spécifiques de la conversation. |
audioCollectionRules | AudioCollectionRules | Une configuration permettant de contrôler la manière dont les données audio sont collectées. Comprend des paramètres supplémentaires pour la collecte de données DTMF. |
Réponse : SilenceRules
Les règles de silence sont un ensemble de paramètres définis dans le cadre des comportements d’invite. De plus amples informations sur la définition de ces règles dans un script Studio sont disponibles sur la page d’aide Comportements de l’invite suivante.
Paramètre |
Type |
Description |
---|---|---|
engageComfortSequence | Booléen | Permet de contrôler si une invite doit être lue lorsque le traitement du terminal risque d’avoir un temps d’attente important après la collecte de la prochaine saisie utilisateur du contact. Par exemple, vous pouvez faire en sorte qu’une invite soit lue pour le contact qui dit « Veuillez patienter pendant que je recherche cette information pour vous ». |
botResponseDelayTolerance | Nombre entier | Spécifie le temps en millisecondes pendant lequel le script doit attendre la réponse du terminal. Lorsque le dépassement de délai est atteint, la séquence de confort se déclenche. Ce paramètre n’est utilisé que si engageComfortSequence est défini sur vrai. |
comfortPromptSequence | PromptSequence | Lit un certain nombre d’invites par le biais de base64EndcodedG711ulawWithWavHeader, audioFilePath, textToSpeech ou transcript. Ce paramètre n’est utilisé que si engageComfortSequence est défini sur vrai. |
millisecondsToWaitForUserResponse | Nombre entier | Permet de spécifier la durée en millisecondes pendant laquelle le script doit attendre la réponse du contact. Lorsque ce délai est atteint, le script envoie une requête No_Input au terminal. |
Réponse : AudioCollectionRules
Les règles de collecte de données audio sont un ensemble de paramètres définis dans le cadre des comportements d’invite. De plus amples informations sur la définition de ces règles dans un script Studio sont disponibles sur la page d’aide Comportements de l’invite suivante.
Paramètre |
Type |
Description |
---|---|---|
collectionType | Énumération | À utiliser pour spécifier comment collecter la saisie du contact au tour suivant. Les valeurs possibles sont les suivantes : DO_NOT_COLLECT_USER_RESPONSE, SEND_UTTERANCe_AUDIO, SEND_DTMF_ONLY_AS_TEXT |
dtmfRules | CollectDtmfRules | Contient les paramètres de configuration pour la collecte des tonalités DTMF![]() |
bargeConfiguration | PromptBargeConfiguration | Contient les paramètres de configuration pour le comportement d’intervention. La fonction Intervention permet aux contacts d’interrompre l’invite en cours de lecture. |
Réponse : CollectDtmfRules
Les règles de collecte DTMF sont un ensemble de paramètres définis dans le cadre des comportements d’invite. De plus amples informations sur la définition de ces règles dans un script Studio sont disponibles sur la page d’aide Comportements de l’invite suivante.
Paramètre |
Type |
Description |
---|---|---|
detectDtmf | Booléen | Contrôle le traitement et l’action des tonalités DTMF. |
clearDigits | Booléen |
Contrôle si les tonalités DTMF précédemment détectées doivent être effacées de la mémoire tampon. |
terminationCharacters | Chaîne |
Utilisez cette option pour spécifier le caractère que le contact doit saisir pour indiquer qu’il a fini de saisir des numéros. Par exemple, le signe dièse (#) est couramment utilisé comme caractère de fin. |
stripTerminator | Booléen | Contrôle si les caractères de terminaison doivent être concaténés dans la saisie du contact envoyée. |
interDigitTimeoutMilliseconds | Nombre entier | Permet de spécifier la durée en millisecondes pendant laquelle le script attend entre les numéros saisis par le contact. |
maxDigits | Nombre entier | Permet de spécifier le nombre maximum de numéros DTMF à collecter. Si vous utilisez un terminateur, incluez-le parmi les caractères lorsque vous comptez le nombre maximum de numéros. |
Réponse : PromptBargeConfiguration
L’option Intervention est une option que vous pouvez définir dans le cadre des comportements d’invite. De plus amples informations sur l’inclusion de cette option dans un script Studio sont disponibles sur la page d’aide Comportements de l’invite suivante.
Paramètre |
Type |
Description |
---|---|---|
enableSpeakerBarge | Booléen | Permet de contrôler si le contact peut intervenir pendant la lecture d’une invite. |
Réponse : AudioTranscriptionConfig
Si vous souhaitez utiliser CXone Mpower 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 | Spécifie l’ID d’un profil de transcription existant. Si vous spécifiez un profil ici, il remplace le réglage effectué dans l’application Terminal d’échange personnalisé dans Virtual Agent Hub. |
hintPhrases | Tableau | Fournissez une liste facultative de phrases qui peuvent donner des indications au service de transcription. Par exemple, vous pouvez inclure des modèles de contexte, des noms de produits, des noms ou des phrases couramment utilisés, etc. |
Réponse : BotErrorDetails
Paramètre |
Type |
Description |
---|---|---|
errorLoopBehavior | Énumération | Permet de contrôler ce que fait le script si le point d’accès renvoie une erreur. Peut contenir les valeurs suivantes : ReturnControlToScriptThroughErrorBranch, EndContact |
errorPromptSequence | PromptSequence | À utiliser pour lire une invite au contact en cas d’erreur. |
systemErrorMessage | Chaîne | À utiliser pour le débogage. Le message d’erreur est visible dans la fenêtre de test dans la page de propriétés Terminal d’échange personnalisé dans Virtual Agent Hub. |