사용자 정의 Agent Assist 통합을 위한 리소스

이 페이지는 제어 릴리스(CR)의 제품 또는 기능에 관한 내용입니다. CR 그룹 소속이 아니거나 자세한 정보를 원하시면, CXone 계정 담당자에게 문의하십시오.

이 페이지의 리소스는 CXone과(와) Agent Assist의 사용자 정의 통합을 계획하고 구현할 때 필요한 정보를 제공합니다.

지원되는 상담원 애플리케이션

MAX 은(는) 현재 사용자 정의 Agent Assist 통합에 사용하도록 지원되는 유일한 상담원 애플리케이션입니다.

오디오 스트리밍

오디오 패킷은 G711 μlaw 8비트 8000kHz RAW 오디오로 인코딩됩니다. 이는 모든 CXone 전화 통화 오디오와 동일한 포맷입니다.

상담원 지원 허브에서 사용자 정의 Agent Assist 통합을 구성할 때 Agent Assist 애플리케이션에 보내려고 하는 오디오를 선택할 수 있습니다. 컨택, 상담원 또는 둘 다의 오디오를 보낼 수 있습니다.

각 스트림 시작 시, CXone에서는 사용자 정의 Agent Assist 엔드포인트 앱으로 초기 메시지를 보냅니다. 초기 메시지에는 오디오 스트림이 상담원 또는 컨택인지 여부를 나타내는 streamPerspective 매개 변수가 포함됩니다.

  • "streamPerspective": "RX": 상담원의 전화에서 전송하는 오디오: 상담원이 하는 말
  • "streamPerspective": "TX": 상담원이 듣는 오디오: 컨택이 하는 말 또는 상호작용이 다자간 통화 모드에서 진행 중인 경우에는 여러 사람이 하는 말
  • "streamPerspective": "MIX": 상담원 및 컨택 오디오 스트림을 둘 다 포함합니다.

개별 웹소켓 연결은 하나의 관점에서 가져온 오디오만 포함합니다. 일반적으로 이는 스테레오 분리를 제공하는 TX 또는 RX입니다. 단일 모노 스트림에서 둘의 혼합이 가능합니다. 상호작용이 다자간 통화 모드에서 발생하면 수신된 오디오는 구성된 스트림 관점에 따라 달라집니다. 관점이 TX이면 상담원을 제외한 모든 참가자의 오디오가 수신됩니다.

연결이 끊기거나 다른 문제(예: 손실된 패킷)가 있는 경우 사용자 정의 Agent Assist 엔드포인트에서는 웹소켓에 대한 연결을 복구하려고 시도합니다. 이 연결에는 수신한 최초의 핸드셰이크와 동일한 새로운 인증 핸드셰이크가 필요합니다.

컨택이 대기 중인 경우에는 웹소켓 연결이 닫힙니다. 상호작용이 다시 시작되면 새 웹소켓 연결이 시작됩니다. 이 연결에는 원래 핸드셰이크와 동일한 핸드셰이크가 필요합니다.

승인

사용자 정의 Agent Assist 통합에서 승인을 사용할 수 있습니다. 통합에는 프록시 터널 및 Agent Assist 애플리케이션에서 요청에 대한 인증이 필요할 수 있습니다.

프록시 터널에 대한 승인

요청이 프록시 터널을 통과할 때 프록시 터널에서 요청에 대해 승인을 필요로 하는 경우 디자인에 이러한 요구 사항을 포함해야 합니다. 헤더 또는 동적 토큰 기반 승인 등 모든 종류의 권한 부여를 사용할 수 있습니다. 선택한 승인 방법을 사용하려면 프록시 터널을 구축해야 합니다.

또한 승인을 관리하도록 Studio 스크립트를 구성해야 합니다.

  • 헤더 기반 승인의 경우 스크립트는 전송하는 요청에 헤더를 포함해야 합니다.
  • 토큰 기반 승인의 경우 스크립트는 토큰을 요청하고, 캐시에 저장하고, 토큰 만료를 관리해야 합니다. 토큰이 만료되면 필요한 경우 스크립트는 새 토큰을 요청해야 합니다. REST API Studio 작업을 사용하여 승인 서버와 통신합니다.

