CXone Agent SDK

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

SDK 언어: Typescript

현재 버전: 24.3

현재 버전의 릴리스 날짜: 2024년 7월 23일

이용가능성: 모든 지역 및 비즈니스 세그먼트

브라우저 지원: Google Chrome, Microsoft Edge, Island Enterprise

SDK 리포지토리: CXone 계정 담당자에게 리포지토리 링크 문의

소프트웨어 개발 키트(SDK)는 개발자를 위한 도구 상자와 같습니다. 이는 소프트웨어 애플리케이션를 더 쉽게 구축할 수 있는 도구 및 리소스 세트를 제공합니다. 미리 만들어진 빌딩 블록 모음이라고 생각할 수 있습니다. 이러한 빌딩 블록에는 기존의 기능을 가지고 있습니다. 개발자는 처음부터 자체적으로 기능을 구축하는 대신 이러한 기존의 블록을 사용할 수 있습니다. SDK를 사용하면 다음과 같은 네 가지 일반적인 이점을 얻을 수 있습니다.

  1. 효율성: SDK는 개발자의 시간을 절약해 주는 기성 도구와 사전 구축된 구성 요소를 제공합니다. 노력을 낭비하는 대신 앱의 독특한 측면에 집중할 수 있습니다.

  2. 일관성: SDK는 다양한 앱에 걸쳐 일관성을 보장합니다. 개발자는 동일한 도구 및 라이브러리 세트를 사용하여 사용자에게 통합된 경험을 제공합니다.

  3. 플랫폼 호환성: iOS 및 Android SDK는 해당 플랫폼에 맞게 조정되었습니다. 플랫폼 특정 복잡성을 처리하여 크로스 플랫폼 앱을 더 쉽게 만들 수 있습니다.

  4. 품질 보증: 로거를 사용하면 개발자는 코드를 확인하고, 버그를 조기에 포착하고, 보다 안정적인 소프트웨어를 제공할 수 있습니다.

요약하자면, SDK는 개발을 단순화하고, 품질을 보장하며, 협업을 촉진하므로 효율적인 앱 만들기를 위한 필수 도구입니다.

CXone Agent SDK를 사용하면 상담원 애플리케이션닫힘 날짜를 부동 소수점 정수로 쓰는 방법입니다. 1899년 12월 30일 이후의 일수를 나타냅니다.을(를) 구축할 수 있습니다. 또한 CXone Agent 기능을 기존 애플리케이션에 통합할 수도 있습니다. CXone API를 직접 사용하는 대신, 개발자는 SDK를 통해 사전 제작된 기능을 사용할 수 있습니다. 이에 따라 개발 속도가 빨라지며 리소스를 저장할 수 있습니다. 개발자는 모든 CXone API가 작동하는 방식을 이해할 필요가 없습니다. 대신, SDK를 사용하면 소비 가능한 JavaScript 래퍼에서 API 그룹을 사용할 수 있습니다.

CXA SDK는 작은 SDK의 컴필레이션입니다. 각각의 작은 SDK는 인증이나 통화 제어와 같은 특정 기능에 집중합니다. 사용 사례를 충족하려면 필요한 SDK만 선택할 수 있습니다. 예를 들면, Integrated Softphone에 WebRTC 기능을 제공하는 음성 SDK는 필요 없을 수 있습니다. 즉, 개발자는 사용 사례에 필요한 SDK만 설치하면 됩니다.

CXA SDK에 관한 핵심 사항 몇 가지:

  • SDK는 이벤트 구독을 통해 작동합니다. CXone 플랫폼의 데이터는 이벤트와 함께 게시됩니다. 데이터를 사용하려면 앱은(는) 이러한 이벤트를 구독해야 합니다.

  • CXone Agent의 모든 기능은 이 SDK를 통해 이용가능합니다.

  • SDK를 사용할 애플리케이션을(를) 등록해야 합니다. 이 앱에 대한 자격 증명을 받으려면 등록 양식 을 완료해야 합니다. 개발자 포털의 시작 페이지에서는 앱 등록 및 인증 설정 프로세스를 안내합니다.

  • SDK는 OpenID Connect with PKCE 인증 플로를 지원합니다.

