Schemata

Auf dieser Seite werden die Schemata definiert, die mit der benutzerdefinierten Integration eines virtuellen Agenten verwendet werden. Stellen Sie immer anhand von CXone Swagger Ein Quadrat mit einem von der Mitte nach außen weisenden Pfeil. für benutzerdefinierte Integrationen von virtuellen Agenten sicher, dass Sie die neueste Version des Schemas verwenden.

Anfrage: ExternalIntegrationBotExchangeRequest

Parameter	Art	Beschreibung
virtualAgentId	String	Der Name der Custom Exchange Endpoint-App in Hub für virtuelle Agenten . Der Name identifiziert den virtuellen Agenten, den die App aufruft.
botConfig	Objekt	Ein Konfigurationsobjekt, das mit dem virtuellen Agenten registriert ist.
userInput	String	Die Texteingabe des Benutzers, die von der Kontaktstelle Der Eintrittspunkt, den ein eingehender Kontakt verwendet, um eine Interaktion zu initiieren, wie z. B. Telefonnummer oder E-Mail-Adresse. empfangen wird, der das Skript zugewiesen ist.
userInputType	Enumeration	Der Typ der Benutzereingabe, die vom Skript bereitgestellt wird. Mögliche Werte sind: NO_INPUT, TEXT, BASE64_ENCODED_G711_ULAW_WAV_FILE, USER_INPUT_ARCHIVED_AS_SPECIFIED, USER_ENDED_SESSION, AUTOMATED_TEXT, DTMF_AS_TEXT
executionInfo	ActionExecutionInfo	Telemetriedaten für die Ausführung einer Aktion Führt einen Prozess innerhalb eines Studio-Skripts durch, wie z. B. das Erfassen von Kundendaten, Abspielen einer Nachricht oder Musik oder die Weiterleitung eines Kontakts zu einem Agenten. in einem Skript.
systemTelemetryData	SystemTelemetryData	Daten, die für das Debugging verwendet werden können. Enthält Informationen über die CXone-Infrastruktur.
base64wavFile	String	Enthält die Base 64-kodierte WAV-Datei, die die Kopfzeile der Anfrage beinhaltet.
botSessionState	Objekt	Kann für Roundtrip-Sitzungsinformationsvariablen verwendet werden, die vom virtuellen Agenten empfangen werden.
customPayload	Objekt	Kann verwendet werden, um zusätzliche Variablen und Parameter aus dem Kontext des Studio-Skripts zu senden.
mediaType	String	Gibt den Medientyp des Skripts an, das ausgeführt wird.

Anfrage: ActionExecutionInfo

Enthält Informationen über die Aktion und das Skript, die ausgeführt werden.

Parameter	Art	Details
contactId	Ganze Zahl	Die eindeutige Kennung der Interaktion
busNo	Ganze Zahl	Die ID der CXoneGeschäftseinheit Eine übergeordnete organisatorische Gruppierung, die Sie für die technische Unterstützung und Abrechnung und außerdem zur Bearbeitung von globalen Einstellungen in Ihrer CXone Umgebung einsetzen können., in der sich das Skript befindet.
requestId	Ganze Zahl	Eine iterative Zahl, die jede Anfrage in einer bestimmten Interaktion identifiziert. Wenn Sie requestId in Anfragen einschließen, kann sie in Antworten eingeschlossen werden. Dies kann bei der Fehlerbehebung hilfreich sein. Wenn requestID ein eindeutiger Wert ist, kann dieser verwendet werden, um eine individuelle Anfrage/Antwort in Protokolldateien zu suchen.
actionType	String	Der Aktionstyp, der die Anfrage an den benutzerdefinierten Endpunkt sendet.
actionId	Ganze Zahl	Die ID der Studio-Aktion im Skript. Aktions-IDs basieren auf der Reihenfolge, in der die Aktionen dem Skript hinzugefügt wurden.
scriptName	String	Pfad und Name des Skripts, das die Anfrage sendet.

Anfrage: SystemTelemetryData

Enthält Informationen über die Aktion und das Skript, die ausgeführt werden.