동적 승인을 사용하는데 사용할 수 있는 승인 서버가 아직 없는 경우 승인 서버를 설정해야 합니다. 승인 서버는 스크립트가 토큰을 요청할 때 토큰을 제공합니다.

Agent Assist 애플리케이션에 대한 승인

Agent Assist 제공자가 모든 요청에 대해 승인을 요구하는 경우 상담원 지원 허브에서 사용자 정의 Agent Assist 엔드포인트에 승인을 구성할 수 있습니다.

사용자 정의 통합에 승인을 사용하려면 다음을 수행해야 합니다.

  • 사용자 정의 Agent Assist 통합 스크립트에서 사용할 승인 헤더를 생성합니다. 적용 가능한 모든 구성은 Agent Assist 제공자의 문서를 참조하십시오.
  • 상담원 지원 허브에서 사용자 정의 Agent Assist 엔드포인트 앱에 필요한 헤더를 추가합니다. 텍스트 및 음성 상호작용에 Agent Assist 애플리케이션을 사용하는 경우 각 상호작용 유형에 별도의 헤더가 필요합니다. 헤더 생성 방법에 대한 자세한 내용은 Agent Assist 제공자의 문서를 참조하십시오.

스크립트에서 어떤 것도 구성할 필요가 없습니다. 사용자 정의 Agent Assist 엔드포인트 앱은 Agent Assist 애플리케이션으로 헤더 전달을 처리합니다.

CXone 플랫폼 구성 요구사항

CXone 플랫폼에는 사용자 정의 Agent Assist 통합을 설정하기 위해 필요한 구성 변경 사항이 없습니다. 새 Agent Assist 애플리케이션을 포함하도록 기존 스크립트를 수정할 수 있습니다. 그러나 조직이 새 애플리케이션을 사용하는 방식에 따라 일부 구성이 필요할 수 있습니다. 다음이 필요할 수 있습니다.

시퀀스 다이어그램

시퀀스 다이어그램은 사용자 정의 Agent Assist 통합의 다양한 부분이 상호작용하는 방식과 상호작용이 발생하는 순서를 보여 줍니다. 왼쪽 위 모서리에서 시작하여 앞/뒤로 페이지 아래로 이동하며 상호작용의 타임라인을 보여줍니다.

시퀀스 다이어그램은 사용자 정의 통합 계획의 중요한 부분입니다. 시퀀스 다이어그램은 CXone, 상담원 지원 허브, 프록시 터널 및 Agent Assist 애플리케이션 간에 요청 및 응답 흐름을 매핑하는 데 사용할 수 있습니다. 또한 Studio 스크립트가 따라야 하는 흐름을 결정하는 데 유용할 수도 있습니다.

사용자 정의 Agent Assist 통합에 대한 시퀀스 다이어그램의 예시입니다.

Studio 스크립트 요구사항 및 가이드라인

다음 샘플은 Agent Assist 애플리케이션을 CXone(으)로 통합하는 스크립트를 생성하는 기반으로 사용합니다. 인바운드 및 아웃바운드 상호작용에 별도의 스크립트가 필요합니다. 다음 이미지는 인바운드 스크립트에 대한 필수 작업을 보여 줍니다.

Rest API 작업에 연결된 onAnswer 작업을 보여 주는 스크립트 예제로, 이 예제는 Agent Assist 작업에 연결되어 있습니다.

다음 이미지는 아웃바운드 스크립트에 대한 필수 작업을 보여 줍니다.

두 스크립트에서 스크립트 매개 변수 페이로드 Snippet은(는) 선택 사항입니다. 매개 변수를 Agent Assist 애플리케이션에 전달해야 하는 경우 이 페이로드를 포함하기만 하면 됩니다.