CXA SDK 사용 사례

CXA SDK의 일반적인 사용 사례 세 가지는 다음과 같습니다.

  • 사용자 지정 상담원 클라이언트:
    이는 네이티브 CXone Agent이(가) 아직 제공하지 않는 고유한 기능이나 요구 사항이 있는 경우입니다. 또한 필요한 기능을 단순히 CXone Agent에 임베드할 수 없을 수도 있습니다. 예를 들어 상담원의 컨택 정보에 대한 가시성을 제한해야 할 수도 있습니다. 이는 특정 보안 요구 사항 때문일 수 있습니다. 상담원의 모든 컨택 데이터를 마스킹해야 할 수도 있는데, 사용자 지정 클라이언트만 이를 수행할 수 있습니다.

  • 상담원 클라이언트를 타사 애플리케이션과 통합:
    이 경우에는 상담원 애플리케이션을(를) 다른 앱에 임베드할 수 없습니다. 디른 앱들은 CRM, 온라인 뱅킹 사이트, 또는 호텔 예약 시스템인 경우가 많습니다. 이 사용 사례는 상담원 클라이언트의 기능은 원하지만 클라이언트 UI가 반드시 필요하지 않은 경우입니다. SDK를 사용하면 기능을 다른 애플리케이션 내부에 구축할 수 있습니다. 호텔 시스템을 예로 들면, 직원이 예약 시스템을 통해 특정 객실로 전화를 걸 수 있습니다.

  • 내장된 애플리케이션에 대한 이벤트 구독:
    이는 일반적으로 특정 브라우저 보안 제한을 준수하는 데 사용됩니다. 예를 들어, Google은(는) 다른 웹사이트의 iFrame 창에 데이터를 게시하지 못하도록 막습니다. 이렇게 하면 두 프레임 간에 메시지나 데이터를 공유하는 방법이 복잡해집니다. CXone Agent 안으로 iframe을 수행하는 헬스케어 앱의 예를 들어보겠습니다. 상담원이 컨택을 수락하면 컨택의 전화번호를 사용하여 헬스케어 앱에서 해당 컨택의 정보를 조회할 수 있습니다. 이렇게 하면 상담원에게 컨택 정보를 자동으로 표시할 수 있습니다. 상담원이 Google Chrome을(를) 사용하는 경우, 헬스케어 앱은(는) CXone Agent에서 컨택 전화번호를 얻을 수 없습니다. 대신 CXone Agent에서 사용하는 것과 동일한 VC 이벤트 시스템에 구독해야 합니다.

SDK 분석

CXA SDK는 다음과 같은 더 작은 SDK로 구성됩니다.

SDK 세부사항
ACD

이 SDK는 음성 통화, 음성 메일, 워크 아이템닫힘 Studio 스크립트를 통해 상담원에게 컨택을 전달하는 맞춤형 방법입니다.을 처리하기 위한 기능을 제공합니다. 예:

  • 음성 통화의 경우 통화를 개시, 수신, 전환, 회의로 설정할 수 있습니다.

  • 음성 메일의 경우 음성 메일을 수신, 저장, 관리할 수 있습니다.

  • 워크 아이템의 경우 상담원에게 워크 아이템을 자동으로 배포할 수 있습니다. 이렇게 하면 사전 정의된 규칙과 기준을 사용하여 상담원 워크로드를 최적화할 수 있습니다.

ACD SDK에 대한 주요 기술 세부 정보는 다음과 같습니다.

  • 성공적으로 인증하면 이 모듈을 인스턴스화하고 ACD 기능을 구축하기 위해 initAcdEngagement()을(를) 호출할 수 있습니다.

  • startSession 및 joinSession 메서드를 사용하여 상담원과 컨택 간에 세션을 설정할 수 있습니다.

  • 세션이 설정된 후에는 앱이(가) 전화 걸기, 전환, 회의 등의 메서드를 다른 방법으로 호출할 수 있습니다.

  • 이 모듈의 메서드를 성공적으로 호출하면 ACD 이벤트가 생성됩니다.
