--- sourceDocument: オーストラリア API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference Release : - australia ft:locale : - ja-JP 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) 所要時間：81分 openFrameAPI は、OpenFrame とやり取りするメソッドを提供します。OpenFrame は、コミュニケーションパートナーが自社のシステムを ServiceNow Platform に統合するために使用できる遍在型フレームです。 コア要件の 1 つは、パートナー サブシステムとシームレスに接続できるさまざまなドメインのコードを接続して提供する機能です。このクロスドメイン接続は、クロスドメインの問題なく接続とコールバックを通信システムに登録し続けるために必要です。 OpenFrame には 2 つの重要な部分があります。1 つは ServiceNow アプリケーション (TopFrame と呼ばれる) と、この API はパートナーアプリケーションから供給されます。この API には、TopFrame と通信し、 [OpenFrame](https://www.servicenow.com/docs/access?context=c_OpenFrameOverview&version=australia&pubname=australia-customer-service-management&ft:locale=en-US) のビジュアル機能を制御するために必要なメソッドがあります。 注: OpenFrame ライブラリへの参照を最新に保つには、https://\[servicenow instance\]/scripts/openframe/latest/openFrameAPI.min.js のリソース URI を使用します。 ## 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" } | | presence.available | 関連付けられたエージェントが利用可能かどうかを示すフラグ。 有効な値： * true:エージェントが利用可能です。 * false:エージェントは利用できません。 データタイプ：ブーリアン | | presence.channels | エージェントとの通信の利用可能なチャネルのリスト。 データタイプ：オブジェクトのアレイ "channels": [ { "available": Boolean, "name": "String", "restrict_update": Boolean, "service_channel_type": "String", "sys_id": "String" } ] | | presence.channels.available | チャネルが利用可能かどうかを示すフラグ。 有効な値： * 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 - hide() {#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} | 名前 | タイプ | 説明 | |-|-|-| | 構成 | オブジェクト | 初期化プロセス中に使用する名前と値のペア。 可能なキー: * 高さ * subTitle * title * タイトルアイコン * 幅 すべてのキーはオプションです。これらのキーと値のペアを設定しない場合は、空のオブジェクトを渡します。 | | 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 が TopFrame に表示されるかどうかを確認します。 {#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} | 名前 | タイプ | 説明 | |-|-|-| | details | オブジェクト | 開くフォームの URL を識別するキーと値のペア。 "details": { "entity": "String"; "interaction_sys_id": "String"; "query": "String" } | | details.entity | 文字列 | テーブルまたはエンティティの名前。 | | 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} | 名前 | タイプ | 説明 | |-|-|-| | details | オブジェクト | リスト URL を開くときに使用するコンテンツを説明するキーと値のペア。 有効な値： * entity:テーブル名 * 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(mode) {#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(String Type, Object \) {#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` * `offerContext` * `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 です。エージェントによる呼び出しの試行 | ブーリアン | コールバックがカスタマーサービスエージェントによって試行されたかどうかを示すフラグ。 有効な値： * true:コールバックはカスタマーサービスエージェントによって試行されました。true の場合、 closeInEndTimeを設定します。 * false:コールバックはカスタマーサービスエージェントによって試行されませんでした。false の場合は、 dialInEndTime を設定します。 {#openFrameAPI-setICContext_S_O__ul_dgl_cyx_nhc} デフォルト値：False | | activeCall。callbackContext です。コールバック番号 | アレイ | 文字列として指定された電話番号のリスト。 | | activeCall。callbackContext です。終了時を閉じる | 文字列 | callAttemptedByAgentが true の場合にのみ設定します。UTC 形式のコールバックの終了時間。 | | activeCall。callbackContext です。顧客名 | 文字列 | 顧客の名前。 | | activeCall。callbackContext です。dialInEndTime | 文字列 | callAttemptedByAgentが false で、コールバックのタイプが自動ダイヤルの場合にのみ設定されます。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 (Contact Center as a Service) コールバック転送ステータス。 可能な値： * 失敗 * 空の文字列 (デフォルト) {#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) 機能があるかどうかを示すフラグ。 有効な値： * 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。記録の一時停止 | ブーリアン | 参加者が通話の記録を一時停止できるかどうかを示すフラグ。 有効な値： * true:参加者は通話の記録を一時停止できます。UI で記録の一時停止ボタンが有効になります。 * false:参加者は通話の記録を一時停止できません。UI では \[記録を一時停止\] ボタンが無効になっています。 {#openFrameAPI-setICContext_S_O__ul_h3y_sv5_w3c} デフォルト値：false | | activeCall.currentParticipant.capabilities。resumeRecording | ブーリアン | 参加者がコールの記録を再開できるかどうかを示すフラグ。 有効な値： * true:参加者は通話の録音を再開できます。UI で記録の一時停止ボタンが有効になります。 * false:参加者はコールの録音を再開できません。UI では \[記録を一時停止\] ボタンが無効になっています。 {#openFrameAPI-setICContext_S_O__ul_l3y_sv5_w3c} デフォルト値：false | | activeCall.currentParticipant.capabilities。記録の開始 | ブーリアン | 参加者が通話の録音を開始できるかどうかを示すフラグ。 有効な値： * 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 | 文字列 | 通話の現在の記録ステータス。 有効な値： * 進行中 * なし {#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。現在のレコード ID | 文字列 | 必須です。アクティブなコールレコードの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。参加者。connectedTime | 文字列 | 必須です。参加者が最初にコールに接続した日時。 時間標準:UTC 形式: RSS - 「\<曜日\>、dd mmm yyyy hh:MM:ss GMT」。例:「Wed, 17 Dec 2024 05:23:41 GMT」 | | activeCall。参加者。カスタムペイロード | オブジェクト | OpenFrame カスタムイベントの一部として 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 が「agent」の場合にのみ有効です。 参加者が顧客をフォローアップするかどうかを示すフラグ。 有効な値： * true:フォローアップが必要です。 * false:フォローアップは必要ありません。 {#openFrameAPI-setICContext_S_O__ul_d5s_xtb_j2c} デフォルト値：false | | activeCall。参加者。requireWrapup | ブール | エージェントユースケース専用: activeCall.currentParticipant.actor が「agent」の場合にのみ有効です。 呼び出しの完了後に 最終作業 コンポーネントを表示するかどうかを示すフラグ。
有効な値： * 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 | 文字列 | 発信コールインタラクションの作成に使用されるプロバイダーアプリケーションの受信識別子。 テーブル:プロバイダーチャネル ID \[sys_cs_provider_application\] テーブルの id フィールドにあります。 デフォルト:ベースシステムプロバイダーアプリケーション | | idleState です。dialpadInfoメッセージ | オブジェクト | 現在選択されているキューなど、ユーザーのダイヤルパッドに表示する情報メッセージの詳細。 "dialpadInfoMessage": { "label": "String", "value": "String" } 次の例では、 label は \[選択されたキュー: \] で、 value は \[顧客の問い合わせ\] です。\[選択したキュー:顧客の問い合わせ (Selected queue: Customer Inquiries)\] で label または value パラメーターのいずれかを使用することもできます。
| | 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 です。outBoundCall | ブーリアン | アイドル状態のときに UI の発信コールボタンを有効にするかどうかを示すフラグ。 有効な値： * true:アイドル状態のときに発信コールボタンを表示します。 * false:アイドル状態の間は発信コールボタンを表示しません。 {#openFrameAPI-setICContext_S_O__ul_wky_sv5_w3c} デフォルト値：false | | offerContext | オブジェクト | 現在の参加者の対障害弾力性のオファーコンテキストに関する詳細。 { "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 または外部 ID。 | | offerContext.transferContent. targetId | 文字列 | キュー転送の sys_id 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。externalId | 文字列 | CCaaS システム上に関連付けられたコールの一意の識別子。 | | searchTargetList。現在のレコード ID | 文字列 | 必須です。searchTargetList が属するレコードのSys_id。 注: 現在、インタラクション \[interaction\] テーブルのレコードのみがサポートされています。 | | searchTargetList。nowRecordTable | 文字列 | 必須です。searchTargetList ServiceNow 属するテーブル。 テーブル:有効な値`「interaction」`のみ | | searchTargetList。participantID | 文字列 | CCaaS システムからの参加者の一意の識別子。 | | searchTargetList.quickStats | オブジェクトのアレイ | オプション。エージェントエントリにのみ適用されます。エージェントのステータス情報を提供するためにエージェント行にインラインで表示されるステータス記述子のリスト。 "quickStats": [ { "label": "String", "value": "String" } ] レンダリング例: `利用可能 |オンコール 1` | | searchTargetList.quickStats.label | 文字列 | エージェント行に表示されるステータスラベル。 | | searchTargetList.quickStats.value | 文字列 | ラベルに追加されるオプションの値。 | | searchTargetList。ターゲット | オブジェクトのアレイ | コールの転送先となるエージェント、外部ユーザー、キューの詳細。 "targets": [ { "payload": {Object}, "transferSubtypes": [Array], "type": "String" } ] | | searchTargetList。ターゲット。ペイロード | オブジェクト | 転送コールコントロールに表示する情報の詳細。 コールを転送できるエージェントのリストを含む転送 コール コントロールの例を次に示します。スクリーンショットには、 list.payload の各パラメーターが制御する UI の要素が表示されます。
"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が`「true」`に設定されている場合は必須です。エージェントまたはキューが持つスキルのリスト。ユーザーがエンティティ名の最後にある情報アイコンを選択すると、この情報がポップアップウィンドウに表示されます。 "moreInfo": [ { "label": "String", "value": "String" } ] | | searchTargetList。ターゲット。ペイロード。リスト。moreInfo です。ラベル | 文字列 | スキルや言語など、ポップアップウィンドウに表示する情報のフリーフォームラベル。 | | searchTargetList。ターゲット。ペイロード。リスト。moreInfo です。価値 | 文字列 | ラベルの後のポップアップウィンドウに表示するテキスト ( CRM 認定 、ドイツ 語など)。 | | searchTargetList。ターゲット。ペイロード。リスト。名前 | 文字列 | エージェント、外部ユーザー、またはキューの名前。CCaaS システムにあります。 | | searchTargetList。ターゲット。ペイロード。リスト。出席 | 文字列 | 関連付けられたエージェントの在席状況。このパラメーターは、「`agent」`の searchTargetList.targets.type に対してのみ有効です。 有効な値： * 利用可能 * アウェー * busy * オフライン {#openFrameAPI-setICContext_S_O__ul_dly_sv5_w3c} | | searchTargetList。ターゲット。transferSubtype | オブジェクトのアレイ | 指定された searchTargetList.targets.typeでサポートされている転送のタイプに関する詳細。 この情報は、ユーザーが UI のターゲット名の横にある省略記号をクリックすると表示されます。
たとえば、現在のターゲットタイプ (キューなど) でコンサルトタイプのみがサポートされている場合、この配列には転送のコンサルトタイプを示す 1 つのオブジェクトが含まれます。 "transferSubtypes": [ { "id": "String", "label": "String" } ] | | searchTargetList。ターゲット。transferSubtypeです。身分証明書 | 文字列 | 転送サブタイプの識別子。 有効な値： * blind:エージェントは、エージェントと最初に話すことなく、顧客コールを別のエージェントまたはキューに直接転送します。 * 相談:エージェントは相談したいエージェントに連絡し、顧客をコンサルティングエージェントとの通話に結合します。 {#openFrameAPI-setICContext_S_O__ul_gly_sv5_w3c} これは searchTargetList.targets.transferSubtypes.label の値に対応している必要があります。 | | searchTargetList。ターゲット。transferSubtypeです。ラベル | 文字列 | 転送サブタイプのラベル。ラベルを渡さない場合、転送サブタイプの 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} デフォルト:3 つのタブすべてが表示されます。 | | タイプ | 文字列 | 設定するコンテキストデータのタイプ。 有効な値： * activeCall:進行中のアクティブコールコンポーネントのコンテキストを設定します。このコンテキスト型を渡す場合は、 `activeCall[]`Context パラメーターも渡す必要があります。 * idleState:現在のユーザーのアイドル状態機能を設定します。このタイプを設定すると、OpenFrame にアイドル状態の UI (ダイヤルパッド) が表示されます。このコンテキストタイプを渡す場合は、Context パラメーターとして `{}` JSON も渡す必要があります。 * offerContext:現在の参加者の対障害弾力性のオファーコンテキストを設定します。このコンテキストタイプを渡す場合は、Contextパラメーターとして `offerContext{}` JSON も渡す必要があります。 * 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/o56ZiZ~iRIfbo0jJX9XUUQ#r_openFrameAPI-subscribe_Event_Object "指定されたイベントに登録します。") メソッドを使用してイベント openframe_awa_client_offer サブスクライブします。 コンテキスト値は次のように表されます。 1. 成功 2. error 3. 部分的成功 {#openFrameAPI-setICContext_S_O__ul_oss_4zn_rhc} AWA_EXTUSER_ROLE_CHECK_FAILED : メッセージ:ユーザーにawa_external_userロールがありません。 : このイベントは、必要なロール「awa_external_user」または「admin」がエージェントに存在しないことを示します。 AWA_AGENT_NOT_AVAILABLE : メッセージ:エージェントは作業を受信できません。 : このイベントは、選択したエージェントが対応不可であることを示します。 AWA_OFFER_ASSIGNMENT_PAYLOAD_MISSING : メッセージ:offerContext でアサインペイロードが空または未定義です。 : このイベントは、 offerContext オブジェクトでペイロードが空または未定義であることを示します。 AWA_OFFER_QUEUEID_MISSING : メッセージ:転送ソースキュー ID が offerContext にありません。 : このイベントは、必要な転送キュー 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} | 名前 | タイプ | 説明 | |-|-|-| | アイコン | オブジェクトのアレイ | アイコン構成のリスト。各アイコン構成は、キー値 imageURL、 imageTitle、およびその他の必要なコンテキストを持つオブジェクトです。 最大サイズ:アイコンの最大サイズは 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} | 名前 | タイプ | 説明 | |-|-|-| | state | 文字列 | エージェントの在席状況。 デフォルトのステータス: * 利用可能 * アウェー * オフライン {#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} | 名前 | タイプ | 説明 | |-|-|-| | 幅 | 番号 | ゼロより大きい値にしてください。 | | 高さ | 番号 | ゼロより大きい値にしてください。 | [表 : 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(文字列 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(文字列 title) {#ariaid-title17} OpenFrame タイトルを設定します。 {#r_openFrameAPI-setTitle_String__table_jbl_w3y_kt__entry__3} | 名前 | タイプ | 説明 | |-|-|-| | title | 文字列 | 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} | 名前 | タイプ | 説明 | |-|-|-| | icon | オブジェクト | キーと値のペアのオブジェクト。キーには、 imageURL、 imageTitle、およびその他の必要なコンテキストが含まれます。 最大サイズ:アイコンの最大サイズは 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} | 名前 | タイプ | 説明 | |-|-|-| | message | 文字列 | アラートに表示するメッセージ。 | | type | 文字列 | メッセージのタイプ 可能な値： * info * 警告 * error {#openFrameAPI-toastMessage_S_S_N__ul_ex3_crt_tgc} | | duration | 番号 | オプション。メッセージが自動却下されるまでの期間。 単位:ミリ秒 デフォルト:メッセージは、手動で閉じられるまで表示されます。 | [表 : 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(width) {#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 - subscribe(openFrameAPIEVENT event, function 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} | タイプ | 説明 | |-|-| | results | ほとんどのイベントサブスクリプションには戻り値がありません。値を返すイベントサブスクリプションについては、次の表エントリで説明しています。 | | 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_acceptedイベントとopenframe_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:作業アイテムがシステムによって自動的に承認されたかどうかを示すフラグ。作業アイテムが自動承認された場合は true に設定します。 * workItem.isQueueTransferred:作業アイテムがキュー転送されているかどうかを示すフラグ。作業アイテムがキュー転送された場合は true に設定し、そうでない場合は false に設定します。 * 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:作業アイテムがキュー転送されているかどうかを示すフラグ。作業アイテムがキュー転送された場合は true に設定し、そうでない場合は false に設定します。 * 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);