스크립트를 완료하려면 다음 작업을 수행해야 합니다.

  • 상담원 지원 애플리케이션을 위한 의 기타 분기를 연결합니다.
  • 스크립트가 사용자 환경에서 필요에 따라 작동할 수 있도록 다른 작업, 구성, 스크립팅 논리를 추가합니다.
  • 선택 사항 스크립트 매개 변수 페이로드 Snippet 작업에 상담원 지원 제공자에 보낼 사용자 정의 페이로드 JSON이 포함되어 있는지 확인하십시오.

  • Agent Assist 작업의 scriptParams 속성이 {customPayloadJSON}으로 설정되어 있는지 확인합니다. 이는 사용자 정의 페이로드와 함께 선택 사항 Snippet 작업을 포함하는 경우에만 필요합니다.
  • Custom Agent Assist Endpoints 구성 앱을 Agent Assist 작업에 할당합니다.
    • Snippet 작업을 사용하여 스크립트에 초기화 스니펫을 추가합니다. Agent Assist 애플리케이션을 사용자 지정하기 위해 이렇게 할 수 있습니다.
    • 작업 커넥터를 재구성하여 적절한 컨택 흐름을 보장하고 잠재적 오류를 수정할 수 있습니다.
    • 추가 스크립팅을 완료하고 스크립트를 테스트합니다.

Studio에서의 스크립팅에 도움이 필요한 경우, CXone 계정 담당자으로 문의하거나, 온라인 도움말의 스크립팅 가이드 섹션을 참조하거나, NICE CXone 커뮤니티 사이트를 방문하십시오.

스크립트 매개변수 페이로드 스니펫

이 스니펫은 Agent Assist action작업에 의해 상담원 지원 애플리케이션으로 전달되는 데이터를 정의합니다. 이 코드를 스크립트의 Snippet action작업에 추가합니다.

DYNAMIC customParam
customParam.param1 = "{value1}"
customParam.param2 = "{value2}"
customParam.param3 = "{value3}"
customParam.param4 = "{value4}"

ASSIGN customParamjson = "{customParam.asJSON()}" 

전송할 사용자 정의 페이로드 매개변수는 없지만 스크립트 매개변수 스니펫이 필요한 경우 값을 할당하지 않고 스니펫에 변수 선언을 포함할 수 있습니다. 예:

DYNAMIC customParam
ASSIGN customParamjson = "{customParam.asJSON()}" 

이 스니펫을 사용하는 방법은 다음과 같습니다.

  1. 조직의 필요와 사용하는 상담원 지원 애플리케이션에 맞게 매개 변수 이름과 값을 필요에 따라 변경합니다.
  2. Agent Assist 작업 전에 스크립트에 Snippet 작업을 배치합니다.
  3. Agent Assist action작업의 scriptParams 속성을 JSON을 저장한 변수의 이름으로 구성합니다. 제공된 예시에서 이는 customParamjson입니다.

새 스크립트와 기존 스크립트 비교

새 스크립트를 만들어 사용자 정의 Agent Assist 통합에 사용할 수 있습니다. 또한 기존 스크립트를 수정할 수도 있습니다. 현재 프로덕션 상태인 스크립트는 직접 변경하지 마십시오. 변경하면 컨택 라우팅이 중단되는 오류로 이어질 수 있습니다.

기존 스크립트를 사용하려면 스크립트 사본을 저장한 후 수정합니다. 사용자 정의 통합이 테스트를 완전히 거치고 구현 준비가 되면 수정된 스크립트를 프로덕션 상태로 이전할 수 있습니다. 다음 중 하나를 수행하여 스크립트를 프로덕션 상태로 이전할 수 있습니다.

프록시 터널 웹후크 개발 및 사양

프록시 터널은 CXone과(와) Agent Assist 애플리케이션의 엔드포인트 간 미들웨어입니다. 모든 요청과 응답이 프록시 터널을 통과합니다. 프록시 터널은 요청을 CXone 형식에서 Agent Assist 애플리케이션이 이해할 수 있는 형식으로 변환해야 합니다. 마찬가지로, Agent Assist 애플리케이션의 응답을 CXone이(가) 이해하는 형식으로 변환해야 합니다. 이렇게 변환하려면 CXone과(와) Agent Assist 애플리케이션 간에 엔드포인트를 매핑해야 합니다.

프록시 터널은 필요 없습니다. 그러나 통합에 포함하는 것이 좋습니다. 프록시 터널은 다음과 같은 이점을 제공합니다.

  • 관리할 데이터 센터에 대한 입력 지점이 하나뿐이기 때문에 보안이 강화됩니다.
  • 장애조치 및 부하 분산 기능을 제공합니다.
  • CXone과(와) Agent Assist 제공자 시스템 간에 프로토콜을 변환합니다.