상담원

이 SDK는 세션 이벤트 처리 목적입니다. 세션을 시작하고 진행 중인 세션에 참여하는 등의 작업을 수행할 수 있습니다. 다음과 같은 사항에 주로 집중합니다.

  • get-next-event 루프

  • CXone 플랫폼의 ACD 및 Digital Experience 영역의 공통점입니다. 예를 들면 WEM 또는 알림 등이 있습니다.
Auth

이 SDK는 안전한 인증 및 권한 부여를 용이하게 지원합니다. 기본적으로 CXone 글로벌 인증 을 사용하여 로그인 플로를 설정할 수 있습니다. 지원되는 인증은 OpenID Connect with PKCE입니다. 사용자는 CXone 계정을 사용하여 인증해야 합니다. 그러면 CXone 역할닫힘 고객 불만을 파악하기 위한 신호를 찾습니다. 신호에 포함되는 단어와 문구의 예로는 "화가 나는군요” 등을 들 수 있습니다. 불만은 부정적인 감성과 동일하지 않습니다. 불만 신호는 고객이 단순히 무언가 부정적인 것에 대해 얘기하는 것이 아니라 화가 났다는 것을 나타냅니다. 에 따라 사용자 신원과 권한을 확인할 수 있습니다..

키 기능은 다음과 같습니다.

  • 인증 토큰을 자동으로 새로 고칩니다. 사용자가 앱을(를) 닫거나 로그아웃하기 전까지는 로그인 상태가 유지됩니다.

  • 토큰 관리 및 검증. 사용자가 이미 CXone에 로그인한 경우에는 유효한 인증 토큰을 앱에 전달할 수 있습니다.

Auth SDK에 대한 주요 기술 세부 정보는 다음과 같습니다.

  • cxoneAuth.init()을(를) 호출하여 cxoneHostname, clientId, redirectUri을(를) SDK에 전달합니다.

  • getAuthorizeUrl() 메서드를 호출하여 사용자를 글로벌 CXone 인증 페이지로 리디렉션합니다. 로그인한 후에는 앱(으)로 리디렉션됩니다.

  • 사용자가 자격 증명을 입력하고 인증을 개시하면 사용자 정보로 AuthSettings 개체가 생성됩니다. CXoneAuth 인스턴스는 AuthSettings을(를) 사용하여 초기화됩니다.

  • getAccessTokebByCode()을(를) 사용하여 반환된 코드를 캡처하고 인증 토큰을 생성합니다. 또한 사용자의 정보가 저장됩니다.

  • onAuthStatusChange에 구독하면 AUTHENTICATED 또는 AUTHENTICATEDFAILED 등의 인증에 관한 이벤트를 만듭니다. AUTHENTICATED의 경우에는 새로 고침 플로가 자동으로 발동하며, 이에 따라 사용자의 로그인 상태가 유지됩니다.
Digital

이 SDK를 사용하면 디지털 커뮤니케이션 채널을 통합할 수 있습니다. 이메일, 채팅, SMS와 같은 표준 디지털 채널은 물론, WhatsApp 등의 소셜 미디어 플랫폼도 사용할 수 있습니다. 설정한 채널 수에 따라 멀티채널 커뮤니케이션을 생성할 수 있습니다.

다음은 Digital SDK에 대한 주요 기술 세부 정보입니다.

  • 인증하고 나면 CXoneDigitalClient.instance.initDigitalEngagement()을(를) 호출할 수 있습니다. 이렇게 하면 디지털 메시징에 필요한 구성 요소가 인스턴스화되고 디지털 WebSocket 연결이 설정됩니다.

  • 디지털 이벤트를 사용하여 이미 배정된 케이스와 기존 메시지 스레드를 수신합니다.

  • 앱은(는) reply() 메서드를 사용하여 디지털 메시지에 회신할 수 있습니다.

  • 또한 reply() 메서드를 사용하여 새로운 아웃바운드 인터랙션을 시작할 수도 있습니다.
