--- sourceDocument: 호주 API 참조 sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ko-KR/api-reference Release : - australia ft:locale : - ko-KR ft:publication_title : - 호주 API 참조 ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # openFrameAPI - 클라이언트 # openFrameAPI - 클라이언트 {#ariaid-title1} * 릴리스 버전: Australia * * 업데이트 날짜 2026년 03월 12일 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 소요 시간: 76분 openFrameAPI는 OpenFrame과 상호 작용하는 메서드를 제공합니다. OpenFrame은 통신 파트너가 시스템을 플랫폼에 통합하는 데 사용할 수 있는 편재 프레임입니다.ServiceNow 핵심 요구 사항 중 하나는 파트너 하위 시스템과 원활하게 연결할 수 있는 다양한 도메인의 코드를 연결하고 제공하는 기능입니다. 도메인 간 문제없이 통신 시스템에 등록된 연결 및 콜백을 유지하려면 이러한 도메인 간 연결이 필요합니다. OpenFrame에는 두 가지 중요한 부분이 있습니다. 하나는 애플리케이션(TopFrame이라고 함)과 파트너 애플리케이션에서 소싱된 이 API에 ServiceNow 상주합니다. 이 API에는 TopFrame과 통신하고 [OpenFrame](https://www.servicenow.com/docs/access?context=c_OpenFrameOverview&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)의 시각적 기능을 제어하는 데 필요한 메서드가 있습니다. 주: 최신 OpenFrame 라이브러리 참조가 필요한 경우 다음 자원 URI를 사용합니다. https://\[servicenow instance\]/scripts/openframe/latest/openFrameAPI.min.js. ## openFrameAPI - getAWAAgentPresence(문자열 성공, 문자열 실패) {#ariaid-title2} 로그인한 에이전트의 현재 현재 상태를 반환합니다. {#openFrameAPI-getAWAPresense_S_S__table_z1t_mgn_sbc__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 성공 | 문자열 | 메서드가 성공하면 호출할 콜백 함수의 이름입니다. | | 실패 | 문자열 | 메서드가 실패할 경우 호출할 콜백 함수의 이름입니다. | [표 1. 매개변수] {#openFrameAPI-getAWAPresense_S_S__table_z1t_mgn_sbc} {#openFrameAPI-getAWAPresense_S_S__table_abt_mgn_sbc__entry__2} | 유형 | 설명 | |-|-| | 현재 상태 | OpenFrame 인프라에서 성공 콜백 함수에 전달한 결과입니다. 데이터 유형: 객체 "presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" } | | 존재.사용 가능 | 연결된 에이전트를 사용할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 에이전트를 사용할 수 있습니다. * false: 에이전트를 사용할 수 없습니다. 데이터 유형: 부울 | | 존재 상태.채널 | 에이전트와 통신할 수 있는 사용 가능한 채널 목록입니다. 데이터 유형: 객체 배열 "channels": [ { "available": Boolean, "name": "String", "restrict_update": Boolean, "service_channel_type": "String", "sys_id": "String" } ] | | 존재 상태.채널.사용 가능 | 채널을 사용할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 채널을 사용할 수 있습니다. * false: 채널을 사용할 수 없습니다. 데이터 유형 부울 | | presence.channels.name | 채팅 또는 전화와 같은 채널의 이름입니다. 데이터 유형: 문자열 | | presence.channels.restrict_update | 사용자가 채널에 대한 업데이트를 제한할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 사용자가 채널에 대한 업데이트를 제한할 수 있습니다. * false: 사용자가 채널에 대한 업데이트를 제한할 수 없습니다. 데이터 유형 부울 | | presence.channels.service_channel_type | 서비스 채널의 유형입니다. 데이터 유형: 문자열 | | presence.channels.sys_id | 채널 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 서비스 채널 \[awa_service_channel\] | | presence.name | 에이전트의 현재 상태 이름입니다. 데이터 유형: 문자열 | | presence.sys_id | 현재 상태 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 현재 상태 \[awa_presence_state\] | [표 2. 반환] {#openFrameAPI-getAWAPresense_S_S__table_abt_mgn_sbc} 다음 코드 예제에서는 이 메서드를 호출하는 방법을 보여 줍니다. function failure(data) { console.log("failure: " + JSON.stringify(data)); } function success(data) { console.log("success: " + JSON.stringify(data)); } openFrameAPI.getAWAAgentPresence(success, failure) 성공 콜백 함수에 대한 응답: success: { "presence": { "name": "Available", "sys_id": "0b10223c57a313005baaaa65ef94f970", "available": true, "channels": [ { "name": "Chat", "available": true, "sys_id": "27f675e3739713004a905ee515f6a7c3", "restrict_update": false, "service_channel_type": "chat" } ] } } ## openFrameAPI - 숨기기() {#ariaid-title3} TopFrame에서 OpenFrame을 숨깁니다. {#r_openFrameAPI-hide__table_yzb_mxx_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 안 함 | | | [표 3. 매개변수] {#r_openFrameAPI-hide__table_yzb_mxx_kt} {#r_openFrameAPI-hide__table_zzb_mxx_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 4. 반환] {#r_openFrameAPI-hide__table_zzb_mxx_kt} openFrameAPI.hide() ## openFrameAPI - init(객체 구성, 함수 successCallback, 함수 failureCallback) {#ariaid-title4} OpenFrame을 초기화합니다. 호출하는 첫 번째 메서드여야 합니다. 이 메서드는 TopFrame에 대한 통신을 초기화하고 매개 변수에 config 전달된 모든 시각적 요소를 초기화합니다. {#r_openFrameAPI-init_Object_Object_Object__table_vz3_jyw_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 구성 | 객체 | 초기화 프로세스 중에 사용할 이름-값 쌍입니다. 가능한 키: * height * subTitle * 직위 * 제목 아이콘 * width 모든 키는 선택 사항입니다. 이러한 키-값 쌍을 설정하지 않으려면 빈 객체를 전달합니다. | | successCallback | 함수 | init 메서드가 성공할 경우 사용할 콜백 함수의 이름입니다. 시스템에 저장된 [OpenFrame 구성](https://www.servicenow.com/docs/access?context=t_CreateAnOpenFrameConfiguration&version=australia&pubname=australia-customer-service-management&ft:locale=en-US) 은 콜백 함수에 대한 매개변수로 전달됩니다. | | 실패콜백 | 함수 | init 메서드가 실패할 경우 사용할 콜백 함수의 이름입니다. | [표 5. 매개변수] {#r_openFrameAPI-init_Object_Object_Object__table_vz3_jyw_kt} {#r_openFrameAPI-init_Object_Object_Object__table_wz3_jyw_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 6. 반환] {#r_openFrameAPI-init_Object_Object_Object__table_wz3_jyw_kt} var config = { height: 300, width: 200 } function handleCommunicationEvent(context) { console.log("Communication from Topframe", context); } function initSuccess(snConfig) { console.log("openframe configuration", snConfig); //register for communication event from TopFrame openFrameAPI.subscribe(openFrameAPI.EVENTS.COMMUNICATION_EVENT, handleCommunicationEvent); } function initFailure(error) { console.log("OpenFrame init failed...", error); } openFrameAPI.init(config, initSuccess, initFailure); ## openFrameAPI - isVisible(함수 콜백) {#ariaid-title5} OpenFrame이 탑프레임에 표시되는지 확인합니다. {#r_openFrameAPI-isVisible_Object_Object__table_zdj_ygy_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 콜백 | 함수 | 콜백 함수는 true 또는 false 값을 가진 매개변수를 수신합니다. OpenFrame이 표시되면 True이고 표시되지 않으면 False입니다. | [표 7. 매개변수] {#r_openFrameAPI-isVisible_Object_Object__table_zdj_ygy_kt} {#r_openFrameAPI-isVisible_Object_Object__table_a2j_ygy_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 8. 반환] {#r_openFrameAPI-isVisible_Object_Object__table_a2j_ygy_kt} function callback(isVisible) { console.log(isVisible) } openFrameAPI.isVisible(callback) ## openFrameAPI - openCustomURL(문자열 상세 정보) {#ariaid-title6} UI16 인터페이스에서 사용자 지정 URL을 엽니다. {#r_openFrameAPI-openCustomURL__table_ob3_ryd_lt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | URL | 문자열 | 사용자 지정 URL의 텍스트입니다. 최대 크기: 2083자 | [표 9. 매개변수] {#r_openFrameAPI-openCustomURL__table_ob3_ryd_lt} {#r_openFrameAPI-openCustomURL__table_pb3_ryd_lt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 10. 반환] {#r_openFrameAPI-openCustomURL__table_pb3_ryd_lt} openFrameAPI.openCustomURL('10_cool_things.do'); ## openFrameAPI - openServiceNowForm(객체 상세 정보) {#ariaid-title7} 양식 URL을 엽니다. 에이전트가 걸려오는 전화를 받으면 OpenFrame 창에 계정, 접촉 창구 또는 소비자와 같은 정보가 표시됩니다. OpenFrame 창에서 링크를 클릭하면 해당 기록이 표시됩니다. * 플랫폼 인터페이스에서 이 API는 TopFrame에서 양식 URL을 엽니다. * 의 경우 에이전트 작업 공간이 API는 상호작용 탭 관리를 지원합니다. 에서 에이전트 작업 공간상호작용 기록은 상위 탭에서 열리고 지정된 엔터티 기록은 상호작용 탭 아래의 하위 탭에서 열립니다. {#r_openFrameAPI-openServiceNowForm_Object__ul_mwy_4nc_lhb} {#r_openFrameAPI-openServiceNowForm_Object__table_ulq_vwd_lt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 세부사항 | 객체 | 열 양식 URL을 식별하는 키-값 쌍입니다. "details": { "entity": "String"; "interaction_sys_id": "String"; "query": "String" } | | 상세.엔터티 | 문자열 | 테이블 또는 엔터티 이름입니다. | | details.interaction_sys_id | 문자열 | 옵션입니다. 에서 상위 탭 에이전트 작업 공간으로 열 상호작용 기록의 Sys_id입니다. 주: 플랫폼 인터페이스에서는 무 interaction_sys_id 시됩니다. | | details.query | 문자열 | 열 기록을 식별하는 쿼리입니다(예: `query:'sys_id='`). | [표 11. 매개변수] {#r_openFrameAPI-openServiceNowForm_Object__table_ulq_vwd_lt} {#r_openFrameAPI-openServiceNowForm_Object__table_vlq_vwd_lt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 12. 반환] {#r_openFrameAPI-openServiceNowForm_Object__table_vlq_vwd_lt} 다음 예는 플랫폼의 기본 사용법을 보여줍니다. openFrameAPI.openServiceNowForm({entity:'customer_account', query:'sys_id=447832786f0331003b3c498f5d3ee452', 'interaction_sys_id':'3be092313b711300758ce9b534efc4dd'}); 다음 예제에서는 매개변수를 query 사용하여 sysparm_query 및 인코딩된 쿼리를 사용하여 작업 공간의 이름과 성 필드를 채우는 방법으로 양식에 제공된 데이터로 새 기록을 만드는 방법을 보여줍니다. openFrameAPI.openServiceNowForm({ entity: 'sys_user', query: 'sys_id=-1&sysparm_query=first_name=Ivan^last_name=Greggor' }); ## openFrameAPI - openServiceNowFormwithChildTab() {#ariaid-title8} 작업 공간에서 호출되는 경우 하위 탭이 있는 양식을 열 ServiceNow 거나 UI16 인터페이스에서 호출되는 경우 엔터티를 엽니다. {#openFrameAPI-openSNFormwithChildTab__table_j13_hwv_hyb__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | openServiceNowFormwithChildTab | 객체 | API가 작업 공간에서 호출된 경우 하위 탭이 있는 양식을 열 ServiceNow 는지 또는 UI16 인터페이스에서 호출된 경우 엔터티를 열지 정의합니다. openFrameAPI.openServiceNowFormwithChildTab({ entity: "String", sys_id: String", parent_entity: "String", parent_entity_sys_id: "String" }) | | openServiceNowFormwithChildTab.entity | 문자열 | 오픈할 기록이 들어 있는 테이블의 이름입니다. | | openServiceNowFormwithChildTab.sys_id | 문자열 | 오픈할 기록의 Sys_id입니다. | | openServiceNowFormwithChildTab.parent_entity | 문자열 | 상위 탭으로 열 테이블의 이름입니다. | | openServiceNowFormwithChildTab.parent_entity_sys_id | 문자열 | 오픈할 상위 기록의 Sys_id입니다. | [표 13. 매개변수] {#openFrameAPI-openSNFormwithChildTab__table_j13_hwv_hyb} {#openFrameAPI-openSNFormwithChildTab__table_k13_hwv_hyb__entry__2} | 유형 | 설명 | |-|-| | 없음 | | [표 14. 반환] {#openFrameAPI-openSNFormwithChildTab__table_k13_hwv_hyb} 다음 예에서는 구성된 작업 공간에서 상위 엔터티를 상위 탭으로 열거나, UI16에서 호출되는 경우 엔터티만 엽니다. openFrameAPI.openServiceNowFormwithChildTab({ entity: "customer_account", sys_id: "447832786f0331003b3c498f5d3ee452", parent_entity: "interaction", parent_entity_sys_id: "3be092313b711300758ce9b534efc4dd" }); ## openFrameAPI - openServiceNowList(객체 상세 정보) {#ariaid-title9} UI16 인터페이스에서 목록 URL을 엽니다. {#r_openFrameAPI-openServiceNowList_Object__table_fpq_5xd_lt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 세부사항 | 객체 | 목록 URL을 열 때 사용할 콘텐츠를 설명하는 키 값 쌍입니다. 유효한 값은 다음과 같습니다. * 엔터티: 테이블 이름 * query: [인코딩된 쿼리 문자열](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=australia&pubname=australia-platform-user-interface&ft:locale=en-US) {#r_openFrameAPI-openServiceNowList_Object__ul_ndm_fxd_lt} | [표 15. 매개변수] {#r_openFrameAPI-openServiceNowList_Object__table_fpq_5xd_lt} {#r_openFrameAPI-openServiceNowList_Object__table_gpq_5xd_lt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 16. 반환] {#r_openFrameAPI-openServiceNowList_Object__table_gpq_5xd_lt} openFrameAPI.openServiceNowList({entity:'case', query:'active=true'}); ## openFrameAPI - setFrameMode(모드) {#ariaid-title10} OpenFrame 모드를 설정합니다. 이 API에 전달된 모드: * 헤더에 적절한 아이콘 설정(축소 또는 확장) * CTI에 대한 관련 이벤트를 발생시킵니다. * openFrameAPI.EVENTS.COLLAPSE * openFrameAPI.EVENTS.EXPAND {#r_openFrameAPI-setFrameMode__ul_sjp_rgw_5fb} {#r_openFrameAPI-setFrameMode__ul_vnq_4gw_5fb} {#r_openFrameAPI-setFrameMode__table_yzb_mxx_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 모드 | 문자열 | OpenFrame 모드를 설정합니다. 열거된 옵션: 1. openFrameAPI.FRAME_MODE. 축소 2. openFrameAPI.FRAME_MODE. 펼치기 {#r_openFrameAPI-setFrameMode__ol_yjp_3gw_5fb} | [표 17. 매개변수] {#r_openFrameAPI-setFrameMode__table_yzb_mxx_kt} {#r_openFrameAPI-setFrameMode__table_zzb_mxx_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 18. 반환] {#r_openFrameAPI-setFrameMode__table_zzb_mxx_kt} openFrameAPI.setFrameMode(openFrameAPI.FRAME_MODE.COLLAPSE); ## openFrameAPI - setHeight(height) {#ariaid-title11} OpenFrame 높이를 설정합니다. {#r_openFrameAPI-setHeight__table_yzb_mxx_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 높이 | 번호 | 높이(픽셀) | [표 19. 매개변수] {#r_openFrameAPI-setHeight__table_yzb_mxx_kt} {#r_openFrameAPI-setHeight__table_zzb_mxx_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 20. 반환] {#r_openFrameAPI-setHeight__table_zzb_mxx_kt} openFrameAPI.setHeight(100); ## openFrameAPI - setICContext(문자열 유형, 객체 \<컨텍스트\>) {#ariaid-title12} 클라이언트의 상호작용 통제와 관련된 컨텍스트 데이터를 설정합니다. 이 컨텍스트 데이터를 사용하여 OpenFrame에 표시할 클라이언트 UI를 결정합니다. 대화형 컨트롤에 대한 자세한 내용은 다음 문서를 참조하십시오 [Interaction Controls Component (ICC) for voice calls](https://www.servicenow.com/docs/access?context=contact-center-integration-with-icc&version=australia&pubname=australia-customer-service-management&ft:locale=en-US). 상호작용 기록에 대한 자세한 내용은 다음 문서를 참조하십시오 [CSM voice interaction record page](https://www.servicenow.com/docs/access?context=csm-native-voice-record-page&version=australia&pubname=australia-customer-service-management&ft:locale=en-US). {#openFrameAPI-setICContext_S_O__table_xlq_rhg_zdc__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | \<컨텍스트\> | 객체 | 설정할 컨텍스트 데이터입니다. 각 컨텍스트 데이터 유형은 고유한 입력 데이터 세트입니다. 유효한 Context 데이터 객체: * `activeCall` * `idleState` * `제공 컨텍스트` * `searchTargetList` {#openFrameAPI-setICContext_S_O__ul_dhy_sv5_w3c} | | activeCall | 객체 배열 | 활성 호출에 대한 컨텍스트 상세 정보입니다. 각 객체는 진행 중인 활성 호출을 나타냅니다. "activeCall": [ { "callbackContext": {Object}, "currentParticipant": {Object}, "customPayload: {Object}, "direction": "String", "externalId": "String", "nowRecordId": "String", "nowRecordTable": "String", "participants": [Array], "type": "String" } ] | | activeCall.callbackContext | 객체 | 속성이 activeCall.type콜백인 경우에만 사용됩니다. 진행 중인 콜백 구성요소에 대한 콜백 컨텍스트 정보입니다. "callbackContext": { "callAttemptedByAgent": Boolean, "callbackNumbers": [Array], "closeInEndTime": "String", "customerName": "String", "dialInEndTime": "String" } | | activeCall입니다. callbackContext입니다. callAttemptedByAgent | 부울 | 고객 서비스 에이전트가 콜백을 시도했는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 고객 서비스 에이전트가 콜백을 시도했습니다. 예일 closeInEndTime경우 . * false: 고객 서비스 에이전트가 콜백을 시도하지 않았습니다. false dialInEndTime인 경우 . {#openFrameAPI-setICContext_S_O__ul_dgl_cyx_nhc} 기본값: false | | activeCall입니다. callbackContext입니다. 콜백 번호 | 배열 | 문자열로 제공되는 전화번호 목록입니다. | | activeCall입니다. callbackContext입니다. closeInEndTime | 문자열 | 예인 경우에만 callAttemptedByAgent 설정됩니다. UTC 형식의 콜백 종료 시간입니다. | | activeCall입니다. callbackContext입니다. 고객 이름 | 문자열 | 고객의 이름입니다. | | activeCall입니다. callbackContext입니다. dialInEndTime | 문자열 | 가 false이고 콜백 유형이 자동 다이얼인 경우에만 callAttemptedByAgent 설정됩니다. UTC 형식의 콜백에 대한 전화 접속 종료 시간입니다. | | activeCall.currentParticipant | 객체 | 필수 현재 참가자의 통화 역량 및 통화 상태에 대한 상세 정보입니다. "currentParticipant": { "actor": "String", "callStartTime": "String", "capabilities": {Object}, "connectedTime": "String", "custom-capability-state-1": Boolean, "flagged": Boolean, "held": Boolean, "id": "String", "muted": Boolean, "name": "String", "paused": Boolean, "recording": "String", "state": "String", "wrapUP": {Object} } | | activeCall.currentParticipant.actor | 문자열 | 통화 참가자의 유형입니다. 유효한 값은 다음과 같습니다. * 에이전트 {#openFrameAPI-setICContext_S_O__ul_khy_sv5_w3c} 주: 향후 추가될 다른 참가자 유형입니다. | | activeCall.currentParticipant.callStartTime | 문자열 | 호출이 시작된 날짜 및 시간입니다. 시간 표준: UTC 형식: RSS - "\<요일\>, dd mmm yyyy hh:MM:ss GMT" 예: "Wed, 17 Dec 2024 05:23:41 GMT" | | activeCall.currentParticipant.capabilities | 객체 | 현재(에이전트) 참가자가 통화 중에 수행할 수 있는 역량에 대한 상세 정보입니다. 연결된 아이콘은 활성화된 역량에 대한 활성 통화 구성요소에 나타납니다.
"capabilities": { "callbackTransferStatus": "String", "cancelCallbackTransferEligible": Boolean, "closeCallback": Boolean, "dtmf": Boolean, "endCall": Boolean, "flag": Boolean, "hold": Boolean, "initiateCall": Boolean, "leaveAndTransfer": Boolean, "mergeCall": Boolean, "mute": Boolean, "resumeRecording": Boolean, "pauseRecording": Boolean, "startRecording": Boolean, "stopRecording": Boolean, "transfer": Boolean } | | activeCall.currentParticipant.capabilities.callbackTransferStatus | 문자열 | CCaaS(연락처 센터 서비스) 콜백 전송 상태입니다. 가능한 값: * 실패함 * 빈 문자열(기본값) {#openFrameAPI-setICContext_S_O__ul_fdl_yqk_4hc} | | activeCall.currentParticipant.capabilities.cancelCallbackTransferEligible | 부울 | 콜백 전송 취소 옵션이 활성화되어 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 콜백 전송 취소 옵션이 활성화되었습니다. * false: 콜백 전송 취소 옵션이 비활성화되었습니다. {#openFrameAPI-setICContext_S_O__ul_afz_gmk_4hc} 기본값: false | | activeCall.currentParticipant.capabilities.closeCallback | 부울 | 콜백 닫기 버튼이 활성화되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 콜백 닫기 버튼이 활성화되었습니다. * false: 콜백 닫기 버튼이 비활성화되었습니다. {#openFrameAPI-setICContext_S_O__ul_pcf_hmk_4hc} 기본값: false | | activeCall.currentParticipant.capabilities입니다.DTMF | 부울 | 에이전트에 현재 통화에 대한 DTMF(Dual Tone Multi-Frequency) 기능이 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자에게 DTMF 기능이 있습니다. * false: 참가자에게 DTMF 역량이 없습니다. {#openFrameAPI-setICContext_S_O__ul_mhy_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities입니다.엔드콜 | 부울 | 연결된 참가자가 통화를 종료할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 통화를 종료할 수 있습니다. 통화 종료 버튼은 UI에서 활성화됩니다. * false: 참가자가 통화를 종료할 수 없습니다. UI에서 통화 종료 버튼이 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_ohy_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities입니다.기 | 부울 | 참가자가 음성 품질 문제와 같은 품질 문제에 대해 통화에 플래그를 지정할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 문제 호출에 플래그를 지정할 수 있습니다. * false: 참가자가 문제 호출을 플래그할 수 없습니다. {#openFrameAPI-setICContext_S_O__ul_shy_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities입니다.들다 | 부울 | 참가자가 호출을 보류할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 호출을 보류할 수 있습니다. 보류 버튼은 UI에서 활성화됩니다. * false: 참가자가 호출을 보류할 수 없습니다. UI에서 보류 버튼이 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_uhy_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities.initiateCall | 부울 | 연결된 참가자가 통화를 시작할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 통화를 시작할 수 있습니다. 통화 시작 버튼은 UI에서 활성화됩니다. * false: 참가자가 통화를 시작할 수 없습니다. UI에서 통화 시작 버튼이 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_tm3_4lk_4hc} 기본값: false | | activeCall.currentParticipant.capabilities입니다.leaveAndTransfer | 부울 | 참가자가 다른 에이전트에게 통화를 전환한 다음 통화를 끊을 수 있는지 여부를 나타내는 플래그입니다. 상담 전환과 같이 상담 대상자가 호출의 소유자가 아닌 작업에 대해 이 기능을 활성화합니다. 유효한 값은 다음과 같습니다. * true: 참가자가 통화를 전환 및 해제할 수 있습니다. * false: 참가자가 통화를 전환 및 해제할 수 없습니다. {#openFrameAPI-setICContext_S_O__ul_yhy_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities입니다.mergeCall | 부울 | 참가자가 콜을 병합할 수 있는지 여부를 나타내는 플래그입니다. 참가자의 호출 레그를 병합할 수 있는 경우 이 기능을 사용합니다. 유효한 값은 다음과 같습니다. * true: 참가자가 콜을 병합할 수 있습니다. 병합 버튼은 UI에서 활성화됩니다. * false: 참가자가 통화를 병합할 수 없습니다. UI에서 병합 버튼이 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_a3y_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities입니다.음소거 | 부울 | 참가자가 통화를 음소거할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 호출을 음소거할 수 있습니다. 음소거 버튼은 UI에서 활성화되어 있습니다. * false: 참가자가 호출을 음소거할 수 없습니다. UI에서 음소거 버튼은 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_e3y_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities입니다.pauseRecording | 부울 | 참가자가 통화 기록을 일시 중지할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 통화 기록을 일시 중지할 수 있습니다. 기록 일시 중지 버튼은 UI에서 활성화됩니다. * false: 참가자가 통화 기록을 일시 중지할 수 없습니다. 기록 일시 중지 버튼은 UI에서 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_h3y_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities입니다.재개녹화 | 부울 | 참가자가 통화 녹음을 다시 시작할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 통화 녹음을 다시 시작할 수 있습니다. 기록 일시 중지 버튼은 UI에서 활성화됩니다. * false: 참가자가 통화 녹음을 다시 시작할 수 없습니다. 기록 일시 중지 버튼은 UI에서 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_l3y_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities입니다.startRecording | 부울 | 참가자가 통화 녹음을 시작할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 통화 녹음을 시작할 수 있습니다. 기록 버튼은 UI에서 활성화되어 있습니다. * false: 참가자가 통화 녹음을 시작할 수 없습니다. UI에서 기록 버튼이 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_p3y_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities입니다.녹화 중지 | 부울 | 참가자가 통화 녹음을 중지할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 통화 녹음을 중지할 수 있습니다. 기록 중지 버튼은 UI에서 활성화됩니다. * false: 참가자가 통화 녹음을 중지할 수 없습니다. 기록 중지 버튼은 UI에서 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_t3y_sv5_w3c} 기본값: false | | activeCall.currentParticipant.capabilities입니다.갈아타다 | 부울 | 참가자가 콜을 전환할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 콜을 전환할 수 있습니다. 전송 버튼은 UI에서 활성화됩니다. * false: 참가자가 콜을 전환할 수 없습니다. UI에서 전송 버튼이 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_w3y_sv5_w3c} 기본값: false | | activeCall.currentParticipant.connectedTime | 문자열 | 콜이 처음 연결된 날짜 및 시간입니다. 타임베이스: UTC 형식: RSS - "\<요일\>, dd mmm yyyy hh:MM:ss GMT" 예: "Wed, 17 Dec 2024 05:23:41 GMT" | | activeCall.currentParticipant.custom-capability-state-1 | 부울 | 통화에 현재 참가자가 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 현재 통화 참가자입니다. * false: 현재 통화 참가자가 없습니다. {#openFrameAPI-setICContext_S_O__ul_ajy_sv5_w3c} 기본값: false | | activeCall.currentParticipant.flagged | 부울 | 통화에 음성 품질 문제와 같은 문제에 대해 플래그가 지정되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 호출에 문제가 있는 플래그가 지정되었습니다. * false: 호출에 문제에 대한 플래그가 지정되지 않았습니다. {#openFrameAPI-setICContext_S_O__ul_cjy_sv5_w3c} 기본값: false | | activeCall.currentParticipant.held | 부울 | 참가자의 보류 상태를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 보류 중입니다. * false: 참가자가 보류 중이 아닙니다. {#openFrameAPI-setICContext_S_O__ul_fjy_sv5_w3c} 기본값: false | | activeCall.currentParticipant.id | 문자열 | 필수 에이전트의 sys_id와 같은 연결된 참가자 기록의 Sys_id입니다. 테이블: 사용자 \[sys_user\] | | activeCall.currentParticipant.muted | 부울 | 참가자의 음소거 상태를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 음소거됩니다. * false: 참가자가 음소거되지 않았습니다. {#openFrameAPI-setICContext_S_O__ul_bhv_vd4_zdc} 기본값: false | | activeCall.currentParticipant.name | 문자열 | 참가자의 이름입니다. | | activeCall.currentParticipant.paused | 부울 | 참가자의 일시 중지 상태를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 일시 중지되었습니다. * false: 참가자가 일시 중지되지 않았습니다. {#openFrameAPI-setICContext_S_O__ul_hjy_sv5_w3c} 기본값: false | | activeCall.currentParticipant.recording | 문자열 | 통화의 현재 기록 상태입니다. 유효한 값은 다음과 같습니다. * in_progress * 없음 {#openFrameAPI-setICContext_S_O__ul_ijy_sv5_w3c} | | activeCall.currentParticipant.wrapUP | 객체 | 향후 사용. | | activeCall.customPayload | 객체 | OpenFrame 이벤트의 일부로 OpenFrame에 전달할 사용자 지정 페이로드입니다. 자유 형식 객체이며 버튼 또는 텍스트 추가와 같은 활성 통화 구성요소를 사용자 지정하는 데 필요한 모든 데이터를 포함할 수 있습니다. | | activeCall.direction | 문자열 | 연결된 참가자에 대한 호출 방향입니다. 유효한 값은 다음과 같습니다. * 인바운드 * 아웃바운드 {#openFrameAPI-setICContext_S_O__ul_ljy_sv5_w3c} | | activeCall.externalId | | 필수 연결된 외부 시스템에서 현재 활성 호출을 식별하는 고유 값입니다. | | activeCall 입니다.nowRecordId | 문자열 | 필수 활성 통화 기록의 Sys_id입니다. 테이블: 상호작용 \[interaction\] 기본 시스템에 대해서만 지원되는 옵션입니다. | | activeCall 입니다.nowRecordTable | 문자열 | 필수 활성 호출이 속한 테이블입니다. 테이블: 상호작용 \[interaction\] 기본 시스템에 대해서만 지원되는 옵션입니다. | | activeCall 입니다.참가자 | 객체 배열 | 필수 통화에 참여하는 추가 참가자 목록입니다. 참가자는 에이전트, 고객, 에이전트나 고객이 아닌 외부 사용자 또는 큐일 수 있습니다. "participants": [ { "actor": "String", "ani": "String", "address": "String", "capabilities": {Object}, "callStartTime" "String", "connectedTime": "String", "customPayload": {Object}, "dnis": "String", "held": Boolean, "heldAtTime": "String", "id": "String", "muted": Boolean, "name": "String", "requestACW": Boolean, "requireWrapup": Boolean, "state": "String" } ] | | activeCall 입니다.참가자.배우 | 문자열 | 연결된 참가자의 액터 유형입니다. 예: * 에이전트 * 고객 * 외부 * 큐 {#openFrameAPI-setICContext_S_O__ul_njy_sv5_w3c} | | activeCall 입니다.참가자.주소 | 문자열 | 참가자의 전화 번호입니다. | | activeCall 입니다.참가자.애니 | | 자동 번호 식별입니다. 전화 수신자에게 표시할 전화 번호입니다. | | activeCall 입니다.참가자.기능 | 객체 | 연결된 호출에 대해 참가자가 보유한 역량 유형에 대한 상세 정보입니다. "capabilities": { "endCall": Boolean, "hold": Boolean, "mute": Boolean } | | activeCall 입니다.참가자.기능.엔드콜 | 부울 | 연결된 참가자가 통화를 종료할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 통화를 종료할 수 있습니다. 통화 종료 버튼은 UI에서 활성화됩니다. * false: 참가자가 통화를 종료할 수 없습니다. UI에서 통화 종료 버튼이 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_pjy_sv5_w3c} 기본값: false | | activeCall 입니다.참가자.기능.들다 | 부울 | 참가자가 호출을 보류할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 호출을 보류할 수 있습니다. 보류 버튼은 UI에서 활성화됩니다. * false: 참가자가 호출을 보류할 수 없습니다. UI에서 보류 버튼이 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_tjy_sv5_w3c} 기본값: false | | activeCall 입니다.참가자.기능.음소거 | 부울 | 참가자가 통화를 음소거할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 호출을 음소거할 수 있습니다. 음소거 버튼은 UI에서 활성화되어 있습니다. * false: 참가자가 호출을 음소거할 수 없습니다. UI에서 음소거 버튼은 비활성화되어 있습니다. {#openFrameAPI-setICContext_S_O__ul_wjy_sv5_w3c} 기본값: false | | activeCall 입니다.참가자.커넥티즌타임 | 문자열 | 필수 참가자가 처음 통화에 연결한 날짜 및 시간입니다. 시간 표준: UTC 형식: RSS - "\<요일\>, dd mmm yyyy hh:MM:ss GMT" 예: "Wed, 17 Dec 2024 05:23:41 GMT" | | activeCall 입니다.참가자.사용자 지정 페이로드 | 객체 | Open Frame 사용자 지정 이벤트의 일부로 OpenFrame에 전달할 사용자 지정 페이로드입니다. 자유 형식 객체이며 버튼 또는 텍스트 추가와 같이 활성 통화 구성요소를 사용자 지정하는 데 필요한 모든 데이터를 포함할 수 있습니다. | | activeCall 입니다.참가자.DNI | 문자열 | 전화를 건 번호 식별 서비스입니다. 참가자가 전화를 건 전화번호입니다. | | activeCall 입니다.참가자.개최 | 부울 | 참가자의 보류 상태를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 보류 중입니다. * false: 참가자가 보류 중이 아닙니다. {#openFrameAPI-setICContext_S_O__ul_zjy_sv5_w3c} 기본값: false | | activeCall 입니다.참가자.'heldAtTime' | 문자열 | 참가자의 호출 연결이 보류된 날짜 및 시간입니다. 타임베이스: UTC 형식: RSS - "\<요일\>, dd mmm yyyy hh:MM:ss GMT" 예: "Wed, 17 Dec 2024 05:23:41 GMT" | | activeCall 입니다.참가자.아이디 | 문자열 | 필수 CCaaS(연락처 센터 서비스형) 시스템의 참가자 고유 ID입니다. | | activeCall 입니다.참가자.음소거 | 부울 | 참가자의 음소거 상태를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 참가자가 음소거됩니다. * false: 참가자가 음소거되지 않았습니다. {#openFrameAPI-setICContext_S_O__ul_bky_sv5_w3c} 기본값: false | | activeCall 입니다.참가자.이름 | 문자열 | 참가자의 이름입니다. | | activeCall 입니다.참가자.요청ACW | 부울 | 에이전트 사용 케이스에만 해당 - " activeCall.currentParticipant.actor 에이전트"인 경우에만 유효합니다. 참가자가 고객에게 후속 조치를 취할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 후속 조치가 필요합니다. * false: 후속 조치가 필요하지 않습니다. {#openFrameAPI-setICContext_S_O__ul_d5s_xtb_j2c} 기본값: false | | activeCall 입니다.참가자.요구 래핑 | 부울 | 에이전트 사용 케이스에만 해당 - " activeCall.currentParticipant.actor 에이전트"인 경우에만 유효합니다. 호출이 완료된 후 마무리 구성요소를 표시할지 여부를 나타내는 플래그입니다.
유효한 값은 다음과 같습니다. * true: 호출 완료 시 마무리 구성요소를 표시합니다. * false: 통화 완료 시 마무리 구성요소를 표시하지 않습니다. {#openFrameAPI-setICContext_S_O__ul_enm_4tb_j2c} 기본값: false | | activeCall 입니다.참가자.상태 | 문자열 | 참가자의 호출 구간 상태입니다. 활성 통화 구성요소에서 전화 번호 아래에 나타납니다. 다음과 같이 의미 있는 텍스트일 수 있습니다. * 경고 * 연결됨 * 벨소리 {#openFrameAPI-setICContext_S_O__ul_dky_sv5_w3c} | | activeCall.type | 문자열 | 호출의 유형입니다. 유효한 값은 다음과 같습니다. * 호출 * 콜백 주: 설정된 경우 객체 상세 정보를 포함 activeCall.callbackContext 해야 합니다. * 음성 메일 {#openFrameAPI-setICContext_S_O__ul_eky_sv5_w3c} | | idleState | 객체 | 에이전트의 유휴 상태 컨텍스트를 설명합니다. 이 컨텍스트 데이터는 에이전트가 통화를 대기할 때 다이얼 패드에 나타나는 정보와 이 다이얼 패드를 통한 기능을 결정합니다. idleState { "capability": {Object}, "currentInboundId": "String", "dialpadInfoMessage": {Object}, "enableState": {Object} } | | idleState.capability | 객체 | 현재 사용자의 유휴 상태 기능에 대한 설명입니다. "capability": { "globalContactSearch": Boolean, "logOut": Boolean, "outBoundCall": Boolean } | | idleState.capability.globalContactSerarch | 부울 | 유휴 상태일 때 전체 연락처 목록을 표시할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 전역 연락처 목록을 표시합니다. * false: 전역 접촉 창구 목록을 표시하지 않습니다. {#openFrameAPI-setICContext_S_O__ul_kky_sv5_w3c} 기본값: false | | idleState.capability.logOut | 부울 | 사용자가 유휴 상태인 동안 로그아웃할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 호출이 유휴 상태일 때 사용자가 로그아웃할 수 있습니다. 다이얼 패드에 로그아웃 버튼이 나타납니다. * false: 호출이 유휴 상태일 때 사용자는 로그아웃할 수 없습니다. {#openFrameAPI-setICContext_S_O__ul_nky_sv5_w3c} 기본값: false | | idleState.capability.outBoundCall | 부울 | 사용자가 유휴 상태일 때 아웃바운드 호출을 할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 호출이 유휴 상태일 때 사용자가 아웃바운드 호출을 걸 수 있습니다. * false: 호출이 유휴 상태일 때 사용자가 아웃바운드 호출을 할 수 없습니다. {#openFrameAPI-setICContext_S_O__ul_qky_sv5_w3c} 기본값: false | | idleState입니다.currentInboundId | 문자열 | 아웃바운드 호출 상호작용을 생성하는 데 사용되는 제공자 애플리케이션의 인바운드 식별자입니다. 테이블: 제공자 채널 신원 \[sys_cs_provider_application\] 테이블의 ID 필드에 있습니다. 기본값: 기본 시스템 제공자 애플리케이션 | | idleState입니다.dialpadInfo메시지 | 객체 | 사용자의 다이얼 패드에 표시할 정보 메시지에 대한 상세 정보입니다(예: 현재 선택된 큐). "dialpadInfoMessage": { "label": "String", "value": "String" } 다음 예시에서는 label'선택됨' 큐가 선택됨이고 '고객 문의' 큐 value 가 표시됩니다. 선택한 큐: 고객 문의와 함께 또는 value 매개변수를 사용할 label 수도 있습니다.
| | idleState입니다.dialpadInfoMessage입니다.레이블 | 문자열 | 다이얼 패드에 표시할 자유 형식 레이블입니다. | | idleState입니다.dialpadInfoMessage입니다.값 | 문자열 | 다이얼 패드의 레이블 뒤에 표시할 자유 형식 메시지 텍스트입니다. | | idleState입니다.enableState | 객체 | 다이얼 패드에 있는 버튼의 사용 상태에 대한 상세 정보입니다. "enableState": { "logOut": Boolean, "outBoundCall": Boolean } | | idleState입니다.enableState입니다.로그아웃 | 부울 | 유휴 상태일 때 UI에서 로그아웃 버튼을 사용할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 유휴 상태일 때 로그아웃 버튼을 표시합니다. * false: 유휴 상태일 때는 로그아웃 버튼을 표시하지 않습니다. {#openFrameAPI-setICContext_S_O__ul_tky_sv5_w3c} 기본값: false | | idleState입니다.enableState입니다.아웃바운드콜 | 부울 | 유휴 상태일 때 UI에서 아웃바운드 호출 단추를 사용할지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 유휴 상태일 때 아웃바운드 호출 버튼을 표시합니다. * false: 유휴 상태일 때는 아웃바운드 호출 버튼을 표시하지 않습니다. {#openFrameAPI-setICContext_S_O__ul_wky_sv5_w3c} 기본값: false | | 제공 컨텍스트 | 객체 | 복원성을 위한 현재 참가자의 제안 컨텍스트에 대한 상세 정보입니다. { "assignment": {Object}, "creationTime": "String", "description": "String", "displayContent": {Object}, "externalId": "String", "externalSegmentId": "String", "isResilient": Boolean, "metadata": {Object}, "nowRecordId": "String", "nowRecordTable": "String", "providerAppInboundId": "String", "queueId": "String", "requesterId": "String", "transferContent": {Object}, "type": "String" } | | offerContext.assignment | 객체 | 에이전트 할당에 대한 상세 정보입니다. "assignment": { "allowedToDecline": Boolean, "enableAutoAssign": Boolean, "offeredOn": "String", "timeout": "String" } | | offerContext.assignment. allowedToDecline | 부울 | 필수 에이전트가 할당을 거부할 수 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 에이전트가 할당을 거부할 수 있습니다. * false: 에이전트는 할당을 거부할 수 없습니다. {#openFrameAPI-setICContext_S_O__ul_brb_h4n_rhc} 기본값: false | | offerContext.assignment. enableAutoAssign | 부울 | 필수 에이전트가 할당을 자동으로 받는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 에이전트가 자동으로 할당을 받을 수 있습니다. * false: 에이전트가 할당을 자동으로 받을 수 없습니다. {#openFrameAPI-setICContext_S_O__ul_lp3_h4n_rhc} 기본값: false | | offerContext.assignment. offeredOn | 문자열 | UTC 형식(Www, dd Mmm yyyy HH:mm:ss GMT)으로 제안이 이루어진 날짜입니다. | | offerContext.assignment. timeout | 문자열 | 시간 초과 전에 에이전트에 할당할 시간(밀리초)입니다. | | offerContext.creationTime | 문자열 | 옵션입니다. UTC 형식(YYYY-MM-DDTHH:MM:SS)의 호출 생성 날짜 및 시간입니다. | | offerContext.description | 문자열 | 옵션입니다. 제안에 대한 설명입니다. | | offerContext.displayContent | 객체 | 옵션입니다. 화면에 표시되는 값을 나타내는 고유한 JSON 페이로드 값입니다. | | offerContext.externalId | 문자열 | 연결된 외부 시스템에서 현재 활성 호출을 식별하는 고유 값입니다. | | offerContext.isResilient | 부울 | 옵션입니다. 오퍼 컨텍스트의 복원력이 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 오퍼 컨텍스트에 복원력이 있습니다. * false: 오퍼 컨텍스트가 복원력이 없습니다. {#openFrameAPI-setICContext_S_O__ul_tsw_v4j_shc} 기본값: true | | offerContext.metadata | 객체 | 옵션입니다. 자유 형식 사용자 지정 JSON 페이로드 값입니다. | | offerContext입니다.nowRecordId | 문자열 | 필수 활성 통화 기록의 Sys_id입니다. 테이블: 상호작용 \[interaction\] 기본 시스템에 대해서만 지원되는 옵션입니다. | | offerContext입니다.nowRecordTable | 문자열 | 옵션입니다. 이 속성을 사용하여 전송할 작업 항목과 세그먼트를 설정합니다. | | offerContext입니다. providerAppInboundId | 문자열 | 옵션입니다. 인바운드 외부 공급업체 제공자의 고유 ID입니다. | | offerContext입니다.큐 ID | 문자열 | 정규(비이전) 할당에 필요합니다. 할당 큐를 나타내는 고유 ID입니다. 이전 할당에 속성을 사용합니다 transferContent.targetId . | | offerContext입니다.requesterId | 문자열 | 필수 제안 요청자의 고유 ID입니다. 음성의 경우 이 값은 사용자의 전화 번호일 수 있습니다. | | offerContext.transferContent | 객체 | 이전 할당에 필요한 상세 정보입니다. "transferContent": { "sourceQueueId": "String", "targetId": "String", "targetType": "String", "transferType": "String" } | | offerContext.transferContent. sourceQueueId | 문자열 | 할당 큐의 sys_id 또는 외부 ID입니다. | | offerContext.transferContent. targetId | 문자열 | 큐 전송의 sys_id 또는 외부 ID입니다. | | offerContext.transferContent. targetType | 문자열 | 이전 대상의 유형입니다. 유효한 값은 다음과 같습니다. * 에이전트 * 큐 {#openFrameAPI-setICContext_S_O__ul_w1d_nwn_rhc} | | offerContext.transferContent. transferType | 문자열 | 이전 유형입니다. 유효한 값은 다음과 같습니다. * 블라인드 * 상담 {#openFrameAPI-setICContext_S_O__ul_fvp_qwn_rhc} | | offerContext.type | 문자열 | 호출의 유형입니다. 유효한 값은 다음과 같습니다. * 호출 * 콜백 요청 * 음성 메일 {#openFrameAPI-setICContext_S_O__ul_q4r_bwn_rhc} | | searchTargetList | 객체 배열 | 테이블에 대한 전송 관련 데이터의 컨텍스트 상세 정보입니다 ServiceNow . "searchTargetList": [ { "externalId": "String", "nowRecordId": "String", "nowRecordTable": "String", "participantID": "String", "quickStats": [Array], "targets": [Array], "targetTypes": [Array] } ] | | searchTargetList를 사용합니다.외부 ID | 문자열 | CCaaS 시스템에서 연결된 호출의 고유 식별자입니다. | | searchTargetList를 사용합니다.nowRecordId | 문자열 | 필수 searchTargetList가 속한 기록의 Sys_id입니다. 주: 상호작용 \[interaction\] 테이블의 기록만 현재 지원됩니다. | | searchTargetList를 사용합니다.nowRecordTable | 문자열 | 필수입니다. ServiceNow searchTargetList가 속한 테이블입니다. 테이블: 유효한 값인 `"상호작용"`만 | | searchTargetList를 사용합니다.참가자 ID | 문자열 | CCaaS 시스템의 참가자 고유 식별자입니다. | | searchTargetList.quickStats | 객체 배열 | 옵션입니다. 에이전트 항목에만 적용됩니다. 에이전트 상태 정보를 제공하기 위해 에이전트 행에 인라인으로 표시되는 상태 설명자 목록입니다. "quickStats": [ { "label": "String", "value": "String" } ] 예제 렌더링: `사용 가능 | 당직 1` | | searchTargetList.quickStats.label | 문자열 | 에이전트 행에 표시되는 상태 레이블입니다. | | searchTargetList.quickStats.value | 문자열 | 레이블에 추가되는 선택적 값입니다. | | searchTargetList를 사용합니다.대상 | 객체 배열 | 호출을 전환할 수 있는 에이전트, 외부 사용자 및/또는 큐에 대한 상세 정보입니다. "targets": [ { "payload": {Object}, "transferSubtypes": [Array], "type": "String" } ] | | searchTargetList를 사용합니다.대상.페이로드 | 객체 | 전환 콜 통제에 표시할 정보에 대한 상세 정보입니다. 다음은 통화를 전환할 수 있는 에이전트 목록이 포함된 통화 전환 통제의 예입니다. 스크린샷은 컨트롤의 각 매개변수가 포함된 UI의 요소를 보여줍니다.list.payload
"payload": { "list": [Array] } 이 예는 에이전트 페이로드("`searchTargetList.targets.type": "agent")`를 보여줍니다. "payload": { "list": [ { "name": "Alice Anderson", "id": "agent1Id", "hasStats": true, "presence": "available", "moreInfo": [ { "label": "Skill", "value": "CRM certified" } ] } ] } 다음은 큐 페이로드("`searchTargetList.targets.type": "queue")`의 예를 보여줍니다. "payload": { "list": [ { "name": "Product Support Queue", "id": "queue1Id", "hasStats": true, "moreInfo": [ { "label": "Skill", "value": "10sec" }, { "label": "Queue Skill", "value": "German" } ] }, { "name": "Billing Queue", "id": "queue2Id", "hasStats": true, "moreInfo": [ { "label": "Skill", "value": "10sec" } ] } ] } | | searchTargetList를 사용합니다.대상.페이로드.목록 | 객체 배열 | 각 대상 유형의 페이로드에 대한 상세 정보입니다. "list": [ { "hasStats": Boolean, "id": "String", "moreInfo": [Array], "name": "String", "presence": "String" } ] | | searchTargetList를 사용합니다.대상.페이로드.목록.hasStats | 부울 | 연결된 대상에 큐 대기 시간과 같은 추가 통계가 있는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 대상에 추가 통계가 있습니다. 에이전트 이름 또는 큐 옆에 정보 아이콘이 나타납니다. * false: 대상에 추가 통계가 없습니다. {#openFrameAPI-setICContext_S_O__ul_aly_sv5_w3c} 기본값: false | | searchTargetList를 사용합니다.대상.페이로드.목록.아이디 | 문자열 | CCaaS 시스템에 있는 에이전트 또는 큐의 고유 식별자입니다. | | searchTargetList를 사용합니다.대상.페이로드.목록.더 많은 정보 | 객체 배열 | "`예"`로 설정된 경우 searchTargetList.targets.payload.list.hasStats 필요합니다. 에이전트 또는 큐에 있는 기술 목록입니다. 사용자가 엔터티 이름 끝에 있는 정보 아이콘을 선택하면 이 정보가 팝업 창에 나타납니다. "moreInfo": [ { "label": "String", "value": "String" } ] | | searchTargetList를 사용합니다.대상.페이로드.목록.moreInfo입니다.레이블 | 문자열 | 기술 또는언어와 같이 팝업 창에 표시할 정보에 대한 자유 형식 레이블입니다. | | searchTargetList를 사용합니다.대상.페이로드.목록.moreInfo입니다.값 | 문자열 | 레이블 뒤의 팝업 창에 표시할 텍스트입니다( 예: CRM 인증 또는 독일어). | | searchTargetList를 사용합니다.대상.페이로드.목록.이름 | 문자열 | 에이전트, 외부 사용자 또는 큐의 이름입니다. CCaaS 시스템에 위치합니다. | | searchTargetList를 사용합니다.대상.페이로드.목록.존재 | 문자열 | 연결된 에이전트의 현재 상태입니다. 이 매개변수는 `"에이전트"`의 a searchTargetList.targets.type에만 유효합니다. 유효한 값은 다음과 같습니다. * 사용 가능 * 자리 비움 * 통화 중 * 오프라인 {#openFrameAPI-setICContext_S_O__ul_dly_sv5_w3c} | | searchTargetList를 사용합니다.대상.transferSubtypes | 객체 배열 | 지정 searchTargetList.targets.type한 에 대해 지원되는 전송 유형에 대한 상세 정보입니다. 이 정보는 사용자가 UI에서 대상 이름 옆에 있는 타원을 클릭하면 나타납니다.
예를 들어, 현재 대상 유형(예: 큐)에 대해 상담 유형만 지원되는 경우 이 배열에는 이전의 상담 유형을 나타내는 하나의 객체가 포함됩니다. "transferSubtypes": [ { "id": "String", "label": "String" } ] | | searchTargetList를 사용합니다.대상.transferSubtypes를 사용합니다.아이디 | 문자열 | 이전 하위 유형의 식별자입니다. 유효한 값은 다음과 같습니다. * 블라인드: 에이전트가 먼저 에이전트와 말하지 않고 고객 통화를 다른 에이전트 또는 큐로 직접 전환합니다. * 상담: 에이전트가 상담을 원하는 에이전트에게 연락한 다음 고객을 컨설팅 에이전트와의 통화에 병합합니다. {#openFrameAPI-setICContext_S_O__ul_gly_sv5_w3c} 의 값 searchTargetList.targets.transferSubtypes.label과 일치해야 합니다. | | searchTargetList를 사용합니다.대상.transferSubtypes를 사용합니다.레이블 | 문자열 | 전송 하위 유형의 레이블입니다. 레이블을 전달하지 않으면 전송 하위 유형에 대한 UI에 아무 것도 표시되지 않습니다. 유효한 값은 다음과 같습니다. * 블라인드 * 문의 {#openFrameAPI-setICContext_S_O__ul_kly_sv5_w3c} 의 값 searchTargetList.targets.transferSubtypes.id과 일치해야 합니다. | | searchTargetList를 사용합니다.대상.형 | 문자열 | 대상 유형입니다. 유효한 값은 다음과 같습니다. * 에이전트 * 외부 * 큐 {#openFrameAPI-setICContext_S_O__ul_lly_sv5_w3c} | | searchTargetList.targetTypes | 문자열 배열 | 옵션입니다. 지정된 상호작용에 따라 전화번호부 구성요소에 표시할 탭을 지정합니다. targetTypes: ["String", "String", "String"] 허용되는 값: * 에이전트 * 큐 * 외부 {#openFrameAPI-setICContext_S_O__ul_xlv_p55_w3c} 기본값: 세 개의 탭이 모두 표시됩니다. | | 유형 | 문자열 | 설정할 컨텍스트 데이터의 유형입니다. 유효한 값은 다음과 같습니다. * activeCall: 진행 중인 활성 통화 구성요소에 대한 컨텍스트를 설정합니다. 이 컨텍스트 유형을 전달할 때 `activeCall[]`Context 매개변수도 전달해야 합니다. * idleState: 현재 사용자의 유휴 상태 기능을 설정합니다. 이 유형을 설정하면 유휴 상태 UI(다이얼 패드)가 OpenFrame에 나타납니다. 이 컨텍스트 유형을 전달할 때 `{}` JSON도 매개변수로 전달해야 합니다.Context * offerContext: 복원성을 위해 현재 참가자의 제안 컨텍스트를 설정합니다. 이 컨텍스트 유형을 전달할 때 `offerContext{}` JSON도 매개변수로 Context 전달해야 합니다. * searchTargetList: 전화번호부 컨텍스트를 설정합니다. 이 유형을 설정하면 활성 통화 구성요소에서 통화 전환이 활성화됩니다. 이 컨텍스트 유형을 전달할 때 `searchTargetList[]` JSON도 매개변수로 Context 전달해야 합니다. {#openFrameAPI-setICContext_S_O__ul_nly_sv5_w3c} | [표 21. 매개변수] {#openFrameAPI-setICContext_S_O__table_xlq_rhg_zdc} {#openFrameAPI-setICContext_S_O__table_ylq_rhg_zdc__entry__2} | 유형 | 설명 | |-|-| | 없음 | | | 오류(offerContext) | 복원성에 사용되는 객체와 offerContext 관련된 오류 메시지입니다. 이러한 메시지를 보려면 [subscribe()](https://servicenow-prod.fluidtopics.net/ctghFoh6i9v0oSnervQU2A#r_openFrameAPI-subscribe_Event_Object "지정된 이벤트를 구독합니다.") 메서드를 사용하여 이벤트를 구독 openframe_awa_client_offer 하십시오. 컨텍스트 값은 다음과 같이 표시됩니다. 1. 성공 2. 오류 3. partialSuccess {#openFrameAPI-setICContext_S_O__ul_oss_4zn_rhc} AWA_EXTUSER_ROLE_CHECK_FAILED : 메시지: 사용자에게 awa_external_user 역할이 없습니다. : 이 이벤트는 에이전트에 필요한 역할 "awa_external_user" 또는 "관리자"가 없음을 나타냅니다. AWA_AGENT_NOT_AVAILABLE : 메시지: 에이전트가 작업을 받을 수 없습니다. : 이 이벤트는 선택한 에이전트를 사용할 수 없음을 나타냅니다. AWA_OFFER_ASSIGNMENT_PAYLOAD_MISSING : 메시지: 할당 페이로드가 비어 있거나 offerContext에 정의되어 있지 않습니다. : 이 이벤트는 페이로드가 비어 있거나 객체에 offerContext 정의되어 있지 않음을 나타냅니다. AWA_OFFER_QUEUEID_MISSING : 메시지: offerContext에 전송 소스 큐 ID가 누락되었습니다. : 이 이벤트는 필요한 전송 큐 ID(transferContent.targetId)가 객체에서 offerContext 누락되었음을 나타냅니다. AWA_ASSIGNMENT_OFFEREDON_FUTURE : 메시지: OfferedOn 시간은 미래입니다. : 이 이벤트는 속성 값이 assignment.offeredOn 미래 날짜이며 유효하지 않음을 나타냅니다. 날짜가 있거나 이전이어야 합니다. AWA_ASSIGNMENT_OFFEREDON_INVALID_FORMAT : 메시지: OfferedOn 날짜 형식이 잘못되었습니다. "Www, dd Mmm yyyy HH:mm:ss GMT" UTC 형식으로 보내주십시오. : 이 이벤트는 속성에 제공된 offerContext.assignment.offeredOn 값이 적절한 시간 날짜 형식이 아님을 나타냅니다. AWA_OFFER_EXTERNALID_MISSING : 메시지: offerContext에 ExternalId가 없습니다. : 이 이벤트는 오퍼에 필요한 externalId 속성이 제공되지 않았음을 나타냅니다. 이 값은 연결된 외부 시스템에서 현재 활성 호출을 식별합니다. | [표 22. 반환] {#openFrameAPI-setICContext_S_O__table_ylq_rhg_zdc} 다음 코드 예제에서는 활성 상태 컨텍스트를 설정하는 방법을 보여 줍니다. openFrameAPI.setICContext("activeCall", { "activeCall": [ { "nowRecordTable": "interaction", "nowRecordId": "12345675678903456", "externalId": "1234567890", "type": "call", "direction": "inbound", "currentParticipant": { "id": "participant1", "name": "John 1", "actor": "agent", "state": "connected", "connectedTime": "Fri, 12 Jul 2024 05:23:41 GMT", "callStartTime": "Fri, 12 Jul 2024 04:20:22 GMT", "muted": false, "held": true, "paused": true, "flagged": true, "recording": "in_progress", "capabilities": { "hold": false, "mute": true, "endCall": true, "startRecording": true, "pauseRecording": true, "stopRecording": true, "resumeRecording": true, "transfer": true, "mergeCall": true, "leaveAndTransfer": true, "dtmf": true, "flag": true } }, "participants": [ { "id": "customer1", "name": "Gilly 1", "actor": "customer", "address": "+18582359874", "ani": "+16193287356", "dnis": "+18004346258", "state": "connected", "connectedTime": "Fri, 12 Jul 2024 00:23:41 GMT", "callStartTime": "Fri, 12 Jul 2024 20:55:04 GMT", "muted": false, "held": false, "heldAtTime": "Fri, 12 Jul 2024 20:55:04 GMT", "capabilities": { "mute": true, "hold": true, "endCall": true } }, { "id": "agent2", "name": "Ned", "actor": "agent", "address": "+3134787324", "ani": "+13134787324", "dnis": "+14773286943", "state": "Ringing...", "requireWrapup": true, "requestACW": true, "connectedTime": "Fri, 12 Jul 2024 20:24:41 GMT", "callStartTime": "Fri, 12 Jul 2024 20:56:34 GMT", "muted": true, "held": true, "heldAtTime": "Fri, 12 Jul 2024 20:55:41 GMT", "capabilities": { "mute": true, "endCall": true, "hold": true } } ] }, { "nowRecordTable": "interaction", "nowRecordId": "12345yhedfh534576u5", "externalId": "1234567890", "type": "call", "direction": "inbound", "currentParticipant": { "id": "participant1", "name": "John 1", "actor": "agent", "state": "connected", "muted": true, "held": false, "recording": "in_progress", "paused": true, "flagged": true, "capabilities": { "hold": false, "mute": true, "endCall": true, "record": true, "startRecording": true, "stopRecording": true, "transfer": true, }, "mergeCall": false, "dtmf": true, "flag": true } }, "participants": [ { "id": "customer1", "name": "Gilly 2", "actor": "customer", "address": "+123456789", "state": "connected", "connectedTime": "Wed, 04 Dec 2024 00:23:41 GMT", "muted": true, "held": false, "heldAtTime": "Fri, 12 Jul 2024 20:24:41 GMT", "capabilities": { "mute": true, "hold": true, "endCall": true } }, { "id": "agent2", "name": "Ned 2", "actor": "agent", "address": "+123456789", "state": "Ringing...", "connectedTime": "Fri, 12 Jul 2024 20:24:41 GMT", "muted": true, "held": true, "heldAtTime": "Fri, 12 Jul 2024 20:24:41 GMT", "capabilities": { "mute": true, "endCall": true, "hold": true } } ] } ] } ); 다음 예제에서는 유휴 상태 컨텍스트를 설정하는 방법을 보여줍니다. openFrameAPI.setICContext("idleState", { "capability": { "outBoundCall": true, "logOut": true }, "enableState": { "outBoundCall": true, "logOut": true }, "dialpadInfoMessage": { "label": "Info Message Label", "value": "Info Message Value" }, "currentInboundId": "1234" }); 다음 예시에서는 검색 대상 목록 컨텍스트를 설정하는 방법을 보여줍니다. openFrameAPI.setICContext("searchTargetList", { "searchTargetList": [ { "nowRecordTable": "interaction", "nowRecordId": "1234", "externalId": "5678", "participantID": "participant1", "targetTypes": ["agent", "queue"], "targets": [ { "type": "agent", "transferSubtypes": [ { "id": "consult", "label": "Consult" }, { "id": "blind", "label": "Blind" } ], "payload": { "list": [ { "name": "John Jason", "id": "agent1Id", "hasStats": true, "presence": "away", "moreInfo": [ { "label": "Skill", "value": "10sec" } ] } ] } }, { "type": "queue", "transferSubtypes": [ { "id": "consult", "label": "Consult" }, { "id": "blind", "label": "Blind" } ], "payload": { "list": [ { "name": "Product Support Queue", "id": "queue1Id", "hasStats": true, "moreInfo": [ { "label": "Skill", "value": "10sec" }, { "label": "Queue Skill", "value": "German" } ] }, { "name": "Billing Queue", "id": "queue2Id", "hasStats": true, "moreInfo": [ { "label": "Skill", "value": "10sec" } ] } ] } } ], "customPayload": {} } ], "customPayload": {} }); 다음 예제에서는 콜백 컨텍스트 및 관련 역량 설정을 설정하는 방법을 제안합니다. openFrameAPI.setICContext('activeCall', callbackContext); var callbackContext = { "activeCall": [ { "nowRecordTable": "Customer interaction", "nowRecordId": "12345yhedfh534576u5", "externalId": "1234567890", "type": "callback", "currentParticipant": { "id": "agent1", "capabilities": { "initiateCall": true, "closeCallback": true, "transfer": true, "cancelCallbackTransferEligible": false, "callbackTransferStatus": "" } }, "callbackContext": { "customerName": "Fred Luddy", "callbackNumbers": [ "8665551234" ], "callAttemptedByAgent": true, "closeInEndTime": "Mon, 05 Dec 2024 09:25:08 GMT", "dialInEndTime": "" } } ] } 다음 예제에서는 offerContext 속성을 사용하여 복원력 통화 응답 상세 정보를 설정하는 방법을 보여줍니다. // Set offerContext openFrameAPI.setICContext('offerContext', offerContext); var offerContext = { "offerContext": [ { "nowRecordTable": "interaction", "type": "phone", "externalId": "1234567890", "externalSegmentId": "12345yhedfh534576u5", "queueId": "10111ad087063250df52fe66cebb3520", "creationTime": "19-12-2025 11:23:45", "requesterId": "4085018550", "assignment": { "offeredOn": "Fri, 19-12-2025 13:07:59", "timeout": "4000", "allowedToDecline": true, "enableAutoAssign": true }, "displayContent": { "title": "Phone", "displayContent1": "Abel Tuter", "displayContent2": "Priority - 4-Low", "displayContent3": "category - Product Issue" } } ] }; ## openFrameAPI - setIcons(배열 아이콘) {#ariaid-title13} 닫기 아이콘 옆에 배치되는 OpenFrame 헤더의 아이콘을 정의합니다. {#r_openFrameAPI-setIcons_Array__table_dg3_lny_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 아이콘 | 객체 배열 | 각 아이콘 구성이 키 값imageURLimageTitle, 및 기타 필요한 컨텍스트가 있는 객체인 아이콘 구성 목록입니다. 최대 크기: 아이콘은 최대 16x16픽셀일 수 있습니다. 더 큰 이미지는 이 최대값으로 자동 조정됩니다. | [표 23. 매개변수] {#r_openFrameAPI-setIcons_Array__table_dg3_lny_kt} {#r_openFrameAPI-setIcons_Array__table_eg3_lny_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 24. 반환] {#r_openFrameAPI-setIcons_Array__table_eg3_lny_kt} openFrameAPI.setIcons([{imageURL:'https://mydomian.com/image/mute.png', imageTitle:'mute', id:101}, {imageURL:'https://mydomian.com/image/hold.png', imageTitle:'hold', id:102}]); ## openFrameAPI - setPresenceIndicator(존재) {#ariaid-title14} 작업 공간에서 에이전트 가용성을 표시하도록 현재 상태 표시기를 설정합니다. OpenFrame 구성에 대한 자세한 내용은 [OpenFrame 구성 생성](https://www.servicenow.com/docs/access?context=t_CreateAnOpenFrameConfiguration&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)을 참조하십시오 {#openFrameAPI-setPresenceIndicator__table_o4l_p1c_jhb__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 상태 | 문자열 | 에이전트의 현재 상태입니다. 기본 상태: * 사용 가능 * 자리 비움 * 오프라인 {#openFrameAPI-setPresenceIndicator__ul_bws_ldg_d3b} 사용자 지정 상태를 지정할 수도 있습니다. | | 색상 | 문자열 | 작업 공간의 현재 상태 표시기 색상입니다. 지원되는 색상: * 적색 * 주황색 * 회색 * 녹색 {#openFrameAPI-setPresenceIndicator__ul_xwr_xbg_d3b} | [표 25. 매개변수] {#openFrameAPI-setPresenceIndicator__table_o4l_p1c_jhb} {#openFrameAPI-setPresenceIndicator__table_p4l_p1c_jhb__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 26. 반환] {#openFrameAPI-setPresenceIndicator__table_p4l_p1c_jhb} openframeAPI.setPresenceIndicator('Available', 'green'); ## openFrameAPI - setSize(숫자 너비, 숫자 높이) {#ariaid-title15} OpenFrame 크기를 설정합니다. {#r_openFrameAPI-setSize_Number_Number__table_vvk_5jy_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | width | 번호 | 0보다 커야 합니다. | | height | 번호 | 0보다 커야 합니다. | [표 27. 매개변수] {#r_openFrameAPI-setSize_Number_Number__table_vvk_5jy_kt} {#r_openFrameAPI-setSize_Number_Number__table_wvk_5jy_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 28. 반환] {#r_openFrameAPI-setSize_Number_Number__table_wvk_5jy_kt} openFrameAPI.setSize(300, 370); ## openFrameAPI - setSubtitle(String subTitle) {#ariaid-title16} OpenFrame 부제목을 설정합니다. {#r_openFrameAPI-setSubtitle_String__table_ztd_hjy_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | subTitle | 문자열 | 256자 이하의 문자열입니다. | [표 29. 매개변수] {#r_openFrameAPI-setSubtitle_String__table_ztd_hjy_kt} {#r_openFrameAPI-setSubtitle_String__table_a5d_hjy_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 30. 반환] {#r_openFrameAPI-setSubtitle_String__table_a5d_hjy_kt} openFrameAPI.setSubtitle('+18888888888'); ## openFrameAPI - setTitle(문자열 제목) {#ariaid-title17} OpenFrame 제목을 설정합니다. {#r_openFrameAPI-setTitle_String__table_jbl_w3y_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 직위 | 문자열 | 256자 이하의 문자열입니다. | [표 31. 매개변수] {#r_openFrameAPI-setTitle_String__table_jbl_w3y_kt} {#r_openFrameAPI-setTitle_String__table_kbl_w3y_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 32. 반환] {#r_openFrameAPI-setTitle_String__table_kbl_w3y_kt} openFrameAPI.setTitle('Incoming Call'); ## openFrameAPI - setTitleIcon(객체 아이콘) {#ariaid-title18} OpenFrame의 제목 아이콘을 설정합니다. {#r_openFrameAPI-setTitleIcon_Object__table_w42_kky_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 아이콘 | 객체 | 키 값 쌍의 객체입니다. 키에는 , imageTitle및 기타 필요한 컨텍스트가 포함됩니다imageURL. 최대 크기: 아이콘은 최대 16x16픽셀일 수 있습니다. 더 큰 이미지는 이 최대값으로 자동 조정됩니다. | [표 33. 매개변수] {#r_openFrameAPI-setTitleIcon_Object__table_w42_kky_kt} {#r_openFrameAPI-setTitleIcon_Object__table_x42_kky_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 34. 반환] {#r_openFrameAPI-setTitleIcon_Object__table_x42_kky_kt} openFrameAPI.setTitleIcon({imageURL:'/my/image/path.png', imageTitle:'mute', id:101}); openFrameAPI.setTitleIcon({imageURL:'https://mydomian.com/image/path.png', imageTitle:'mute', id:101}); ## openFrameAPI - toastMessage(문자열 메시지, 문자열 유형, 숫자 기간) {#ariaid-title19} 경보 메시지를 표시합니다. {#openFrameAPI-toastMessage_S_S_N__table_mqv_lqt_tgc__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 메시지 | 문자열 | 경보에 표시할 메시지입니다. | | 유형 | 문자열 | 메시지 유형입니다. 가능한 값: * 정보 * 경고 * 오류 {#openFrameAPI-toastMessage_S_S_N__ul_ex3_crt_tgc} | | 기간 | 번호 | 옵션입니다. 메시지가 자동으로 해제되기 전에 메시지를 표시하는 기간입니다. 단위: 밀리초 기본값: 수동으로 닫을 때까지 메시지가 표시됩니다. | [표 35. 매개변수] {#openFrameAPI-toastMessage_S_S_N__table_mqv_lqt_tgc} {#openFrameAPI-toastMessage_S_S_N__table_nqv_lqt_tgc__entry__2} | 유형 | 설명 | |-|-| | 없음 | | [표 36. 반환] {#openFrameAPI-toastMessage_S_S_N__table_nqv_lqt_tgc} 이 예시에서는 정보, 경고 및 오류 메시지를 표시합니다. openFrameAPI.toastMessage("Testing info message", "info", 10000); //display for 10 seconds openFrameAPI.toastMessage("Testing warning message", "warning"); //display until manually closed openFrameAPI.toastMessage("Testing error message", "error"); ## openFrameAPI - setWidth(너비) {#ariaid-title20} OpenFrame 너비를 설정합니다. {#r_openFrameAPI-setWidth__table_yzb_mxx_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 너비 | 번호 | 너비(픽셀) | [표 37. 매개변수] {#r_openFrameAPI-setWidth__table_yzb_mxx_kt} {#r_openFrameAPI-setWidth__table_zzb_mxx_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 38. 반환] {#r_openFrameAPI-setWidth__table_zzb_mxx_kt} openFrameAPI.setWidth(100); ## openFrameAPI - show() {#ariaid-title21} OpenFrame이 TopFrame에 표시되도록 합니다. {#r_openFrameAPI-show__table_ah2_vwx_kt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 안 함 | | | [표 39. 매개변수] {#r_openFrameAPI-show__table_ah2_vwx_kt} {#r_openFrameAPI-show__table_bh2_vwx_kt__entry__2} | 유형 | 설명 | |-|-| | 무효 | | [표 40. 반환] {#r_openFrameAPI-show__table_bh2_vwx_kt} openFrameAPI.show() ## openFrameAPI - 구독(openFrameAPIEVENT event, 함수 eventCallback) {#ariaid-title22} 지정된 이벤트를 구독합니다. {#r_openFrameAPI-subscribe_Event_Object__table_znv_gvd_lt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 이벤트 | openFrameAPIEVENT | 구독할 이벤트: * interaction_control_action: OpenFrame에서 상호작용 수명주기 이벤트 또는 호출 제어 업데이트를 수신하고 그에 따라 UI를 업데이트합니다. 호출 제어 업데이트 예로는 호출 시작됨, 음소거됨, 보류됨, 종료됨 및 전환 요청이 있습니다. * openframe_agent_off_interaction: 채팅 중인 에이전트의 현재 상태를 꺼짐 또는 사용 가능으로 나타냅니다. * openframe_awa_agent_presence: (AWA)에서 고급 작업 할당 이 이벤트는 에이전트 현재 상태가 변경될 때 발생합니다. CTI(컴퓨터 전화 통합 시스템) 개발자는 이 이벤트를 구독하여 현재 상태 변경 사항을 수신할 수 있습니다. * openframe_awa_client_offer: 복원력 관련 제안에 대한 제안 또는 이전이 이루어질 때 발생합니다. * openframe_awa_workitem_accepted: 에이전트가 작업 항목을 수락하면 발생합니다. * openframe_awa_workitem_offered: 작업 항목이 에이전트에게 제공될 때 발생합니다. * openframe_awa_workitem_rejected: 에이전트가 작업 항목을 거부한 경우에 발생합니다. * openframe_before_destroy: TopFrame이 언로드되기 전에 발생합니다. * openframe_collapse: OpenFrame 헤더에서 축소 아이콘을 선택하면 발생합니다. * openframe_communication: 애플리케이션별로 다르며 사용자 지정할 수 있습니다. * openframe_communication_failure: TopFrame과의 통신이 실패할 때 발생합니다. * openframe_expand: OpenFrame 헤더에서 확장 아이콘을 선택하면 발생합니다. * openframe_heart_beat: 사용자 세션이 확장되거나 로그아웃될 때 발생합니다. * openframe_header_icon_clicked: 사용되지 않음. 대신 openframe_icon_clicked이나 openframe_title_icon_clicked를 사용하십시오. * openframe_hidden: OpenFrame이 숨겨져 있을 때 발생합니다. * openframe_icon_clicked: OpenFrame 바닥글에서 닫기 아이콘 이외의 아이콘을 선택한 경우에 발생합니다. 콜백은 아이콘 객체를 매개변수로 수신합니다. * openframe_shown: OpenFrame이 표시될 때 발생합니다. * openframe_title_icon_clicked: OpenFrame에서 제목 아이콘을 선택하면 발생합니다. 콜백은 titleIcon 객체를 매개변수로 수신합니다. * openframe_wrap_up_submitted: 마 [무리 모덜리스 대화 상자](https://www.servicenow.com/docs/access?context=interaction-wrapup-modeless-dialog&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)에서 마무리 기간이 끝날 때 발생합니다. 마무리가 외부인 경우에만 이벤트가 트리거됩니다. | | 이벤트콜백 | 함수 | 지정된 이벤트가 발생할 때 호출할 함수입니다. | [표 41. 매개변수] {#r_openFrameAPI-subscribe_Event_Object__table_znv_gvd_lt} {#r_openFrameAPI-subscribe_Event_Object__table_a4v_gvd_lt__entry__2} | 유형 | 설명 | |-|-| | 결과 | 대부분의 이벤트 구독에는 반환 값이 없습니다. 값을 반환하는 이벤트 구독은 다음 테이블 항목에 설명되어 있습니다. | | openframe_awa_agent_presence | 에서 AWA이벤트는 openframe_awa_agent_presence`현재 상태` 객체를 반환합니다. "presence":{ "available": Boolean, "channels":[ { "available": Boolean, "name": "String", "restrict_update": Boolean, "sys_id": "String" } ], "name": "String", "sys_id": "String" } presence: 에이전트의 현재 현재 상태 및 채널에 대한 정보입니다. * presence.available: 에이전트를 사용할 수 있는지 여부를 나타내는 플래그입니다. * presence.channels: 에이전트와 통신하는 데 사용할 수 있는 채널을 설명하는 객체의 목록입니다. * presence.channels.available: 채널을 사용할 수 있는지 여부를 나타내는 플래그입니다. * presence.channels.name: 채팅 또는 전화와 같은 채널 이름입니다. * presence.channels.restrict_update: 사용자가 업데이트를 제한할 수 있는지 여부를 나타내는 플래그입니다. * presence.channels.sys_id: 채널 sys_id. {#r_openFrameAPI-subscribe_Event_Object__ul_xf1_pcp_zbc} * presence.name: 에이전트의 현재 상태 이름입니다. * presence.sys_id: 현재 상태 sys_id입니다. {#r_openFrameAPI-subscribe_Event_Object__ul_wf1_pcp_zbc} | | openframe_awa_workitem_accepted 및 openframe_awa_workitem_offered | 에서 AWA및 이벤트는 openframe_awa_workitem_acceptedopenframe_awa_workitem_offered`workItem` 객체를 반환합니다. "workItem": { "document": { "sys_id": "String", "table": "String" }, "isAutoAccepted": Boolean, "isQueueTransferred": Boolean, "previousWorkItem": "String", "serviceChannel": { "name": "String", "sys_id": "String" }, "size": Number, "sys_id": "String" } workItem: 이벤트와 연결된 작업 항목에 대한 정보입니다. * workItem.document: 작업 항목 작업과 연결된 문서 목록입니다. * workItem.document.sys_id: 작업 항목 작업에 할당된 문서의 Sys_id입니다. * workItem.document.table: 작업에 할당된 문서 테이블의 이름입니다. {#r_openFrameAPI-subscribe_Event_Object__ul_svh_jww_zbc} * workItem.isAutoAccepted: 시스템에서 작업 항목을 자동으로 수락했는지 여부를 나타내는 플래그입니다. 작업 항목이 자동으로 수락된 경우 예로 설정합니다. * workItem.isQueueTransferred: 작업 항목이 큐 전송되었는지 여부를 나타내는 플래그입니다. 작업 항목이 큐로 전송되는 경우 예로 설정하고 그렇지 않으면 아니오로 설정합니다. * workItem.previousWorkItem: 동일한 문서 ID에 대한 이전 작업 항목의 Sys_id입니다. 비이전 작업 항목의 경우 이 값은 비어 있습니다. * workItem.serviceChannel: 작업 항목 작업과 연결된 서비스 채널 목록입니다. * workItem.serviceChannel.name: 채팅 또는 전화와 같은 서비스 채널의 이름입니다. * workItem.serviceChannel.sys_id: 서비스 채널의 Sys_id입니다. {#r_openFrameAPI-subscribe_Event_Object__ul_tvh_jww_zbc} * workItem.size: 이 작업 항목이 에이전트에 할당될 때 사용되는 에이전트의 용량입니다. * workItem.sys_id: 수락되거나 제안된 작업 항목의 Sys_id입니다. {#r_openFrameAPI-subscribe_Event_Object__ul_rvh_jww_zbc} | | openframe_awa_workitem_rejected | 에서 AWA이벤트는 openframe_awa_workitem_rejected`workItem` 객체를 반환합니다. "workItem": { "document": { "sys_id": "String", "table": "String" }, "isQueueTransferred": Boolean, "previousWorkItem": "String", "rejection": { "reason": "String", "sys_id": "String" }, "serviceChannel": { "name": "String", "sys_id": "String" }, "size": Number, "sys_id": "String" } workItem: 이벤트와 연결된 작업 항목에 대한 정보입니다. * workItem.document: 작업 항목 작업과 연결된 문서 목록입니다. * workItem.document.sys_id: 작업 항목 작업에 할당된 문서의 Sys_id입니다. * workItem.document.table: 작업에 할당된 문서 테이블의 이름입니다. {#r_openFrameAPI-subscribe_Event_Object__ul_f3z_jww_zbc} * workItem.isQueueTransferred: 작업 항목이 큐 전송되었는지 여부를 나타내는 플래그입니다. 작업 항목이 큐로 전송되는 경우 예로 설정하고 그렇지 않으면 아니오로 설정합니다. * workItem.previousWorkItem: 동일한 문서 ID에 대한 이전 작업 항목의 Sys_id입니다. 비이전 작업 항목의 경우 이 값은 비어 있습니다. * workItem.rejection: 작업 항목을 거부하는 이유 목록입니다. * workItem.rejection.reason: 작업 항목을 거부하는 이유의 이름입니다. * workItem.rejection.sys_id: 거부 사유의 Sys_id입니다. 테이블: 거부 사유 \[awa_reject_reason\] {#r_openFrameAPI-subscribe_Event_Object__ul_g3z_jww_zbc} * workItem.serviceChannel: 작업 항목 작업과 연결된 서비스 채널 목록입니다. * workItem.serviceChannel.name: 채팅 또는 전화와 같은 서비스 채널의 이름입니다. * workItem.serviceChannel.sys_id: 서비스 채널의 Sys_id입니다. {#r_openFrameAPI-subscribe_Event_Object__ul_h3z_jww_zbc} * workItem.size: 이 작업 항목이 에이전트에 할당될 때 사용되는 에이전트의 용량입니다. * workItem.sys_id: 수락되거나 제안된 작업 항목의 Sys_id입니다. {#r_openFrameAPI-subscribe_Event_Object__ul_e3z_jww_zbc} | | openframe_heart_beat | 이벤트는 openframe_heart_beat 다음 객체를 반환합니다. { "lastUiActivity": "String", "sessionLoggedIn": Boolean } * lastUiActivity: 선택 사항입니다. 사용자 세션을 확장한 마지막 UI 활동의 타임 스탬프입니다. * sessionLoggedIn 사용자가 로그인했는지 여부를 나타내는 플래그입니다. * true: 사용자가 로그인했습니다. * false: 사용자가 로그인하지 않았습니다. | | openframe_wrap_up_submitted | 이벤트는 openframe_wrap_up_submitted 다음 객체를 반환합니다. { "wrapUp": { "external": Boolean, "externalSegmentId": "String", "recordId": "String", "recordTable": "String", "wrapUpCode": "String", "wrapUpNotes": "String", "wrapUpSegmentId": "String" } } * external: 마무리가 인스턴스에 의해 ServiceNow 내부적으로 처리되는지 또는 인스턴스 외부에서 ServiceNow 다른 호출 시스템에 의해 관리되는지 여부를 나타내는 플래그입니다. * true: 마무리는 외부 호출 시스템에서 처리됩니다. * false: 마무리는 인스턴스에 ServiceNow 의해 처리됩니다. {#r_openFrameAPI-subscribe_Event_Object__ul_mkx_nhl_wdc} * externalSegmentId: 외부 마무리를 트리거한 외부 데이터 객체의 고유 식별자입니다. * recordId: 마무리 중인 상호작용 기록의 Sys_id입니다. * recordTable: 기록을 포함하는 테이블의 이름입니다. 항상 "상호작용"으로 설정됩니다. * wrapUpCode: 마무리 단계에서 사용자가 선택한 코드로, 상호작용이 해결된 방법을 나타냅니다. * wrapUpNotes: 마무리 작업 중에 사용자가 입력한 상호작용이 해결된 방법을 설명하는 자유 형식 텍스트입니다. * wrapUpSegmentId: 상호작용과 관련된 상호작용 마무리 세그먼트 기록의 Sys_id입니다. 마무리 세그먼트 \[interaction_wrap_up_segment\] 테이블에 있습니다. 마무리 데이터를 포함합니다. | [표 42. 반환] {#r_openFrameAPI-subscribe_Event_Object__table_a4v_gvd_lt} 다음 코드 예제에서는 `openframe_awa_agent_presence` 이벤트에 대해 이 메서드를 호출하는 방법을 보여 줍니다. function handleIconClick(context) { console.log("Icon was clicked", context); } openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_agent_presence, handleIconClick); 출력: // Sample presence object output // openframe_awa_agent_presence event only { "result":{ "presence":{ "name":"Available", "sys_id":"27f675e3739713004a905ee515f6a7c3", "available":true, "channels":[ { "name":"Chat", "available":true, "sys_id":"36f675e4239713124a905fe515f6a832", "restrict_update":false }, { "name":"Phone", "available":true, "sys_id":"9378a530a1820610f809018efd9bc01e", "restrict_update":false } ] } } } 다음 코드 예제에서는 `openframe_awa_workitem_accepted` 이벤트에 대해 이 메서드를 호출하는 방법을 보여 줍니다. function handleIconClick(context) { console.log("Icon was clicked", context); } openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_workitem_accepted, handleIconClick); 출력: // Sample workItem object output // openframe_awa_workitem_accepted event only { "result": { "workItem": { "sys_id": "14c86c40a1650610f87701807d9bc0be", "size": 1, "serviceChannel": { "name": "Chat", "sys_id": "27f675e3739713004a905ee515f6a7c3" }, "document": { "sys_id": "aa582040a1650610f87701807d9bc076", "table": "interaction" }, "previousWorkItem": "7c78a440a1650610f87701807d9bc02b", "isQueueTransferred": true, "isAutoAccepted": true } } } 다음 코드 예제에서는 `openframe_awa_workitem_rejected` 이벤트에 대해 이 메서드를 호출하는 방법을 보여 줍니다. function handleIconClick(context) { console.log("Icon was clicked", context); } openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_workitem_rejected, handleIconClick); 출력: // Sample workItem object output // openframe_awa_workitem_rejected event only { "payload": { "workItem": { "sys_id": "2c3bdc4824250610f8775e73b116f8de", "size": "1", "serviceChannel": { "name": "Chat", "sysID": "27f675e3739713004a905ee515f6a7c3" }, "document": { "sys_id": "cf0a180824250610f8775e73b116f80c", "table": "interaction" }, "rejection": { "reason": "Busy", "sys_id": "4e93fa29b38023002e7b6e5f26a8dc20" }, "previousWorkItem": "831b9c4824250610f8775e73b116f841", "isQueueTransferred": true } } } 다음 예는 이벤트를 구독 interaction_control_action 하는 방법을 보여줍니다. openFrameAPI.subscribe("interaction_control_action", function(action) { // Can perform the action based on the name if (action.name == "mute") { mute(); openFrameAPI.setICContext("activeCall", context); // Update context representing the change } else if (action.name == "getSearchTarget") { action.payload.searchType == "queue" ? fetchQueueTransferList(action.payload.searchTerm) : fetchAgentTransferList(action.payload.searchTerm); openFrameAPI.setICContext("searchTargetList", context); // Call context will have the transfer list } else if (action.name == "logout") { logout(); openFrameAPI.showIframe(); // Show iframe api } }); ## openFrameAPI - 버전 () {#ariaid-title23} OpenFrame API 버전을 반환합니다. {#r_openFrameAPI-version__table_ob3_ryd_lt__entry__3} | 이름 | 유형 | 설명 | |-|-|-| | 안 함 | | | [표 43. 매개변수] {#r_openFrameAPI-version__table_ob3_ryd_lt} {#r_openFrameAPI-version__table_pb3_ryd_lt__entry__2} | 유형 | 설명 | |-|-| | 문자열 | OpenFrame API 버전 | [표 44. 반환] {#r_openFrameAPI-version__table_pb3_ryd_lt} var version = openFrameAPI.version(); console.log("API version " + version);