통합에 프록시 터널을 포함하지 않으면 스크립트가 웹후크 URL에 초기 웹소켓 요청을 보냅니다. Agent Assist 애플리케이션에서 기대하는 형식으로 요청을 주고 받도록 스크립트를 구성해야 합니다.

이어지는 섹션의 내용은 다음과 같습니다.

프록시 터널 개발에 대한 주요 정보

다음 정보는 프록시 터널 엔드포인트를 계획 및 개발하는 데 도움이 될 수 있습니다.

  • 텍스트 중계 엔드포인트에서는 HTTPS를 사용해야 합니다. HTTP는 사용할 수 없습니다.

  • 오디오 중계 엔드포인트는 웹소켓이어야 합니다. 보안(WSS) 또는 비보안(WS)일 수 있습니다.

  • 모든 프록시 터널 엔드포인트는 NICE CXone 네트워크에서 통신을 주고 받을 수 있어야 합니다.

  • 이진 데이터만 웹후크를 통해 흐릅니다.

  • 음성 상호작용의 경우 통화에서 보낸 데이터만 오디오 바이트입니다. 통화 제어 또는 기타 메타데이터는 포함되지 않습니다.

  • 사용자 정의 Agent Assist 통합은 2000개 이상의 동시 요청을 지원합니다.

  • 상호작용 스트리밍에 대한 만료 시간 또는 최대 연결 시간은 없습니다. 사용자 정의 Agent Assist 통합은 통화가 활성 상태이기만 하면 통화를 열린 상태로 유지할 수 있습니다. 통화가 종료되면 연결이 닫힙니다.

  • 통화가 대기 상태로 전환되면 연결은 열림 상태로 유지되지만 데이터는 전송되지 않습니다.

  • 컨택 ID는 사업부닫힘 고급 조직 그룹화는 CXone 환경을 위해 기술 지원, 청구 및 글로벌 설정을 관리하는 데 사용됩니다. 당 고유합니다. CXone에는 contactID에 대한 실시간 데이터를 얻는 데 사용할 수 있는 API가 있습니다. API에 대한 문서를 보려면 CXone Dev Portal에 로그인해야 합니다. 액세스에 대한 자세한 내용은 CXone 계정 담당자에 문의하십시오.

오디오 웹후크에 연결: 초기 요청

음성 상호작용은 웹소켓 요청(WSS 또는 WS)을 사용해야 합니다. CXone의 초기 웹소켓 요청은 다음 형식을 따릅니다.

 
"authenticationToken": "[header provided in Custom Agent Assist app]",
"executionInfo": {    
      "contactId": 0, 
      "busNo": 0, 
      "requestId": 0,  
      "actionType": "string",  
      "actionId": 0,  
      "scriptName": "string"
},
      "systemTelemetryData": {    
            "consumerProcessHost": "string",  
            "consumerProcessName": "string",  
            "consumerProcessVersion": "string",  
            "inContactClusterAlias": "string",  
            "inContactScriptEngineHost": "string",  
            "consumerMetaData": {  
                  "additionalProp1": "string",
                  "additionalProp2": "string",   
                  "additionalProp3": "string"  
            }
      },
"streamPerspective": "TX/RX/MIX",
"streamsConfiguration": "string",
"appParams": "string",
"appConfig": "string"
			
		

이 요청의 매개 변수는 이 페이지의 스키마 섹션에서 설명합니다.

  • authenticationToken, streamsConfiguration, appParamsappConfig에 대한 설명은 모두 WebSocketHookInitializeMessage 섹션에 나와 있습니다.
  • systemTelemetryData에 대한 설명은 고유한 섹션에 나와 있습니다.
  • streamPerspective에 대한 설명은 고유한 섹션에 나와 있습니다.

오디오 후크에 연결: 핸드셰이크 응답

authenticationToken이(가) 제공되면 토큰 또는 헤더를 검증한 다음 핸드셰이크 응답을 보냅니다. 응답은 CXoneWebSocketMessage 클래스 형식을 따라야 합니다.


