Schema's

Deze pagina bepaalt de schema's die worden gebruikt in een aangepaste integratie voor een virtuele agent. Raadpleeg altijd de CXone Swagger Een vierkant met een pijl die vanuit het midden naar buiten wijst. voor aangepaste virtuele-agentintegraties om er zeker van te zijn dat u de meest actuele versie van het schema gebruikt.

Verzoek: ExternalIntegrationBotExchangeRequest

Parameter	Type	Beschrijving
virtualAgentId	String	De naam van de Custom Exchange Endpoint-app in Virtuele Agent Hub. De naam van de virtuele agent die de app aanroept.
botConfig	Object	Een configuratieobject dat bij de virtuele agent is geregistreerd.
userInput	String	De tekstinvoer van de gebruiker die is ontvangen van het contactpunt Het toegangspunt dat een inbound contact gebruikt om een interactie te starten, zoals een telefoonnummer of e-mailadres. waaraan het script is toegewezen.
userInputType	Enum	Het door het script geleverde type gebruikersinvoer. Mogelijke waarden zijn: NO_INPUT, TEXT, BASE64_ENCODED_G711_ULAW_WAV_FILE, USER_INPUT_ARCHIVED_AS_SPECIFIED, USER_ENDED_SESSION, AUTOMATED_TEXT, DTMF_AS_TEXT.
executionInfo	ActionExecutionInfo	Telemetriegegevens voor de uitvoering van een actie Een actie voert een proces uit in een Studio-script, bijvoorbeeld om klantgegevens te verzamelen, berichten of muziek af te spelen of contacten naar een agent te routeren. binnen een script.
systemTelemetryData	SystemTelemetryData	Gegevens die kunnen worden gebruikt voor het debuggen. Bevat informatie over de CXone-infrastructuur.
base64wavFile	String	Bevat het Base 64-gecodeerde WAV-bestand met de header van het verzoek.
botSessionState	Object	Kan worden gebruikt voor round-trip sessie-informatievariabelen die worden ontvangen van de virtuele agent.
customPayload	Object	Kan worden gebruikt om extra variabelen en parameters te verzenden vanuit de context van het Studio-script.
mediaType	String	Geeft het mediatype aan van het script dat wordt uitgevoerd.

Verzoek: ActionExecutionInfo

Bevat informatie over de actie en het script dat wordt uitgevoerd.

Parameter	Type	Details
contactId	Integer	De unieke ID van de interactie.
busNo	Integer	De ID van de CXonebedrijfseenheid Een organisatorische eenheid die wordt gebruikt om technische ondersteuning, facturering en globale instellingen voor uw CXone-omgeving te beheren waar het script zich bevindt.
requestId	Integer	Een iteratief nummer dat elk verzoek in een specifieke interactie identificeert. Als u de requestId opneemt in verzoeken, kan deze ook worden opgenomen in de respons. Dit kan nuttig zijn bij het oplossen van problemen. Als requestID een unieke waarde is, kan deze worden gebruikt om een specifieke verzoeken/responsen terug te zoeken in logbestanden.
actionType	String	Het actietype dat het verzoek naar het aangepaste eindpunt verstuurt.
actionId	Integer	De ID van de Studio-actie binnen het script. Actie-ID's zijn gebaseerd op de volgorde waarin de acties aan het script zijn toegevoegd.
scriptName	String	Het pad en de naam van het script dat de aanvraag verstuurt.

Verzoek: SystemTelemetryData

Bevat informatie over de actie en het script dat wordt uitgevoerd.