음성 이 SDK는 Integrated Softphone 기능을 제공합니다. 이는 WebRTC에 대한 래퍼입니다.

리소스

SDK를 사용하면 사용자 지정 기능을 직접 만들 수 있으므로 지원 리소스는 주로 셀프 서비스 콘텐츠입니다. 기술 지원 옵션은 조직과 NICE 간의 지원 계약에 따라 달라집니다. 지원 옵션에 관한 자세한 정보는 CXone 계정 담당자에게 문의하십시오.

이 페이지 외에도 셀프 서비스 콘텐츠는 개발자 리소스에 중점을 둡니다. SDK 패키지에는 다음이 포함됩니다.

  • 시작하기 정보를 제공하는 각 개별 SDK에 대한 README.

  • 기본 기능을 보여주는 샘플 애플리케이션.

  • 샘플 애플리케이션에서 코드를 발췌한 사용 예시.

  • 코드 코멘트.

이벤트

다음은 앱이(가) 들을 수 있는 이벤트입니다. 이벤트는 이용가능한 모듈에 따라 분류됩니다.

ACD SDK

인스턴스 이벤트 설명

CXoneAcdClient.instance.contactManager

conferenceCallEvent

전화 회의와 관련된 이벤트를 수신 대기합니다.

 

onDispositionEvent

인터랙션의 처분닫힘 음성(처분) 또는 디지털(상태) 인터랙션이 끝날 때 상담원이나 시스템이 배정한 결과입니다.과 관련된 이벤트를 처리합니다.

 

onTagsEvent

인터랙션과 연결된 태그와 관련된 이벤트를 관리합니다.

 

voiceContactUpdateEvent

음성 컨택에 대한 업데이트를 수신 대기합니다.

 

voiceMailContactUpdateEvent

음성 메일 컨택에 대한 업데이트를 수신 대기합니다.

 

workItemContactUpdateEvent

워크 아이템 컨택의 업데이트를 수신 대기합니다.

CXoneAcdClient.instance.notification

onUpdateMessageEvent

상담원에 대한 새로운 메시지 또는 알림을 수신 대기합니다.

CXoneAcdClient.instance.screenPop

agentAssistSubject

상담원 지원 또는 코파일럿 애플리케이션과 관련된 이벤트를 처리합니다.

 

contactScreenPopSubject

수신 컨택의 화면 팝업과 관련된 이벤트를 처리합니다.

 

pageOpenSubject

웹 페이지 열기와 관련된 이벤트를 처리합니다.

 

popUrlSubject

새 창 또는 탭에 URL을 여는 것과 관련된 이벤트를 처리합니다.

 

runAppSubject

애플리케이션 실행 또는 사용자 지정 양식 열기와 관련된 이벤트를 처리합니다.

CXoneAcdClient.instance.session

agentLegEvent

세션에서 상담원의 연결 상태닫힘 상담원과 CXone 간에 이루어지는 인터랙션의 일부입니다.와 관련된 이벤트를 수신 대기합니다.

 

agentStateSubject

이용가능에서 이용불가와 같은 상담원 상태의 변경과 관련된 이벤트를 내보내는 옵저버블입니다.

 

naturalCallingSkillListSubject

자연스러운 호출에 사용할 수 있는 스킬 목록에 대한 업데이트를 수신 대기합니다.

이벤트 유형에는 SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS, JOIN_SESSION_FAILURE가 포함됩니다.

 

networkOfflineSubject

네트워크 연결 문제와 관련된 이벤트를 수신 대기합니다.

 

onAgentSessionChange

시작 또는 종료와 같은 상담원의 세션 상태 변경을 수신 대기합니다.

이벤트 유형에는 SESSION_START, SESSION_END, JOIN_SESSION_SUCCESS, JOIN_SESSION_FAILURE가 포함됩니다.

