---
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


---

# OpenFrame API

# OpenFrame API {#ariaid-title1}

* リリースバージョン: Australia
* 
* 更新日 2026年03月12日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：17分

openframe API は、サービスとしてのコンタクトセンター (CCaaS) に操作ハンドラーを使用せずにインタラクションレコードを作成および更新する機能を提供するエンドポイントを提供します。
この API を使用して、エージェントの電話を追跡するためのインタラクションレコードを作成します。インタラクションレコードが作成されると、エージェントが電話を受けたときにインタラクションが CSM 構成可能ワークスペース に自動的に表示されます。

この API にアクセスするには、com.sn_openframe_store プラグインがインスタンスにインストールされており、呼び出し元ユーザーには sn_openframe_api_user ロールまたは sn_openframe_user ロールが必要です。openframe API は `sn_openframe` 名前空間で実行されます。

CSM 音声インタラクションレコードの詳細については、「 [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)」を参照してください。

## openframe:パッチ /openframe/voice-interaction/{interactionSysId} {#ariaid-title2}

インタラクション \[interaction\] テーブル内の指定されたインタラクションレコードを更新します。サービスとしてのコンタクトセンター (CCaaS) プロバイダーは、これらのレコードを使用して電話を追跡できます。
<br />

### URL 形式 {#openframe-PATCH-voice-inter-intSysId__section_kqk_vrd_12c}

バージョニングされた URL: /api/now/openframe/{api_version}/voice-interaction/{interactionSysId}

デフォルト URL: /api/now/openframe/voice-interaction/{interactionSysId}  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

### サポートされている要求パラメーター