Parameter	Art	Details
contactId	Ganze Zahl	Die eindeutige Kennung der Interaktion
busNo	Ganze Zahl	Die ID der CXoneGeschäftseinheit Eine übergeordnete organisatorische Gruppierung, die Sie für die technische Unterstützung und Abrechnung und außerdem zur Bearbeitung von globalen Einstellungen in Ihrer CXone Umgebung einsetzen können., in der sich das Skript befindet.
requestId	Ganze Zahl	Eine iterative Zahl, die jede Anfrage in einer bestimmten Interaktion identifiziert. Wenn Sie requestId in Anfragen einschließen, kann sie in Antworten eingeschlossen werden. Dies kann bei der Fehlerbehebung hilfreich sein. Wenn requestID ein eindeutiger Wert ist, kann dieser verwendet werden, um eine individuelle Anfrage/Antwort in Protokolldateien zu suchen.
actionType	String	Der Aktionstyp, der die Anfrage an den benutzerdefinierten Endpunkt sendet.
actionId	Ganze Zahl	Die ID der Studio-Aktion im Skript. Aktions-IDs basieren auf der Reihenfolge, in der die Aktionen dem Skript hinzugefügt wurden.
scriptName	String	Pfad und Name des Skripts, das die Anfrage sendet.

Antwort: CustomExchangeResponse_V1

Parameter	Art	Beschreibung
branchName	Enumeration	Die Verzweigung, der das Skript folgen soll. Kann die folgenden Werte enthalten: DoNotBegin, PromptAndCollectNextResponse, ReturnControlToScript, EndContact, AudioInputUntranscribeable, Error, DTMFBreakout, UserInputTimeout, UserInputNotUnderstood
nextPromptSequence	PromptSequence	Gibt die Aufforderungsreihenfolge an, die für den Kontakt wiedergegeben werden soll. Kann direkt in einer Play-Aktion verwendet werden.
intentInfo	IntentInfo	Kann verwendet werden, um die Informationen über die Absicht anzugeben, die vom Endpunkt in einer Integration mit NLU Dieser Prozess baut auf der natürlichen Sprachverarbeitung (NLP) auf, um Entscheidungen zu treffen oder Maßnahmen zu ergreifen, die auf dem basieren, was er versteht. erkannt wurde.
nextPromptBehaviors	PromptBehaviors	Konfiguration für die Audioerfassung und Steuerung der Stille. Nur für Sprach-Kanal Eine Möglichkeit für Kontakte, mit Agenten oder Bots zu interagieren. Kanäle sind zum Beispiel Sprache, E-Mail, Chat, Social Media usw.-Integrationen.
customPayload	Objekt	Kann verwendet werden, um zusätzliche benutzerdefinierte Variablen zwischen dem Endpunkt und CXone zu senden. Dies ist ein allgemeiner Container für alle Variablen oder Parameter, die der Endpunkt erfordert. Häufige Anwendungsfälle sind: Authentifizierung, um Sicherheitsschlüssel oder Tokens zur Validierung am Endpunkt zu senden. Benutzerdefinierte Berichterstattung, um benutzerdefinierte Metriken oder Berechnungen zum Generieren von KPIs Eine etablierte Metrik, die zur Messung der Agentenleistung verwendet wird einzuschließen usw. Weitere Informationen zum Einschließen von benutzerdefinierten Nutzdaten finden Sie auf den Hilfeseiten für die Textbot Exchange-Aktion und die Voicebot Exchange-Aktion. { "param1": "value1" "param2": "value2" }
errorDetails	BotErrorDetails	Konfigurationen für die Fehlerbehandlung, u. a. für Fehler im Skript.
botSessionState	Objekt	Kann verwendet werden, um Sitzungskontextvariablen zu senden, die von CXone verwaltet werden. Weitere Informationen über diesen Parameter finden Sie auf der Hilfeseite Status der Bot-Sitzung.

Antwort: PromptSequence

Parameter	Art	Beschreibung
prompts	Array [PromptDefinition]	Ein Array derPromptDefinition Objekte, das verwendet wird, um mehrere Aufforderungen vom Endpunkt zurückzugeben. Bei Sprachinteraktionen kann es sich bei der Reihenfolge um eine Kombination aus Text-to-Speech und vorab aufgezeichneten Audiodateien handeln.

Antwort: PromptDefinition

Weitere Informationen zum Definieren von Aufforderungsreihenfolgen finden Sie auf der Hilfeseite zu Aufforderungen.

Parameter	Art	Beschreibung
transcript	String	Der Antworttext des virtuellen Agenten, der dem Benutzer im Chat angezeigt wird oder von TTS Dieses Verfahren, auch STT genannt, wandelt gesprochene Sprache in Text um. synthetisiert wird.
base64EndcodedG711ulawWithWavHeader	String	Die base64-kodierte WAV-Datei für die Antwort vom Endpunkt, wenn der Endpunkt in der Antwort Audio zurückgeben kann, das beim nächsten Schritt wiedergegeben werden soll. Audioantworten müssen den µ-law G711-Codec aufweisen.
audioFilePath	String	Kann vom Endpunkt verwendet werden, um eine Audiodatei anzugeben, die in NICE CXoneBusiness Unit vorhanden ist, abgerufen werden kann und das korrekte Format aufweist, damit sie im nächsten Schritt wiedergegeben werden kann.
textToSpeech	String	Kann zur Rücksendung für die Synthetisierung durch den Text-to-Speech-Dienst von CXone verwendet werden.