CXoneAcdClient.instance.session.agentStateService

agentStateSubject

상담원의 상태 변화에 대한 업데이트를 내보내는 옵저버블입니다.

상담원 SDK

인스턴스 이벤트 설명

CXoneClient.instance

autoSummaryService

자동 요약 관리를 위한 서비스입니다.

 

copilotNotificationClient

상담원 코파일럿에 대한 실시간 알림을 쉽게 받을 수 있도록 지원합니다.

 

cxoneApiPerformanceMetrics

CXone API에서 성과 메트릭을 수신 대기합니다.

CXoneClient.instance.agentSession

agentSessionEndSubject

현재 상담원의 세션이 종료될 때 이벤트를 내보냅니다.

CXoneClient.instance.agentSetting

mchAgentSettingsChangeEvent

상담원의 통화 연결음 듣기(MCH) 설정이 변경되었는지 확인합니다.

CXoneClient.instance.autoSummaryService

onAutoSummaryReceived

컨택에 대해 자동 생성된 요약이 수신될 때 트리거되는 옵저버블 이벤트입니다.

CXoneClient.instance.commitment

onCommitmentEvent

상담원의 약속과 관련된 이벤트를 수신 대기합니다.

 

onCommitmentStatusEvent

상담원의 약정 상태 변경을 수신 대기합니다.

 

onUpdateCommitments

상담원의 약속에 대한 업데이트를 수신 대기합니다.

CXoneClient.instance.contactManager

onDigitalContactEvent

CXone의 채팅 세션 및 아웃바운드 메시지와 같은 디지털 컨택 인터랙션에 대한 업데이트를 제공합니다.

 

onDispositionEvent

통화 종료 후 통화 처분 상태에 대한 업데이트를 제공합니다.

 

voiceContactUpdateEvent

발신자 이름 및 전화번호와 같은 진행 중인 음성 통화 세부 정보를 실시간으로 업데이트합니다.

CXoneClient.instance.copilotNotificationClient

onMessageNotification

수신 코파일럿 메시지 또는 알림을 구독하는 데 사용되는 옵저버블/이벤트 이미터입니다.

이벤트 유형에는 ADAPTIVE_CARD, RT_SUMMARY, NEXT_BEST_RESPONSE, NEXT_BEST_RESPONSE_LLM, NEXT_BEST_RESPONSE_EXPERT, KB_ANSWERS, SENTIMENT, KB_LINKS, KB_IMAGES, TEXT, FINAL_SUMMARY, FINAL_SUMMARY_NOTES, KB_ANSWERS_VOICE, KB_IMAGES_VOICE, ENLIGHTEN_AGENT_COPILOT, AGENT_COPILOT이 포함됩니다.

CXoneClient.instance.directory

directoryEvent

상담원, 팀 또는 스킬 등 디렉터리와 관련된 이벤트를 수신 대기합니다.

새 컨택, 업데이트, 권한 수정과 같은 디렉터리 데이터의 변경 사항에 대한 업데이트를 CXone에서 제공합니다.

 

onUpdateSkillsEvent

상담원에게 배정된 스킬 업데이트를 수신 대기합니다.

CXoneClient.instance.directory.dynamicDirectory

searchDirectoryResult

시스템 내 디렉터리에서 사람이나 부서 등을 조회한 후 결과가 돌아올 때까지 기다립니다.

CXoneClient.instance.indicator

agentIndicatorsEvent

가용성, 현재 활동, 사용자 지정 상담원 상태 표시기와 같은 상담원 지표에 대한 업데이트를 제공하는 이벤트입니다.

 

contactIndicatorsEvent

추가 정보를 수집하기 위해 사용자 지정 양식 표시와 같은 작업을 트리거할 수 있는 컨택 표시기에 대한 업데이트를 제공하는 이벤트입니다.

CXoneClient.instance.notification

onCXoneNotificationEvent

CXone 플랫폼의 알림을 수신 대기합니다.