Parameter	Type	Details
contactId	Integer	De unieke ID van de interactie.
busNo	Integer	De ID van de CXonebedrijfseenheid Een organisatorische eenheid die wordt gebruikt om technische ondersteuning, facturering en globale instellingen voor uw CXone-omgeving te beheren waar het script zich bevindt.
requestId	Integer	Een iteratief nummer dat elk verzoek in een specifieke interactie identificeert. Als u de requestId opneemt in verzoeken, kan deze ook worden opgenomen in de respons. Dit kan nuttig zijn bij het oplossen van problemen. Als requestID een unieke waarde is, kan deze worden gebruikt om een specifieke verzoeken/responsen terug te zoeken in logbestanden.
actionType	String	Het actietype dat het verzoek naar het aangepaste eindpunt verstuurt.
actionId	Integer	De ID van de Studio-actie binnen het script. Actie-ID's zijn gebaseerd op de volgorde waarin de acties aan het script zijn toegevoegd.
scriptName	String	Het pad en de naam van het script dat de aanvraag verstuurt.

Respons: CustomExchangeResponse_V1

Parameter	Type	Beschrijving
branchName	Enum	De vertakking die het script moet volgen. Kan de volgende waarden bevatten: DoNotBegin, PromptAndCollectNextResponse, ReturnControlToScript, EndContact, AudioInputUntranscribeable, Error, DTMFBreakout, UserInputTimeout, UserInputNotUnderstood.
nextPromptSequence	PromptSequence	De promptreeks die voor het contact moet worden afgespeeld. Kan direct in een Play-actie worden gebruikt.
intentInfo	IntentInfo	Kan worden gebruikt om informatie toe te voegen over de door het eindpunt herkende intentie in een integratie die NLU Dit proces is een uitbreiding op Natuurlijke taalverwerking (NLP) en kan beslissingen nemen of actie ondernemen op basis van wat er is begrepen. omvat.
nextPromptBehaviors	PromptBehaviors	Configuratie voor geluidsverzameling en stiltebeheer. Alleen voor integraties met spraakkanalen Een manier waarop contacten kunnen communiceren met agents of bots, zoals spraak (telefoon), e-mail, chat, social media enzovoort..
customPayload	Object	Kan worden gebruikt om extra aangepaste variabelen te verzenden tussen het eindpunt en CXone. Dit is een algemene container waar elke variabele of parameter die het eindpunt nodig heeft kan worden toegevoegd. Veelvoorkomende toepassingen zijn: Authenticatie, om beveiligingssleutels of tokens te verzenden voor validatie op het eindpunt. Aangepaste rapporten, met aangepaste metrics of berekeningen die kunnen worden gebruikt om KPI's Een metric die wordt gebruikt om de prestaties van agents te meten. en dergelijke te genereren. Meer informatie over het toevoegen van aangepaste payloads is beschikbaar op de helppagina's voor de actie Textbot Exchange en de actie Voicebot Exchange. { "param1": "value1" "param2": "value2" }
errorDetails	BotErrorDetails	Configuraties voor foutafhandeling, inclusief hoe fouten in het script worden opgevangen en afgehandeld.
botSessionState	Object	Kan worden gebruikt om sessiecontextvariabelen te versturen die CXone bijhoudt. Raadpleeg de helppagina van status botsessie voor meer informatie over deze parameter.

Respons: PromptSequence

Parameter	Type	Beschrijving
prompts	Array [PromptDefinition]	Een array van dePromptDefinition-objecten die worden gebruikt om meerdere prompts van het eindpunt terug te sturen. Bij spraakinteracties kan de reeks een combinatie zijn van tekst-naar-spraak en vooraf opgenomen audiobestanden.

Respons: PromptDefinition

Zie de helppagina Prompts voor meer informatie over het definiëren van promptreeksen.