Antwort: IntentInfo

Parameter	Art	Beschreibung
intent	String	Wird verwendet, um die Absicht Die Bedeutung oder der Zweck hinter dem, was ein Kontakt sagt/tippt; was der Kontakt mitteilen oder erreichen möchte zurückzusenden, die die NLU Dieser Prozess baut auf der natürlichen Sprachverarbeitung (NLP) auf, um Entscheidungen zu treffen oder Maßnahmen zu ergreifen, die auf dem basieren, was er versteht.-Komponente in der Eingabe des Kontakts identifiziert hat.
context	String	Wird verwendet, um die Kontextinformationen oder den Namen zurückzusenden, die die NLU-Komponente aktiv zur Behandlung der Absicht verwendet.
intentConfidence	String	Wird verwendet, um die Zuverlässigkeit zurückzusenden, die die NLU-Komponente für die Absicht ermittelt hat.
lastUserUtterance	String	Enthält die letzte Äußerung des Kontakts. Dieser Parameter wird durch den Proxytunnel an den virtuellen Agenten gesendet und in den Nutzdaten mit der Antwort des virtuellen Agenten an CXone zurückgegeben. Dieser Parameter eignet sich für das Testen und Debuggen.
slots	Objekt	Verwenden Sie dieses Objekt, um Informationen oder die Werte von Slots (mit der Absicht verwendete Einheiten oder Parameter) zu senden.

Antwort: PromptBehaviors

Weitere Informationen zum Definieren des Aufforderungsverhaltens in einem Studio-Skript finden Sie auf der Hilfeseite zu nächsten Aufforderungsverhaltensweisen.

Parameter	Art	Beschreibung
silenceRules	SilenceRules	Eine Konfiguration zur Steuerung einer Zeitüberschreitung für bestimmte Teile des Gesprächs.
audioCollectionRules	AudioCollectionRules	Eine Konfiguration, mit der gesteuert wird, wie Audio erfasst wird. Enthält zusätzliche Einstellungen für die DTMF-Erfassung.

Antwort: SilenceRules

Regeln für die Stille sind mehrere Parameter, die als Teil des Aufforderungsverhaltens definiert werden. Weitere Informationen zum Definieren dieser Regeln in einem Studio-Skript finden Sie auf der Hilfeseite zu nächsten Aufforderungsverhaltensweisen.

Parameter	Art	Beschreibung
engageComfortSequence	Boolescher Wert	Hiermit wird gesteuert, ob eine Aufforderung wiedergegeben wird, wenn bei der Endpunktverarbeitung eine längere Wartezeit auftreten kann, nachdem die nächste Benutzereingabe vom Kontakt erfasst wurde. Beispielsweise könnte die folgende Aufforderung für den Kontakt wiedergegeben werden: "Bitte warten Sie, während ich die Angelegenheit für Sie untersuche."
botResponseDelayTolerance	Ganze Zahl	Gibt in Millisekunden an, wie lange das Skript auf die Antwort vom Endpunkt warten soll. Wenn der Wert für die Zeitüberschreitung erreicht ist, wird die Komfortsequenz ausgelöst. Dieser Parameter wird nur verwendet, wenn engageComfortSequence auf true eingestellt ist.
comfortPromptSequence	PromptSequence	Gibt mehrere Aufforderungen über base64EndcodedG711ulawWithWavHeader, audioFilePath, textToSpeech oder transcript wieder. Dieser Parameter wird nur verwendet, wenn engageComfortSequence auf true eingestellt ist.
millisecondsToWaitForUserResponse	Ganze Zahl	Gibt in Millisekunden an, wie lange das Skript auf die Antwort des Kontakts warten soll. Wenn der Wert für die Zeitüberschreitung erreicht ist, sendet das Skript eine No_Input-Anfrage an den Endpunkt.

Antwort: AudioCollectionRules

Regeln für die Audioerfassung sind mehrere Parameter, die als Teil des Aufforderungsverhaltens definiert werden. Weitere Informationen zum Definieren dieser Regeln in einem Studio-Skript finden Sie auf der Hilfeseite zu nächsten Aufforderungsverhaltensweisen.