public class CXOneWebSocketMessage 
{ 
/// Type of command - see CXOneWebSocketCommandType below
public CXOneWebSocketCommandType command { get; set; } 

/// Type of message returned 
public string messageType { get; set; } 

/// Text message 
public string message { get; set; } 

/// Additional parameters 
public object parameters { get; set; } 
)

public enum CXOneWebSocketCommandType
{ 
CONNECT, 
/// When the initial message/auth validation is a success 
CONNECTED, 
/// Message command 
MESSAGE,  
/// Error command, for example when the initial message/auth is invalid 
ERROR
}
		

예:


{
    "command": "CONNECTED",
    "messageType": "COMMAND",
    "message": "BEGIN AUDIO STREAM"
}
		

웹소켓과 연결 코드 예시:

	
WebSocketReceiveResult result = await webSocket.ReceiveAsync(buffer, CancellationToken.None);
if (result.MessageType == WebSocketMessageType.Text)
{ 
    _logger.LogInformation(string.Concat ("MessageType : ", result.MessageType.ToString()));
    if (buffer == null || buffer?.Length == 0)
    {
       return;
    }
    var message = Encoding.UTF8.GetString(buffer, 0, buffer?.Length ?? 0);
    _logger.LogInformation(string.Concat("On Connected", message));
 
    // Validates initial message
    var initialMessage = JsonConvert.DeserializeObject<WebSocketHookInitializeMessage>(message);
    webSocketHookInitilizeMessage = initialMessage;
    param = JsonConvert.SerializeObject(webSocketHookInitializeMessage.appConfig);
 
    // Send response back to  after successful validation
    CXOneWebSocketMessage connectedMessage = new CXOneWebSocketMessage
    {
       command = CXOneWebSocketCommandType.CONNECTED,
       messageType = "COMMAND", 
       message = "BEGIN AUDIO STREAM"
   }; 

    var jsonResponse = Newtonsoft.Json.JsonConvert.SerializeObject(connectedMessage);
    await webSocket?.SendAsync(buffer: new ArraySegment<byte>(array: Encoding.UTF8.GetBytes(jsonResponse),
             offset: 0,
             count: jsonResponse.Length),
             messageType: WebSocketMessageType.Text,
             endOfMessage: true,
             cancellationToken: CancellationToken.None);
}

else if (result.MessageType == WebSocketMessageType.Binary)
{
// You can read the binary voice data
}		
				
		

이 페이지의 스키마 섹션에서는 다음에 대해 설명합니다.

텍스트 후크에 연결

텍스트 채팅 데이터를 수신하려면 텍스트 웹후크에 연결해야 합니다. HTTP/HTTPS 요청만 수락됩니다.

모든 요청에는 다음 개체가 포함되어 있습니다. 승인 헤더는 상담원 지원 허브Custom Agent Assist Endpoints 앱에서 승인 헤더를 하나 추가한 경우에만 보냅니다. 승인 헤더는 필요 없습니다.


public class WebHooksMessagesRequest
{
	/// If you provide this information in the configuration, it's included.
	public string authorizationHeader { get; set; }
	public int contactId { get; set; }
	public int busNo { get; set; }
	
	
	/// This will be one of the following: patron, agent, or system
	public string participantId { get; set; }
	
	/// Text of the user input (from participantId)
	public string messageBody { get; set; }
	
	/// Other useful data about the message or that are part of the message, such as images or links.
	public object messageData { get; set; }
	
	/// Configuration blob from 상담원 지원 허브. 
	/// It may only include the configuration identifier for apps that have large amounts of configuration data.
	public object agentAssistAppConfig { get; set; }
}
 	

이 코드의 매개 변수는 이 페이지의 스키마 섹션에서 설명합니다.

구성 매개 변수

상담원 지원 허브에서 사용자 정의 Agent Assist 엔드포인트 앱을 구성할 때 추가 매개 변수를 포함할 수 있습니다. 이는 Agent Assist 제공자가 각 요청과 함께 특정 매개 변수를 보내야 하는 경우 유용합니다. 특정 매개 변수는 필요하지 않습니다. 추가한 매개 변수는 WebHooksMessagesRequest 개체의 agentAssistAppConfig 개체에서 전송됩니다. 예:


"agentAssistAppConfig":{ 
   "param1": "value1", 
   "param2": "value2",
} 
		

사용자 정의 Agent Assist 통합을 위한 CXone 엔드포인트

여기서 제공한 API 엔드포인트는 CXone의 요청 예시를 얻기 위해 사용자 정의 Agent Assist 통합과 함께 사용할 수 있는 대화형 참조입니다. 원래 스키마를 포함한 추가 정보는 API의 Swagger 문서에서 확인할 수 있습니다.

음성 기반 Agent Assist 애플리케이션에 대한 엔드포인트

GET ​/agent_assist_audio_websocket_hooks​/example-websocket-server: 이 엔드포인트는 웹소켓 서버 요청 URL의 예시를 제공합니다. 이 예시는 CXone 오디오 웹소켓 후크 사양을 따릅니다.

GET ​/agent_assist_audio_websocket_hooks​/initializemessage-example: 이 엔드포인트는 웹소켓 초기화 메시지의 예시를 제공합니다.

POST /agent_assist_audio_websocket_hooks/custom-assist-endpoint/initialize-audio-message-example: 이 엔드포인트는 초기 요청 및 응답의 예시를 제공합니다. 자세한 내용은 WebSocketHookInitializeMessage 스키마CXoneWebSocketMessage 스키마를 참조하십시오.

채팅 기반 Agent Assistant 애플리케이션에 대한 엔드포인트

POST ​/agent_assist_text_webhooks​/utterance: 이 엔드포인트는 텍스트 기반 발화닫힘 컨택이 말하거나 입력하는 내용입니다.를 실시간으로 수신하고 상담원 지원을 비동기식으로 제공하는 예시를 제시합니다. 발화는 컨택만, 상담원만 또는 둘 다 가능합니다.

스키마

다음 섹션에서는 사용자 정의 Agent Assist 엔드포인트와 함께 사용되는 스키마에 대한 정보를 제공합니다. 스크립트에서 이 정보를 사용하기 전에 항상 최신 Swagger 문서 버전에서 스키마를 확인하십시오.

ActionExecutionInfo

실행 중인 작업 및 스크립트에 관한 정보를 포함합니다.

매개변수

유형

세부사항

contactId 정수 상호작용의 고유 식별자입니다.
busNo 정수 스크립트가 위치한 CXone사업부닫힘 고급 조직 그룹화는 CXone 환경을 위해 기술 지원, 청구 및 글로벌 설정을 관리하는 데 사용됩니다.의 ID입니다.
requestId 정수

특정 상호 작용에서 각 요청을 식별하는 반복 번호입니다. 요청에 requestId을(를) 포함하면 응답에 포함될 수 있습니다.

이는 기타 문제 해결에 도움이 될 수 있습니다. requestID이(가) 고유한 값인 경우 로그 파일에서 단일 요청/응답을 찾는 데 사용할 수 있습니다.

actionType

문자열

사용자 정의 엔드포인트에 대한 요청을 생성하는 작업 유형입니다.
actionId

정수

스크립트 내에서 Studio 작업의 ID 번호입니다. 작업 ID는 작업이 스크립트에 추가된 순서를 따릅니다.
scriptName

문자열

요청을 생성하는 스크립트의 경로 및 이름입니다.

AgentAssistUtterance_V1

메시지 본문과 메시지에 대한 정보를 포함합니다.

매개변수

유형

세부사항

contactId integer ($int64) 스크립트의 현재 인스턴스 내 컨택의 ID입니다.
busNo integer ($int32) 스크립트가 위치한 CXone 사업부닫힘 고급 조직 그룹화는 CXone 환경을 위해 기술 지원, 청구 및 글로벌 설정을 관리하는 데 사용됩니다.의 ID입니다.
tenantId

문자열

이 매개 변수는 필요 없습니다.
participantId

문자열

메시지에 컨택(Patron), 상담원(Agent) 또는 둘 다(System)를 포함할지 여부를 나타냅니다.
messageBody

문자열

메시지의 텍스트입니다.
messageMetaData  