Parameter	Type	Beschrijving
transcript	String	De responstekst van de virtuele agent die in de chat aan de gebruiker wordt getoond of door STT Ook wel STT of transcriptie genoemd: een proces om gesproken taal om te zetten in tekst. wordt gesynthetiseerd.
base64EndcodedG711ulawWithWavHeader	String	Het base64-gecodeerde WAV-bestand voor de respons van het eindpunt, indien het eindpunt in staat is om in de respons audio terug te sturen die bij de volgende beurt moet worden afgespeeld. De audiorespons moet zijn gecodeerd met de µ-law G711 codec.
audioFilePath	String	Kan door het eindpunt worden gebruikt om een willekeurig audiobestand te specificeren dat bestaat op de NICE CXonebedrijfseenheid , mits dat het toegankelijk is en de juiste indeling heeft om bij de volgende beurt te worden afgespeeld.
textToSpeech	String	Kan worden gebruikt om een string terug te sturen voor synthese door de tekst-naar-spraakservice van CXone.

Respons: IntentInfo

Parameter	Type	Beschrijving
intent	String	Hiermee kunt u de intentie De betekenis of de bedoeling van wat een klant zegt of typt; datgene wat de klant wil communiceren of bereiken. terugsturen die de NLU Dit proces is een uitbreiding op Natuurlijke taalverwerking (NLP) en kan beslissingen nemen of actie ondernemen op basis van wat er is begrepen.-component heeft geïdentificeerd in de invoerwaarde van het contact.
context	String	Hiermee kunt u de contextinformatie of de naam terugsturen die de NLU-component actief gebruikt om de intentie af te handelen.
intentConfidence	String	Hiermee kunt u het vertrouwen terugsturen dat de NLU-component heeft vastgesteld voor de intentie.
lastUserUtterance	String	Hiermee kunt u de laatste uiting van het contact vasthouden. Deze parameter wordt via de proxytunnel naar de virtuele agent gestuurd en wordt in de payload met de respons van de virtuele agents teruggestuurd naar CXone. Deze parameter is handig bij het testen en debuggen.
slots	Object	Gebruik dit object om informatie of de waarden van vakken (entiteiten of parameters die met de intentie worden gebruikt) te verzenden.

Respons: PromptBehaviors

Meer informatie over het definiëren van promptgedrag in een Studio-script is beschikbaar op de helppagina voor Volgende promptgedragingen.

Parameter	Type	Beschrijving
silenceRules	SilenceRules	Met deze optie kunt u de time-out voor specifieke onderdelen van de conversatie instellen.
audioCollectionRules	AudioCollectionRules	Met deze optie kunt u instellen hoe audio wordt verzameld. Omvat extra instellingen voor DTMF-verzameling.

Respons: SilenceRules

Stilteregels zijn onderdeel van het promptgedrag. Meer informatie over het definiëren van deze regels in een Studio-script is beschikbaar op de helppagina voor Volgende promptgedragingen.

Parameter	Type	Beschrijving
engageComfortSequence	Boolean	Hiermee kunt u bepalen of een prompt moet worden afgespeeld wanneer een significante wachttijd wordt verwacht voor de verwerking door het eindpunt na het verzamelen van de volgende gebruikersinvoer van het contact. U kunt bijvoorbeeld een prompt laten afspelen voor het contact met de tekst 'Een ogenblik geduld, ik zoek dit voor u op.'
botResponseDelayTolerance	Integer	De tijd in milliseconden dat het script moet wachten op de respons van het eindpunt. Wanneer de time-out is bereikt, wordt de comfortreeks geactiveerd. Deze parameter wordt alleen gebruikt als engageComfortSequence is ingesteld op true.
comfortPromptSequence	PromptSequence	Speelt promptreeks af via base64EndcodedG711ulawWithWavHeader, audioFilePath, textToSpeech of transcript. Deze parameter wordt alleen gebruikt als engageComfortSequence is ingesteld op true.
millisecondsToWaitForUserResponse	Integer	Hiermee bepaalt u hoe lang in milliseconden het script moet wachten tot het contact reageert. Wanneer deze time-out is bereikt, stuurt het script een No_Input-verzoek naar het eindpunt.

Respons: AudioCollectionRules

Audioverzamelregels zijn onderdeel van het promptgedrag. Meer informatie over het definiëren van deze regels in een Studio-script is beschikbaar op de helppagina voor Volgende promptgedragingen.