CXoneClient.instance.screenPop

contactScreenPopSubject

기존 통화에 대한 발신자 정보가 포함된 웹 페이지를 열도록 트리거하는 이벤트입니다.

 

pageOpenSubject

현재 통화와 별 관련이 없는 웹 페이지를 열도록 트리거하는 이벤트입니다.

 

popUrlSubject

기존 통화에 대한 관련 웹 페이지를 열도록 트리거하는 이벤트입니다.

 

runAppSubject

앱의 시작 또는 통화에 대한 사용자 지정 양식의 표시를 트리거하는 이벤트입니다.

CXoneClient.instance.session

agentLegEvent

수신 또는 발신 통화와 같은 상담원의 특정 통화 구간에서 업데이트를 수신 대기합니다.

CXoneClient.instance.session.agentStateService

agentStateSubject

CXone에서 상담원의 이용가능 상태 및 상태 변경에 대한 실시간 업데이트를 제공하는 이벤트입니다.

CXoneClient.instance.skillActivityQueue

agentQueueSubject

대기열 이름, 통화 수, 상담원 이용가능 여부 등 상담원에게 배정된 대기열 정보에 대한 업데이트를 제공하는 이벤트입니다.

 

agentQueuesDetailSubject

평균 대기 시간, 서비스 수준 협약(SLA), 상담원 성과 등의 메트릭을 포함하여 상담원에게 배정된 대기열에 대한 자세한 업데이트를 제공하는 이벤트입니다.

 

skillActivityEvent

통화 대기열 길이, 평균 대기 시간 및 이용가능한 상담원과 같은 스킬 활동 메트릭에 대한 업데이트를 제공하는 이벤트입니다.

Auth SDK

인스턴스 이벤트 설명

CXoneAuth.instance

onAuthStatusChange

사용자 인증 상태 변경을 수신하는 옵저버블입니다.

이벤트 유형에는 AUTHENTICATED,AUTHENTICATING, NOT_AUTHENTICATED, AUTHENTICATION_FAILED, REFRESH_TOKEN_SUCCESS가 포함됩니다.

디지털 SDK

인스턴스 이벤트 설명

CXoneDigitalClient.instance.digitalContactManager

onDigitalContactEvent

디지털 컨택과 관련된 이벤트를 수신 대기합니다.

이벤트 유형에는 CASE_INBOX_ASSIGNEE_CHANGED, CASE_STATUS_CHANGED, MESSAGE_ADDED_INTO_CASE, CASE_INBOX_ASSIGNED, CASE_INBOX_UNASSIGNED, MESSAGE_CREATED, MESSAGE_NOTE_CREATED, MESSAGE_NOTE_DELETED, MESSAGE_NOTE_UPDATED, MESSAGE_UPDATED, SENDER_TYPING_START, SENDER_TYPING_END, MESSAGE_PREVIEW가 포함됩니다.

 

onDigitalContactNewMessageEvent

디지털 컨택의 새 메시지를 수신 대기합니다.

 

onDigitalContactUserTypingPreviewEvent

디지털 컨택에서 입력 미리 보기 이벤트를 수신합니다.

이벤트 유형에는 CASE_INBOX_ASSIGNEE_CHANGED, CASE_STATUS_CHANGED, MESSAGE_ADDED_INTO_CASE, CASE_INBOX_ASSIGNED, CASE_INBOX_UNASSIGNED, MESSAGE_CREATED, MESSAGE_NOTE_CREATED, MESSAGE_NOTE_DELETED, MESSAGE_NOTE_UPDATED, MESSAGE_UPDATED, SENDER_TYPING_START, SENDER_TYPING_END, MESSAGE_PREVIEW가 포함됩니다.

Voice SDK

인스턴스 이벤트 설명

CXoneVoiceClientWrapper.instance

onCallStatusChanged

통화 상태 변경과 관련된 이벤트를 처리합니다.

 

onConnectionStatusChanged

음성 연결 상태 변경과 관련된 이벤트를 처리합니다.