Parameter	Art	Beschreibung
collectionType	Enumeration	Gibt an, wie die Eingabe des Kontakts im nächsten Schritt erfasst werden soll. Mögliche Werte sind: DO_NOT_COLLECT_USER_RESPONSE, SEND_UTTERANCe_AUDIO, SEND_DTMF_ONLY_AS_TEXT
dtmfRules	CollectDtmfRules	Enthält Konfigurationseinstellungen für die Erfassung der DTMF Signaltöne, die erzeugt werden, wenn ein Benutzer eine Taste auf seiner Telefontastatur drückt oder antippt.-Töne.
bargeConfiguration	PromptBargeConfiguration	Enthält Konfigurationseinstellungen für das Verhalten beim Unterbrechen (Barge-In). Die Unterbrechungsfunktion ermöglicht es dem Kontakt, die wiedergegebene Aufforderung zu unterbrechen.

Antwort: CollectDtmfRules

Regeln für die DTMF-Erfassung sind mehrere Parameter, die als Teil des Aufforderungsverhaltens definiert werden. Weitere Informationen zum Definieren dieser Regeln in einem Studio-Skript finden Sie auf der Hilfeseite zu nächsten Aufforderungsverhaltensweisen.

Parameter	Art	Beschreibung
detectDtmf	Boolescher Wert	Steuert, ob DTMF-Töne verarbeitet und berücksichtigt werden.
clearDigits	Boolescher Wert	Steuert, ob zuvor erkannte DTMF-Töne aus dem Puffer gelöscht werden sollen.
terminationCharacters	String	Hiermit wird das Zeichen festgelegt, das der Kontakt eingeben soll, um anzugeben, dass er die Eingabe von Ziffern abgeschlossen hat. Das Rautezeichen (#) wird zum Beispiel häufig als Ende-Zeichen verwendet.
stripTerminator	Boolescher Wert	Steuert, ob die Ende-Zeichen in der gesendeten Eingabe des Kontakts verkettet werden müssen.
interDigitTimeoutMilliseconds	Ganze Zahl	Gibt in Millisekunden an, wie lange das Skript zwischen den vom Kontakt eingegebenen Ziffern warten soll.
maxDigits	Ganze Zahl	Wird verwendet, um die maximale Anzahl der zu erfassenden DTMF-Ziffern anzugeben. Wenn Sie ein Ende-Zeichen verwenden, berücksichtigen Sie es bei der Zählung der maximalen Anzahl der Ziffern.

Antwort: PromptBargeConfiguration

Die Unterbrechung (Barge) ist eine Option, die als Teil des Aufforderungsverhaltens definiert werden kann. Weitere Informationen zum Einbeziehen dieser Option in ein Studio-Skript finden Sie auf der Hilfeseite zu nächsten Aufforderungsverhaltensweisen.

Parameter	Art	Beschreibung
enableSpeakerBarge	Boolescher Wert	Hiermit wird gesteuert, ob ein Kontakt eine Aufforderung während der Wiedergabe unterbrechen kann.

Antwort: AudioTranscriptionConfig

Wenn Sie CXone Zug-um-Zug-Transkription anstelle des standardmäßigen Transkriptionsdienstes Ihres virtuellen Agenten nutzen möchten, verwenden Sie AudioTranscriptionConfig.

Parameter	Art	Beschreibung
transcriptionProfileId	String	Gibt die ID eines vorhandenen Transkriptionsprofils an. Wenn Sie hier ein Profil angeben, wird die Einstellung außer Kraft gesetzt, die Sie in der Custom Exchange Endpoint-App in Hub für virtuelle Agenten vorgenommen haben.
hintPhrases	Array	Geben Sie eine optionale Liste mit Phrasen an, die dem Transkriptionsdienst Hinweise liefern können. Beispielsweise können Sie Kontextmodelle, Produktnamen sowie häufig verwendete Namen und Phrasen verwenden.

Antwort: BotErrorDetails

Parameter	Art	Beschreibung
errorLoopBehavior	Enumeration	Hiermit wird gesteuert, wie das Skript reagiert, wenn der Endpunkt einen Fehler zurückgibt. Kann die folgenden Werte enthalten: ReturnControlToScriptThroughErrorBranch, EndContact
errorPromptSequence	PromptSequence	Hiermit wird festgelegt, dass bei einem Fehler eine Aufforderung für den Kontakt wiedergegeben wird.
systemErrorMessage	String	Wird für das Debuggen verwendet. Die Fehlermeldung wird im Testfenster auf der Eigenschaftsseite für den Custom Exchange Endpoint in Hub für virtuelle Agenten angezeigt.