Parameter	Type	Beschrijving
collectionType	Enum	Hiermee bepaalt u hoe de input van het contact bij de volgende beurt moet worden verzameld. Mogelijke waarden zijn: DO_NOT_COLLECT_USER_RESPONSE, SEND_UTTERANCE_AUDIO, SEND_DTMF_ONLY_AS_TEXT
dtmfRules	CollectDtmfRules	Bevat de configuratie-instellingen voor het verzamelen van DTMF Toetstonen die worden gegenereerd wanneer iemand op een toets van de telefoon drukt of tikt.-tonen.
bargeConfiguration	PromptBargeConfiguration	Bevat de configuratie-instellingen voor het meepraatgedrag. Als Meepraten is ingeschakeld, kunnen contacten de afgespeelde prompt onderbreken.

Respons: CollectDtmfRules

DTMF-verzamelregels zijn onderdeel van het promptgedrag. Meer informatie over het definiëren van deze regels in een Studio-script is beschikbaar op de helppagina voor Volgende promptgedragingen.

Parameter	Type	Beschrijving
detectDtmf	Boolean	Bepaalt of DTMF-tonen worden verwerkt en als input worden gebruikt.
clearDigits	Boolean	Bepaalt of eerder gedetecteerde DTMF-tonen uit de buffer moeten worden gewist.
terminationCharacters	String	Hiermee bepaalt u welk teken contacten moeten invoeren om aan te geven dat ze klaar zijn met het intoetsen van cijfers. Vaak wordt het hekje (#) gebruikt als terminator.
stripTerminator	Boolean	Bepaalt of de terminatortekens moeten worden samengevoegd in de verzonden contactinvoer.
interDigitTimeoutMilliseconds	Integer	Hiermee bepaalt u hoe lang in milliseconden het script wacht tussen de cijfers die het contact invoert.
maxDigits	Integer	Hiermee bepaalt u het maximum aantal te verzamelen DTMF-cijfers. Als u een terminator gebruikt, moet u deze meetellen in het maximum aantal cijfers.

Respons: PromptBargeConfiguration

Meepraten is een optie die u kunt instellen als onderdeel van het promptgedrag. Meer informatie over deze optie in een Studio-script is beschikbaar op de helppagina voor Volgende promptgedragingen.

Parameter	Type	Beschrijving
enableSpeakerBarge	Boolean	Hiermee bepaalt u of het contact kan onderbreken terwijl er een prompt wordt afgespeeld.

Respons: AudioTranscriptionConfig

Als u CXone Turn-by-Turn Transcriptie wilt gebruiken in plaats van de standaard transcriptiedienst van uw virtuele agent, gebruik dan AudioTranscriptionConfig.

Parameter	Type	Beschrijving
transcriptionProfileId	String	De ID van een bestaand transcriptieprofiel. Als u hier een profiel opgeeft, overschrijft dit de instelling in de Custom Exchange Endpoint-app in Virtuele Agent Hub.
hintPhrases	Array	Voeg een optionele lijst met woordgroepen toe die de transcriptiedienst kunnen helpen. U kunt hier bijvoorbeeld contextmodellen, productnamen, veelgebruikte namen of woordgroepen in opnemen.

Respons: BotErrorDetails

Parameter	Type	Beschrijving
errorLoopBehavior	Enum	Hiermee kunt u bepalen wat het script doet als het eindpunt een foutmelding geeft. Kan de volgende waarden bevatten: ReturnControlToScriptThroughErrorBranch, EndContact
errorPromptSequence	PromptSequence	Hiermee kunt u een prompt laten afspelen voor het contact wanneer er een fout optreedt.
systemErrorMessage	String	Te gebruiken voor debugging. Het foutbericht is zichtbaar in het Testvenster op de pagina Eigenschappen van de Custom Exchange Endpoint-app in Virtuele Agent Hub.