{#openframe-PATCH-voice-inter-intSysId__entry__2}{#openframe-PATCH-voice-inter-intSysId__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| interactionSysId | 更新するインタラクションレコードのSys_id。この値は、 [音声インタラクションの作成/POST](https://servicenow-prod.fluidtopics.net/c3WQiSeMA8nUWcBbgfNTTQ#openframe-POST-voice-interaction "エージェントがコールを受け入れたときに、インタラクション [interaction] テーブルにインタラクションレコードを作成します。サービスとしてのコンタクトセンター (CCaaS) プロバイダーは、これらのレコードを使用して電話を追跡できます。") エンドポイントによって返されます。 データタイプ：文字列 テーブル:インタラクション \[interaction\] |
[表 : 1. パスパラメーター]

{#openframe-PATCH-voice-inter-intSysId__entry__8}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 2. クエリパラメーター]

{#openframe-PATCH-voice-inter-intSysId__entry__12}{#openframe-PATCH-voice-inter-intSysId__openframe-interaction-entry}{#openframe-PATCH-voice-inter-intSysId__openframe-interaction_additionalParams-entry}{#openframe-PATCH-voice-inter-intSysId__openframe-interaction_callbackPhoneNumber-entry}{#openframe-PATCH-voice-inter-intSysId__openframe-interaction_clientSessionId-entry}{#openframe-PATCH-voice-inter-intSysId__openframe-interaction_inboundId-entry}{#openframe-PATCH-voice-inter-intSysId__openframe-interactionContext-entry}{#openframe-PATCH-voice-inter-intSysId__openframe-phoneLogs-entry}{#openframe-PATCH-voice-inter-intSysId__openframe-relatedRecords-entry}{#openframe-PATCH-voice-inter-intSysId__openframe-relatedRecords_documentId-entry}{#openframe-PATCH-voice-inter-intSysId__openframe-relatedRecords_documentTable-entry}

| 名前 | 説明 |
|-|-|
| インタラクション | 必須です。音声インタラクションの詳細。少なくとも 1 つのパラメーターを渡す必要があります。 データタイプ: オブジェクト "interaction": { "additionalParams": {Object}, "callbackPhoneNumber": "String", "clientSessionId": "String", "inboundId": "String", "userPhoneNumber": "String" } |
| interaction.additionalParams | 関連付けられたインタラクションレコードフィールドとそれぞれの値の名前と値のペア。 例： "additionalParams": { "direction": "inbound", "short_description": "New outbound call", "assigned_to": "a8f98bb0eb32010045e1a5115206fe3a" } データタイプ: オブジェクト デフォルト：なし |
| interaction.callbackPhoneNumber | 発信者のコールバック電話番号。これは、コールが切断された場合にエージェントが発信者に連絡するために使用する番号です。 この値は、インタラクション \[interaction\] テーブルの caller_phone_number フィールドにマッピングされます。 [\[音声インタラクションを作成\]/\[POST](https://servicenow-prod.fluidtopics.net/c3WQiSeMA8nUWcBbgfNTTQ#openframe-POST-voice-interaction "エージェントがコールを受け入れたときに、インタラクション [interaction] テーブルにインタラクションレコードを作成します。サービスとしてのコンタクトセンター (CCaaS) プロバイダーは、これらのレコードを使用して電話を追跡できます。")\] の callerPhoneNumber プロパティの説明も参照してください。 データタイプ：文字列 フォーマット:E.164 デフォルト：なし |
| interaction.clientSessionId | この電話を追跡するために使用される外部システム内のレコードの一意の識別子。この情報は、2 つのシステム間のレコードをリンクします。 データタイプ：文字列 デフォルト：なし |
| interaction.inboundId | 音声サービスのアプリケーションプロバイダーの一意の識別子。 テーブル:プロバイダーチャネルアプリケーション \[sys_cs_provider_application\] テーブルの受信 ID フィールド。 デフォルト：なし |
| interaction.userPhoneNumber | 音声インタラクションに関連付けられたコールを発信したユーザーの電話番号。 データタイプ：文字列 フォーマット:E.164 |
| インタラクションコンテキスト | 設定するインタラクションコンテキスト変数。インタラクションレコードに保存するインタラクションコンテキスト変数の名前と値のペア。これらの値は CCaaS によって決定されます。 例： "interactionContext":{ "devicetype": "genesys", "requester_session_language": "en-US" } データタイプ: オブジェクト デフォルト：なし |
| phoneLog | 作成してコールに関連付ける電話ログの名前と値のペア。電話ログ \[sn_open_frame_phone_log\] テーブルの任意のフィールドを指定できます。 例： "phoneLogs":[ { "agent": "String", "call_id": "String", "start_time": "String" } ] データタイプ：オブジェクトのアレイ デフォルト：なし |
| 関連レコード | コールに関連するレコード。 データタイプ：オブジェクトのアレイ "relatedRecords":[ { "documentId": "String", "documentTable": "String" } ] デフォルト：なし |
| relatedRecords.documentId | 関連レコードのSys_id。 データタイプ：文字列 テーブル: relatedRecords.documentTable パラメーターで指定します。 |
| relatedRecords.documentTable | 関連レコードを含むテーブルの名前。 データタイプ：文字列 |
[表 : 3. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#openframe-PATCH-voice-inter-intSysId__entry__36}{#openframe-PATCH-voice-inter-intSysId__accept-RESTAPI}{#openframe-PATCH-voice-inter-intSysId__content_type-RESTAPI}

| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
| Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 4. 要求ヘッダー]

{#openframe-PATCH-voice-inter-intSysId__entry__42}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 5. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#openframe-PATCH-voice-inter-intSysId__entry__46}{#openframe-PATCH-voice-inter-intSysId__entry-200-status-code}{#openframe-PATCH-voice-inter-intSysId__entry-400-status-code}{#openframe-PATCH-voice-inter-intSysId__entry-500-status-code}

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
[表 : 6. ステータスコード]

### 応答本文のパラメーター (JSON または XML)

{#openframe-PATCH-voice-inter-intSysId__entry__54}

| 名前 | 説明 |
|-|-|
| status | レコード更新のステータス。 可能な値： * 成功:インタラクションレコードが正常に更新されました。 * エラー:インタラクションレコードが更新されませんでした。 {#openframe-PATCH-voice-inter-intSysId__ul_wyh_x2j_12c} |
[ ]

### cURL 要求

次のコード例は、sys_id 12961fff7fb2d2102d0cd3cf8c86652b でインタラクションレコードを更新する方法を示しています。

    curl "http://instance.service-now.com/api/now/openframe/voice-interaction/12961fff7fb2d2102d0cd3cf8c86652b" \
    --request PATCH \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"interaction\":{
          \"additionalParams\":{
             \"direction\":\"inbound\",
             \"short_description\":\"New Poonam outbound call\",
             \"assigned_to\":\"a8f98bb0eb32010045e1a5115206fe3a\"
          }
       },
       \"interactionContext\":{
          \"devicetype\":\"genesys\",
          \"requester_session_language\":\"en-US\"
       },
       \"phoneLogs\":[
          {
             \"call_id\":\"2323223\",
             \"agent\":\"a8f98bb0eb32010045e1a5115206fe3a\",
             \"start_time\":\"2024-11-04 21:45:00\"
          },
          {
             \"call_id\":\"33535353\",
             \"agent\":\"a8f98bb0eb32010045e1a5115206fe3a\",
             \"start_time\":\"2024-11-04 21:45:00\"
          },
          {
             \"call_id\":\"1997654\",
             \"agent\":\"a8f98bb0eb32010045e1a5115206fe3a\",
             \"start_time\":\"2024-11-04 21:45:00\"
          }
       ],
       \"relatedRecords\":[
          {
             \"documentTable\":\"csm_consumer\",
             \"documentId\":\"59e788fbdb1b1200b6075200cf9619d2\"
          },
          {
             \"documentTable\":\"sys_user\",
             \"documentId\":\"62826bf03710200044e0bfc8bcbe5df1\"
          }
       ]
    }" \
    --user 'username':'pasword'

応答：

    {
      "result": {
        "status": "SUCCESS"
      }
    }

## openframe:POST /openframe/voice-interaction {#ariaid-title3}

エージェントがコールを受け入れたときに、インタラクション \[interaction\] テーブルにインタラクションレコードを作成します。サービスとしてのコンタクトセンター (CCaaS) プロバイダーは、これらのレコードを使用して電話を追跡できます。
このエンドポイントを使用して、チャットやケースなどの他のネイティブチャネルと同様に、電話を受けるときに一貫したエクスペリエンスをエージェントに提供します。

### URL 形式 {#openframe-POST-voice-interaction__section_kqk_vrd_12c}

バージョニングされた URL: /api/now/openframe/{api_version}/voice-interaction

デフォルト URL: /api/now/openframe/voice-interaction  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

### サポートされている要求パラメーター

{#openframe-POST-voice-interaction__entry__2}{#openframe-POST-voice-interaction__version-not_optional-RESTAPI}

| 名前 | 説明 |
|-|-|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 <kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd> などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
[表 : 7. パスパラメーター]

{#openframe-POST-voice-interaction__entry__6}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 8. クエリパラメーター]

{#openframe-POST-voice-interaction__entry__10}{#openframe-POST-voice-interaction__openframe-interaction_additionalParams-entry}{#openframe-POST-voice-interaction__openframe-interaction_callbackPhoneNumber-entry}{#openframe-POST-voice-interaction__openframe-interaction_clientSessionId-entry}{#openframe-POST-voice-interaction__openframe-interaction_inboundId-entry}{#openframe-POST-voice-interaction__openframe-interaction_userPhoneNumber-ph}{#openframe-POST-voice-interaction__openframe-interactionContext-entry}{#openframe-POST-voice-interaction__openframe-phoneLogs-entry}{#openframe-POST-voice-interaction__openframe-relatedRecords-entry}{#openframe-POST-voice-interaction__openframe-relatedRecords_documentId-entry}{#openframe-POST-voice-interaction__openframe-relatedRecords_documentTable-entry}

| 名前 | 説明 |
|-|-|
| インタラクション | 必須です。音声インタラクションの詳細。 少なくとも 1 つのパラメーターを渡す必要があります。 データタイプ: オブジェクト "interaction": { "additionalParams": {Object}, "callbackPhoneNumber": "String", "clientSessionId": "String", "inboundId": "String", "userPhoneNumber": "String" } |
| interaction.additionalParams | 関連付けられたインタラクションレコードフィールドとそれぞれの値の名前と値のペア。 例： "additionalParams": { "direction": "inbound", "short_description": "New outbound call", "assigned_to": "a8f98bb0eb32010045e1a5115206fe3a" } データタイプ: オブジェクト デフォルト：なし |
| interaction.callbackPhoneNumber | 発信者のコールバック電話番号。これは、コールが切断された場合にエージェントが発信者に連絡するために使用する番号です。 この値は、インタラクション \[interaction\] テーブルの caller_phone_number フィールドにマッピングされます。 [\[音声インタラクションを作成\]/\[POST](https://servicenow-prod.fluidtopics.net/c3WQiSeMA8nUWcBbgfNTTQ#openframe-POST-voice-interaction "エージェントがコールを受け入れたときに、インタラクション [interaction] テーブルにインタラクションレコードを作成します。サービスとしてのコンタクトセンター (CCaaS) プロバイダーは、これらのレコードを使用して電話を追跡できます。")\] の callerPhoneNumber プロパティの説明も参照してください。 データタイプ：文字列 フォーマット:E.164 デフォルト：なし |
| interaction.clientSessionId | この電話を追跡するために使用される外部システム内のレコードの一意の識別子。この情報は、2 つのシステム間のレコードをリンクします。 データタイプ：文字列 デフォルト：なし |
| interaction.inboundId | 音声サービスのアプリケーションプロバイダーの一意の識別子。 テーブル:プロバイダーチャネルアプリケーション \[sys_cs_provider_application\] テーブルの受信 ID フィールド。 デフォルト：なし |
| interaction.userPhoneNumber | 必須です。音声インタラクションに関連付けられたコールを発信したユーザーの電話番号。 データタイプ：文字列 フォーマット:E.164 |
| インタラクションコンテキスト | 設定するインタラクションコンテキスト変数。インタラクションレコードに保存するインタラクションコンテキスト変数の名前と値のペア。これらの値は CCaaS によって決定されます。 例： "interactionContext":{ "devicetype": "genesys", "requester_session_language": "en-US" } データタイプ: オブジェクト デフォルト：なし |
| phoneLog | 作成してコールに関連付ける電話ログの名前と値のペア。電話ログ \[sn_open_frame_phone_log\] テーブルの任意のフィールドを指定できます。 例： "phoneLogs":[ { "agent": "String", "call_id": "String", "start_time": "String" } ] データタイプ：オブジェクトのアレイ デフォルト：なし |
| 関連レコード | コールに関連するレコード。 データタイプ：オブジェクトのアレイ "relatedRecords":[ { "documentId": "String", "documentTable": "String" } ] デフォルト：なし |
| relatedRecords.documentId | 関連レコードのSys_id。 データタイプ：文字列 テーブル: relatedRecords.documentTable パラメーターで指定します。 |
| relatedRecords.documentTable | 関連レコードを含むテーブルの名前。 データタイプ：文字列 |
[表 : 9. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー」](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")を参照してください。
{#openframe-POST-voice-interaction__entry__34}{#openframe-POST-voice-interaction__accept-RESTAPI}{#openframe-POST-voice-interaction__content_type-RESTAPI}

| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
| Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 10. 要求ヘッダー]

{#openframe-POST-voice-interaction__entry__40}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 11. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/lLW_uT5I5_l1aD8yR4Jt9A "REST (REpresentational State Transfer) は、Web 上のコンピューター システム間の標準を提供するシンプルなステートレス アーキテクチャであり、コンピューター システム間の通信を容易にします。")」を参照してください。
{#openframe-POST-voice-interaction__entry__44}{#openframe-POST-voice-interaction__entry-200-status-code}{#openframe-POST-voice-interaction__entry-400-status-code}{#openframe-POST-voice-interaction__entry-500-status-code}

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
[表 : 12. ステータスコード]

### 応答本文のパラメーター (JSON または XML)

{#openframe-POST-voice-interaction__entry__52}

| 名前 | 説明 |
|-|-|
| number | 成功時にのみ返されます。新しく作成された音声インタラクションのインタラクション番号。 データタイプ：文字列 |
| status | レコード作成のステータス。 可能な値： * 成功:インタラクションレコードが正常に作成されました。 * エラー:インタラクションレコードが作成されませんでした。 {#openframe-POST-voice-interaction__ul_wyh_x2j_12c} |
| sysId | 成功時にのみ返されます。新しく作成された音声インタラクションレコードのSys_id。 テーブル:インタラクション \[interaction\] |
[ ]

### cURL 要求

次のコード例は、新しいインタラクションレコードを作成する方法を示しています。

    curl "http://instance.service-now.com/api/now/openframe/voice-interaction" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"interaction\":{
          \"userPhoneNumber\":\"+1303506536\",
          \"clientSessionId\":\"a545t65678\",
          \"callbackPhoneNumber\":\"+14089965744\",
          \"additionalParams\":{
             \"direction\":\"inbound\",
             \"short_description\":\"New outbound call\",
             \"assigned_to\":\"a8f98bb0eb32010045e1a5115206fe3a\"
          }
       },
       \"interactionContext\":{
          \"devicetype\":\"genesys\",
          \"requester_session_language\":\"en-US\"
       },
       \"phoneLogs\":[
          {
             \"call_id\":\"2323223\",
             \"agent\":\"a8f98bb0eb32010045e1a5115206fe3a\",
             \"start_time\":\"2024-11-04 21:45:00\"
          },
          {
             \"call_id\":\"33535353\",
             \"agent\":\"a8f98bb0eb32010045e1a5115206fe3a\",
             \"start_time\":\"2024-11-04 21:45:00\"
          },
          {
             \"call_id\":\"1997654\",
             \"agent\":\"a8f98bb0eb32010045e1a5115206fe3a\",
             \"start_time\":\"2024-11-04 21:45:00\"
          }
       ],
       \"relatedRecords\":[
          {
             \"documentTable\":\"csm_consumer\",
             \"documentId\":\"59e788fbdb1b1200b6075200cf9619d2\"
          },
          {
             \"documentTable\":\"sys_user\",
             \"documentId\":\"62826bf03710200044e0bfc8bcbe5df1\"
          }
       ]
    }" \
    --user 'username':'password'

応答：

    {
      "result": {
        "status": "SUCCESS",
        "sysId": "12961fff7fb2d2102d0cd3cf8c86652b",
        "number": "IMS0000052"
      }
    }