이 페이지에서는 사용자 정의 가상 상담원 통합에서 사용되는 스키마를 정의합니다. 최신 버전의 스키마를 사용하고 있는지 확인하려면 항상 사용자 정의 가상 에이전트 통합을 위한 CXone Swagger
를 참조하세요.
요청: ExternalIntegrationBotExchangeRequest
|
매개변수 |
유형 |
설명 |
|---|---|---|
| virtualAgentId | 문자열 |
가상 상담원 허브에서 사용자 정의 교환 엔드포인트 앱에 제공되는 이름입니다. 이 이름은 앱이 호출하는 가상 상담원을 식별합니다. |
| botConfig | Object |
가상 상담원에 등록된 구성 개체입니다. |
| userInput | 문자열 | 스크립트가 할당된 컨택 포인트 인바운드 컨택이 인터랙션을 개시하는 데 사용되는 진입점(예: 전화번호, 이메일 주소)입니다.에서 수신한 사용자의 텍스트 입력입니다. |
| userInputType | Enum |
스크립트에서 제공하는 사용자 입력 유형입니다. 가능한 값: NO_INPUT, TEXT, BASE64_ENCODED_G711_ULAW_WAV_FILE, USER_INPUT_ARCHIVED_AS_SPECIFIED, USER_ENDED_SESSION, AUTOMATED_TEXT, DTMF_AS_TEXT |
| executionInfo | ActionExecutionInfo | 스크립트 내에서 작업 고객 데이터 모음, 메시지 또는 음악 재생 또는 상담원에게 컨택 라우팅과 같은 Studio 스크립트 내에서 프로세스를 수행합니다.의 실행에 대한 원격 측정 데이터입니다. |
| systemTelemetryData | SystemTelemetryData | 디버깅에 사용할 수 있는 데이터입니다. CXone 인프라에 대한 정보를 포함하고 있습니다. |
| base64wavFile | 문자열 | 요청의 헤더를 포함하는 Base 64 인코딩 WAV 파일을 포함합니다. |
| botSessionState | Object | 가상 상담원으로부터 수신한 왕복 세션 정보 변수에 사용할 수 있습니다. |
| customPayload | Object | Studio 스크립트의 컨텍스트에서 추가 변수 및 매개 변수를 보내는 데 사용할 수 있습니다. |
| mediaType | 문자열 | 실행 중인 스크립트의 미디어 유형을 나타냅니다. |
요청: ActionExecutionInfo
실행 중인 작업 및 스크립트에 관한 정보를 포함합니다.
|
매개변수 |
유형 |
세부사항 |
|---|---|---|
| contactId | 정수 | 상호작용의 고유 식별자입니다. |
| busNo | 정수 | 스크립트가 위치한 CXone사업부 고급 조직 그룹화는 CXone 환경을 위해 기술 지원, 청구 및 글로벌 설정을 관리하는 데 사용됩니다.의 ID입니다. |
| requestId | 정수 |
특정 상호 작용에서 각 요청을 식별하는 반복 번호입니다. 요청에 requestId을(를) 포함하면 응답에 포함될 수 있습니다. 이는 기타 문제 해결에 도움이 될 수 있습니다. requestID이(가) 고유한 값인 경우 로그 파일에서 단일 요청/응답을 찾는 데 사용할 수 있습니다. |
| actionType |
문자열 |
사용자 정의 엔드포인트에 대한 요청을 생성하는 작업 유형입니다. |
| actionId |
정수 |
스크립트 내에서 Studio 작업의 ID 번호입니다. 작업 ID는 작업이 스크립트에 추가된 순서를 따릅니다. |
| scriptName |
문자열 |
요청을 생성하는 스크립트의 경로 및 이름입니다. |
요청: SystemTelemetryData
실행 중인 작업 및 스크립트에 관한 정보를 포함합니다.
|
매개변수 |
유형 |
세부사항 |
|---|---|---|
| contactId | 정수 | 상호작용의 고유 식별자입니다. |
| busNo | 정수 | 스크립트가 위치한 CXone사업부 고급 조직 그룹화는 CXone 환경을 위해 기술 지원, 청구 및 글로벌 설정을 관리하는 데 사용됩니다.의 ID입니다. |
| requestId | 정수 |
특정 상호 작용에서 각 요청을 식별하는 반복 번호입니다. 요청에 requestId을(를) 포함하면 응답에 포함될 수 있습니다. 이는 기타 문제 해결에 도움이 될 수 있습니다. requestID이(가) 고유한 값인 경우 로그 파일에서 단일 요청/응답을 찾는 데 사용할 수 있습니다. |
| actionType |
문자열 |
사용자 정의 엔드포인트에 대한 요청을 생성하는 작업 유형입니다. |
| actionId |
정수 |
스크립트 내에서 Studio 작업의 ID 번호입니다. 작업 ID는 작업이 스크립트에 추가된 순서를 따릅니다. |
| scriptName |
문자열 |
요청을 생성하는 스크립트의 경로 및 이름입니다. |
응답: CustomExchangeResponse_V1
|
매개변수 |
유형 |
설명 |
|---|---|---|
| branchName | Enum | 스크립트에서 사용하는 분기입니다. 포함할 수 있는 값: DoNotBegin, PromptAndCollectNextResponse, ReturnControlToScript, EndContact, AudioInputUntranscribeable, Error, DTMFBreakout, UserInputTimeout, UserInputNotUnderstood |
| nextPromptSequence | PromptSequence | 컨택에 대해 재생되는 프롬프트 시퀀스를 지정합니다. Play 작업에서 직접 사용될 수 있습니다. |
| intentInfo | IntentInfo | NLU 이해하는 내용에 따라 결정을 내리거나 작업을 수행하기 위해 자연어 처리(NLP)를 확장하는 프로세스입니다.를 포함하는 통합에서 엔드포인트가 인식하는 의도에 대한 정보를 채우는 데 사용할 수 있습니다. |
| nextPromptBehaviors | PromptBehaviors | 오디오 수집 및 침묵 제어에 대한 구성입니다. 음성 채널 컨택이 상담원이나 Bot과 인터랙션하는 방법입니다. 채널은 음성, 이메일, 채팅, 소셜 미디어 등이 될 수 있습니다. 통합에만 해당됩니다. |
| customPayload | Object |
엔드포인트와 CXone 간에 추가 사용자 정의 변수를 보내는 데 사용할 수 있습니다. 이는 엔드포인트에 필요한 모든 변수 또는 매개 변수에 대한 일반 컨테이너입니다. 공통 사용 사례:
사용자 정의 페이로드 포함에 관한 자세한 내용은 Textbot Exchange 작업 및 Voicebot Exchange 작업에 대한 도움말 페이지에서 확인할 수 있습니다. { "param1": "value1"} |
| errorDetails | BotErrorDetails |
오류 처리를 위한 구성. 스크립트에서 오류를 프롬프트 및 처리하는 방법을 포함합니다. |
| botSessionState | Object |
CXone에서 유지 관리하는 세션 컨텍스트 변수를 보내는 데 사용할 수 있습니다. 봇 세션 상태 도움말 페이지에서 이 매개변수에 대해 자세히 알아볼 수 있습니다. |
응답: PromptSequence
|
매개변수 |
유형 |
설명 |
|---|---|---|
| prompts | Array [PromptDefinition] | PromptDefinition 개체의 배열. 엔드포인트에서 여러 프롬프트를 반환하는 데 사용됩니다. 음성 상호작용의 경우 시퀀스는 텍스트 음성 변환과 미리 녹음된 오디오 파일의 조합일 수 있습니다. |
응답: PromptDefinition
프롬프트 시퀀스 정의에 대한 자세한 내용은 프롬프트 도움말 페이지를 참조하십시오.
|
매개변수 |
유형 |
설명 |
|---|---|---|
| transcript | 문자열 |
채팅에서 사용자에게 표시되거나 STT |
| base64EndcodedG711ulawWithWavHeader | 문자열 | 엔드포인트의 응답에 대한 base64 인코딩 WAV 파일입니다(엔드포인트에서 다음 차례에 재생되는 응답에서 오디오를 반환할 수 있는 경우). 오디오 응답은 µ-law G711 코덱이어야 합니다. |
| audioFilePath | 문자열 | 액세스 가능한 NICE CXone |
| textToSpeech | 문자열 | CXone 텍스트 음성 변환 서비스에서 합성하도록 다시 보내는 데 사용할 수 있습니다. |
| mediaSpecificObject | Object | Digital Experience 텍스트 기반 채널 컨택이 상담원이나 Bot과 인터랙션하는 방법입니다. 채널은 음성, 이메일, 채팅, 소셜 미디어 등이 될 수 있습니다.을 통해 발생하는 상호작용에 대한 리치 미디어 콘텐츠를 포함합니다. |
응답: IntentInfo
|
매개변수 |
유형 |
설명 |
|---|---|---|
| intent | 문자열 | NLU 이해하는 내용에 따라 결정을 내리거나 작업을 수행하기 위해 자연어 처리(NLP)를 확장하는 프로세스입니다. 구성 요소가 컨택의 입력에서 식별한 의도 컨택이 말하거나 입력하는 내용의 의미나 목적이며 컨택이 전달하고자 하는 내용이나 원하는 내용입니다.를 다시 보내는 데 사용합니다. |
| context | 문자열 | NLU 구성 요소가 의도를 처리하기 위해 적극적으로 사용하는 컨텍스트 정보 또는 이름을 다시 보내는 데 사용합니다. |
| intentConfidence | 문자열 | NLU 구성 요소가 의도에 대해 결정한 신뢰도를 다시 보내는 데 사용합니다. |
| lastUserUtterance | 문자열 | 컨택의 마지막 발화를 저장하는 데 사용합니다. 이 매개변수는 프록시 터널을 통해 가상 상담원에게 전송되고 가상 상담원의 응답과 함께 페이로드에서 CXone(으)로 반환됩니다. 이 매개변수는 테스트 및 디버깅 중 유용합니다. |
| slots | Object | 이 개체는 슬롯의 정보 또는 값(의도와 함께 사용되는 엔터티 또는 매개 변수)을 보내는 데 사용합니다 |
응답: PromptBehaviors
Studio 스크립트에서 프롬프트 동작을 정의하는 방법에 대한 자세한 내용은 다음 프롬프트 동작 도움말 페이지에서 확인할 수 있습니다.
|
매개변수 |
유형 |
설명 |
|---|---|---|
| silenceRules | SilenceRules | 대화의 특정 부분에 대한 타임아웃을 제어하도록 허용하는 구성입니다. |
| audioCollectionRules | AudioCollectionRules | 오디오 수집 방법을 제어하도록 허용하는 구성입니다. DTMF 컬렉션에 대한 추가 정보를 포함합니다. |
응답: SilenceRules
침묵 규칙은 프롬프트 동작의 일부로 정의되는 매개 변수 세트입니다. Studio 스크립트에서 이러한 규칙을 정의하는 방법에 대한 자세한 내용은 다음 프롬프트 동작 도움말 페이지에서 확인할 수 있습니다.
|
매개변수 |
유형 |
설명 |
|---|---|---|
| engageComfortSequence | 부울 | 컨택으로부터 다음 사용자 입력을 수집한 이후 엔드포인트 처리에 대기 시간이 충분한 경우 프롬프트를 재생할지 여부를 제어하는 데 사용합니다. 예를 들어, 컨택에게 "살펴보는 동안 잠시 기다려 주세요."라고 말하는 프롬프트 재생이 있을 수 있습니다. |
| botResponseDelayTolerance | Integer | 스크립트가 엔드포인트 응답을 대기해야 하는 시간을 밀리초 단위로 지정합니다. 타임아웃에 도달하면 컴포트 시퀀스가 트리거됩니다. 이 매개 변수는 engageComfortSequence이(가) true로 설정된 경우에만 사용됩니다. |
| comfortPromptSequence | PromptSequence | base64EndcodedG711ulawWithWavHeader, audioFilePath, textToSpeech 또는 transcript을(를) 통해 여러 프롬프트를 재생합니다. 이 매개 변수는 engageComfortSequence이(가) true로 설정된 경우에만 사용됩니다. |
| millisecondsToWaitForUserResponse | 정수 | 컨택이 응답할 때까지 스크립트가 대기해야 하는 시간을 밀리초 단위로 지정하는 데 사용합니다. 이 타임아웃에 도달하면 스크립트가 엔드포인트에 No_Input 요청을 보냅니다. |
응답: AudioCollectionRules
오디오 수집 규칙은 프롬프트 동작의 일부로 정의되는 매개 변수 세트입니다. Studio 스크립트에서 이러한 규칙을 정의하는 방법에 대한 자세한 내용은 다음 프롬프트 동작 도움말 페이지에서 확인할 수 있습니다.
|
매개변수 |
유형 |
설명 |
|---|---|---|
| collectionType | Enum | 다음 차례에 컨택의 입력을 수집하는 방법을 지정하는 데 사용합니다. 가능한 값: DO_NOT_COLLECT_USER_RESPONSE, SEND_UTTERANCe_AUDIO, SEND_DTMF_ONLY_AS_TEXT |
| dtmfRules | CollectDtmfRules | DTMF 사용자가 전화 키패드의 키를 누르거나 탭할 때 발생하는 신호화 톤입니다. 톤 수집을 위한 구성 설정을 보관합니다. |
| bargeConfiguration | PromptBargeConfiguration | 개입 행동에 대한 구성 설정을 보관합니다. 개입은 컨택이 재생 중인 프롬프트를 중단하도록 허용합니다. |
응답: CollectDtmfRules
DTMF 수집 규칙은 프롬프트 동작의 일부로 정의되는 매개 변수 세트입니다. Studio 스크립트에서 이러한 규칙을 정의하는 방법에 대한 자세한 내용은 다음 프롬프트 동작 도움말 페이지에서 확인할 수 있습니다.
|
매개변수 |
유형 |
설명 |
|---|---|---|
| detectDtmf | 부울 | DTMF 톤이 처리되어 조치를 취할지 여부를 제어합니다. |
| clearDigits | 부울 |
이전에 감지한 DTMF 톤을 버퍼에서 지워야 하는지 여부를 제어합니다. |
| terminationCharacters | 문자열 |
컨택이 숫자 입력을 완료했음을 나타낼 수 있도록 입력할 문자를 지정하는 데 사용합니다. 예를 들어, 파운드 기호(#)는 일반적으로 종결자로 사용됩니다. |
| stripTerminator | 부울 | 전송되는 컨택 입력에 마침 표시 문자를 연결해야 하는지 여부를 제어합니다. |
| interDigitTimeoutMilliseconds | 정수 | 컨택이 입력하는 숫자 간에 스크립트가 대기하는 시간을 밀리초 단위로 지정하는 데 사용합니다. |
| maxDigits | 정수 | 수집할 DTMF 숫자의 최대 수를 지정하는 데 사용합니다. 마침 표시를 사용하는 경우 숫자의 최대 개수를 셀 때 문자 중 하나로 포함니다. |
응답: PromptBargeConfiguration
개입은 프롬프트 행동의 일부로 정의할 수 있는 옵션입니다. Studio 스크립트에서 이 옵션을 포함시키는 방법에 대한 자세한 내용은 다음 프롬프트 동작 도움말 페이지에서 확인할 수 있습니다.
|
매개변수 |
유형 |
설명 |
|---|---|---|
| enableSpeakerBarge | 부울 | 프롬프트 재생 중 컨택이 개입할 수 있는지 여부를 제어하는 데 사용합니다. |
응답: AudioTranscriptionConfig
가상 상담원의 기본 대화 내용 기록 서비스 대신 CXone 턴 바이 턴 대화 내용을(를) 사용하려는 경우 AudioTranscriptionConfig을(를) 사용하십시오.
|
매개변수 |
유형 |
설명 |
|---|---|---|
| transcriptionProfileId | 문자열 | 기존 대화 기록 프로필의 ID를 지정합니다. 여기서 프로필을 지정하면 가상 상담원 허브의 사용자 정의 교환 엔드포인트 앱에서 지정한 설정을 재정의합니다. |
| hintPhrases | Array | 대화 기록 서비스에 힌트를 줄 수 있는 선택적 문구 목록을 제공합니다. 예를 들어, 컨텍스트 모델, 제품 이름, 일반적으로 사용되는 이름 또는 문구 등을 포함할 수 있습니다. |
응답: BotErrorDetails
|
매개변수 |
유형 |
설명 |
|---|---|---|
| errorLoopBehavior | Enum | 엔드포인트에서 오류를 반환하는 경우 스크립트에서 하는 작업을 제어하는 데 사용합니다. 포함할 수 있는 값: ReturnControlToScriptThroughErrorBranch, EndContact |
| errorPromptSequence | PromptSequence | 오류 발생 시 컨택에 대해 프롬프트를 재생하도록 하는 데 사용합니다. |
| systemErrorMessage | 문자열 | 디버깅에 사용합니다. 오류 메시지는 가상 상담원 허브의 사용자 정의 교환 엔드포인트 속성 페이지에서 테스트 창에 표시됩니다. |