messageBody에서 메시지에 대한 유용한 데이터를 보관하는 매개 변수를 포함합니다. 메시지가 채팅 메시지인 경우 이 매개 변수는 메시지의 일부로 보낸 이미지, 링크 또는 기타 콘텐츠를 저장할 수도 있습니다.

agentAssistAppConfig  

상담원 지원 허브의 구성 정보를 포함합니다. 구성 Blob가 큰 Agent Assist 애플리케이션의 경우 이 개체에는 구성 식별자만 포함할 수 있습니다.

{
	"agentAssistAppConfig":
        {

"param1": "value1",

"param2": "value2"

        }

}

CXoneWebSocketCommandType

전송되는 명령 유형을 정의합니다. 가능한 값:

  • CONNECT .
  • CONNECTED: 초기 메시지 또는 승인 확인에 성공한 경우 사용합니다.
  • MESSAGE: 메시지를 보내는 경우 사용합니다.
  • ERROR: 초기 메시지 또는 승인 확인이 유효하지 않은 경우 사용합니다.

CXoneWebSocketMessage

Agent Assist 애플리케이션에서 CXone(으)로 보낸 메시지를 포함합니다.

매개변수

유형

세부사항

command 문자열 CXOneWebSocketCommandType의 값을 포함합니다.
messageType

문자열

메시지의 유형을 포함합니다.
message

문자열

메시지의 텍스트를 포함합니다.
parameters  

Agent Assist 애플리케이션에 필요한 추가 매개 변수를 모두 포함하는 개체입니다. 상담원 지원 허브의 사용자 정의 Agent Assist 엔드포인트에 포함해야 하는 매개 변수를 구성합니다.

{ additional parameters
}

StreamPerspective

가능한 값 3개와 함께 문자 배열을 포함합니다. 이 매개 변수는 상담원 지원 허브의 사용자 정의 Agent Assist 엔드포인트 앱에서 지정한 참가자 구성을 반영합니다. 오디오 스트림에 컨택만(0(TX)), 상담원만(1(RX) ) 또는 결합(2(MX))의 오디오를 포함할지 정의합니다.

SystemTelemetryData

Studio 스크립트와 관련이 없는 API 소비자에 관한 데이터를 포함합니다. 이 개체에 포함된 데이터는 디버깅, 청구, 보고서 등에 유용할 수 있습니다.

매개변수

유형

세부사항

consumerProcessHost 문자열 API를 호출하는 애플리케이션의 호스트 이름입니다.
consumerProcessName 문자열 API를 호출하는 프로세스 또는 애플리케이션의 이름입니다. 예: EsnMediaServer.exe.
consumerProcessVersion 문자열 API를 호출하는 애플리케이션에 대한 버전 정보입니다.
inContactClusterAlias 문자열 적용 가능하고 확인 가능한 경우 스크립트가 실행 중인 NICE CXone 클러스터의 별칭을 제공합니다. 예: C7 또는 M33.
inContactScriptEngineHost 문자열 적용 가능하고 확인 가능한 경우 NICE CXone 스크립트 엔진의 호스트 이름을 입력합니다. 예: lax-c4cor01 또는 aoa-c32cor01.
consumerMetaData 개체

API 소비자에 대한 임의의 확장 가능한 데이터를 보유하고 있습니다.

{
	< * >:
}

WebSocketHookInitializeMessage

연결하는 웹소켓 클라이언트(예: NICE CXone 미디어 서버)의 첫 번째 페이로드에 대한 메시지 구조입니다.

매개변수

유형

세부사항

authenticationToken 문자열

상담원 지원 허브Custom Agent Assist Endpoints에서 구성한 승인 헤더를 포함합니다.

executionInfo   ActionExecutionInfo 개체를 포함합니다.
systemTelemetryData   SystemTelemetryData 개체를 포함합니다.
streamPerspective   StreamPerspective의 값을 포함합니다.
streamsConfiguration   현재 사용 중이 아닙니다.
appParams  

Studio 스크립트 또는 기타 소스에서 전달할 수 있는 동적 컨택 매개 변수입니다.

{ parameters
}
appConfig  

미리 구성된 Agent Assist 애플리케이션 구성 설정입니다.

{ parameters
}