Microsoft CIFramework는 JavaScript API를 사용하여 Dynamics 365 모델 기반 앱에서 통신 패널(위젯), 알림, 응용 프로그램 탭, 세션, 레코드 및 양식을 관리하는 메서드를 제공합니다.
중요합니다
- API는 조직에 구성된 활성 채널 공급자에서만 지원됩니다.
- 다른 API를 호출하기 전에 CIFInitDone 이벤트 처리기를 호출해야 합니다.
- API의 제한시간 제한은 100초입니다. API가 100초 이내에 실행되지 않으면 변경된 매개 변수 또는 범위로 다시 실행해야 합니다.
통신 패널 관리 API
커뮤니케이션 패널은 상담원이 고객과 상호 작용하는 곳입니다. 채널 통합 프레임워크 2.0을 사용하여 빌드된 파트너 위젯이 이 패널에 로드됩니다. 이 버전의 위젯은 세션 패널의 왼쪽에 표시되며 도킹, 최소화 및 숨김 모드를 지원합니다.
다음 API를 사용하여 통신 패널(위젯)의 상태를 관리합니다.
| 메서드 | Description |
|---|---|
| setWidth | 모든 세션의 패널 폭을 설정합니다. |
| getWidth | 패널 너비를 픽셀 단위로 가져옵니다. |
| 설정 모드 | 패널의 상태를 설정합니다. |
| get모드 | 패널의 상태를 설정합니다. |
CRUD 작업 API
다음 API를 사용하여 엔터티 레코드에 대한 CRUD 작업을 수행합니다.
| 메서드 | Description |
|---|---|
| 레코드 만들기 | 엔터티 레코드를 만듭니다. |
| 레코드 검색(retrieveRecord) | 엔터티 레코드를 검색합니다. |
| 업데이트 레코드 | 엔터티 레코드를 업데이트합니다. |
| 삭제기록 | 엔터티 레코드를 삭제합니다. |
알림 관리 API
다음 API를 사용하여 들어오는 대화에 대한 알림을 표시하거나 취소합니다.
| 메서드 | Description |
|---|---|
| 알림이벤트 | 들어오는 대화에 대해 상담원에게 알리는 데 사용할 수 있는 알림을 표시합니다. |
| 취소이벤트 | 메서드에 notifyEvent 지정된 대로 취소 토큰을 기반으로 알림을 숨기거나 취소합니다. |
애플리케이션 탭 관리 API
다음 API를 사용하여 애플리케이션 탭의 상태를 만들고 관리합니다.
| 메서드 | Description |
|---|---|
| createTab | 포커스 세션에서 탭을 만들고 생성된 탭의 고유 식별자를 반환합니다. |
| getTabs | 세션이 채널 공급자에 속하는 경우 포커스가 있는 세션의 탭에 대한 템플릿 이름 또는 템플릿 태그와 연결된 탭 식별자 배열을 반환합니다. |
| 초점탭 | 포커스가 있는 세션이 채널 공급자에 속하고 탭이 포커스가 있는 세션에 속하는 경우 탭에 포커스를 설정합니다. |
| getFocusedTab | 세션이 공급자에 속하는 경우 포커스가 있는 세션에서 탭 식별자를 반환합니다. |
| refresh탭 | 탭을 새로 고칩니다. |
| setTab제목 | 포커스가 있는 세션이 채널 공급자에 속하고 탭이 포커스가 있는 세션에 속하는 경우 탭의 제목을 설정합니다. |
| 닫기 탭 | 현재 세션에서 지정된 탭을 닫습니다. |
세션 관리 API
다음 API를 사용하여 다중 세션 공급자 환경에서 세션을 관리합니다.
| 메서드 | Description |
|---|---|
| canCreate세션 | 새 세션을 만들 수 있는지 확인할 수 있습니다. |
| createSession | 템플릿의 일부로 정의된 세션 템플릿을 기반으로 세션을 만들고 생성된 세션의 고유 식별자를 반환합니다. |
| get세션 | 세션이 채널 공급자에 속하는 경우 세션의 고유 식별자, 컨텍스트 및 매개 변수 값을 isFocused 포함하는 개체를 반환합니다. |
| getFocusedSession | 포커스가 있는 세션의 고유 식별자를 반환합니다(채널 공급자에 속하는 경우 그렇지 않으면 null을 반환합니다. |
| getAll세션 | 채널 공급자에 대한 세션 식별자 배열을 반환합니다. |
| set세션 제목 | 세션이 채널 공급자에 속하는 경우 세션 제목을 설정합니다. |
| 요청 포커스 세션 | 세션이 채널 공급자에 속하는 경우 세션 식별자가 매개 변수로 전달되는 세션에 포커스를 설정합니다. |
채널 분석 API
다음 API를 사용하여 이벤트 분석을 추적합니다.
| 메서드 | Description |
|---|---|
| logAnalytics이벤트 | 이 메서드를 호출하여 사용자 지정 이벤트에 대한 분석을 기록합니다. |
세션 표시기 API
다음 API를 사용하여 핵심 성과 지표(KPI) 위반을 나타내고 특정 세션의 새 활동 수를 업데이트합니다.
| 메서드 | Description |
|---|---|
| notifyKpiBreach | 이 메서드는 KPI 위반을 나타내는 데 사용됩니다. 이 방법을 사용하면 KPI 위반이 발생했을 때 연락처의 디스플레이 이미지에 빨간색 원이 나타납니다. |
| notifyNewActivity | 이 메서드는 특정 세션의 새 활동 수를 업데이트하는 데 사용됩니다. |
현재 상태 API
이러한 API를 사용하여 프로그래밍 방식으로 옴니채널 에이전트 현재 상태를 설정하고 검색합니다. 혼합 에이전트가 옴니채널을 사용하여 타사 응용 프로그램에서 작업 중이고 에이전트 용량이 최적으로 활용되도록 서로 다른 응용 프로그램 간의 현재 상태 상태를 동기화하려는 경우 이러한 방법을 사용할 수 있습니다.
| 메서드 | Description |
|---|---|
| setPresence | 클라이언트 세션에서 에이전트에 대해 프로그래밍 방식으로 현재 상태를 설정할 수 있습니다. |
| getPresence | 클라이언트 세션에서 에이전트에 대해 프로그래밍 방식으로 현재 상태를 반환할 수 있습니다. |
기타 방법
| 메서드 | Description |
|---|---|
| getEntity메타데이터 | 지정된 엔터티에 대한 엔터티 메타데이터를 반환합니다. |
| 클릭으로작동설정 | 아웃바운드 통신을 활성화하거나 비활성화하는 부울 값을 설정합니다(ClickToAct). |
| getClickToAct | 아웃바운드 통신(ClickToAct)을 사용할 수 있는지 여부를 나타내는 부울 값을 반환합니다. |
| searchAndOpenRecords | 이 메서드는 인바운드 통신 중에 통신 위젯에서 레코드를 검색하고 레코드를 엽니다. |
| get환경 | 현재 통합 인터페이스 앱 및 페이지 세부 정보를 가져옵니다. 세부 정보에는 애플리케이션 ID(appid), pageType(pageType), 레코드 ID(id), 조직 지역(orgGeo) 및 세션 탐색 유형(navigationType)이 포함됩니다. |
| 열기 양식 | 엔터티 양식 또는 빠른 만들기 양식을 엽니다. |
| 렌더링 검색 페이지 | 특정 엔터티 유형의 레코드 중에서 검색할 수 있습니다. 이 API는 매개 변수로 전달된 검색 문자열로 미리 채워진 검색 필드가 있는 통합 인터페이스 엔터티 페이지를 엽니다. |
| add핸들러 | 구독자를 이벤트에 추가합니다.
비고 이 API는 위젯과 통합 인터페이스 페이지 모두에서 사용할 수 있습니다. |
| 제거핸들러 | 이벤트에서 구독자를 제거합니다.
비고 이 API는 위젯과 통합 인터페이스 페이지 모두에서 사용할 수 있습니다. |
| 이벤트 발생 | 이벤트에 대해 연결된 구독자를 호출합니다.
비고 addHandler 메서드를 사용하여 사용자 지정 이벤트를 만든 경우 이 메서드에서 이벤트 이름을 매개 변수로 전달하여 해당 이벤트를 발생시킬 수 있습니다. |
| update컨텍스트 | 이 방법을 사용하면 자동화 사전을 설정할 수 있습니다. |
| update대화 | 이 방법을 사용하면 대화 기록을 업데이트할 수 있습니다. |
관련 정보
Dynamics 365 채널 통합 프레임워크의 새로운 기능
Dynamics 365 Channel Integration Framework 2.0의 시스템 요구 사항