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


---

# Omichannel コールバック API

# Omichannel コールバック API {#ariaid-title1}

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

オムニチャネルコールバック API は、ライブエージェント会話のコールバック要求を作成、更新、および開始するためのメソッドを提供します。
Omnichannel Callback API を使用すると、エージェントは、利用可能なエージェントをキューで待つのではなく、プログラムでユーザーにコールバックできます。たとえば、コールバック機能を使用して、エージェントの待ち時間が長い場合やエージェントが対応可能なエージェントがいない場合に、コールバック機能を使用してユーザーにコールバックできます。この API では、次のアクションを実行できます。

* 新しい緊急コールバック要求を作成するか、新しい要求をスケジュールします。
* 最初のインタラクションとその後の再試行インタラクションを作成します。
* 既存のコールバックを更新します。
{#omichannel-callback-api__ul_wps_thh_2gc}

この API は sn_omni_callback 名前空間に属しており、コールバック API \[sn_omni_callback.callback_api\] ロールを持つアドミニストレーターが必要です。

ServiceNow AI Platform 機能としての オムニチャネルコールバック アプリケーションの詳細については、「[Omnichannel Callback](https://www.servicenow.com/docs/access?context=omnichannel-callback&version=australia&pubname=australia-conversational-interfaces&ft:locale=en-US)」を参照してください。

## オムニチャネルコールバック:POST api/sn_omni_callback/アクション {#ariaid-title2}

サードパーティのサービスとしての連絡先センター (CCaaS) プラットフォームを ServiceNow® のオムニチャネル コールバック システムと統合するためのアクションを提供します。この API はブリッジとして機能し、構成可能な ワークフロースタジオ サブフローを介してコールバック操作 (作成、更新、キャンセル、クローズ) を外部 CCaaS プロバイダーにルーティングします。
注:  
このエンドポイントは [オムニチャネルコールバック:POST /api/sn_omni_callback/callback/create](https://servicenow-prod.fluidtopics.net/1vKwjQuoaGIo_xNR6bBsqg#omnichannel-callback-POST-create "要求本文に入力された詳細に基づいて、新しい即時コールバック要求またはスケジュールされたコールバック要求を開始します。即時コールバックの場合、この API はコールバックとインタラクションの両方を作成します。スケジュールされたコールバックの場合は、予約 ID を使用してコールバックを作成します。") および [オムニチャネルコールバック:PATCH /api/sn_omni_callback/callback/update](https://servicenow-prod.fluidtopics.net/1vKwjQuoaGIo_xNR6bBsqg#omnichannel-callback-PATCH-update "要求で指定された詳細に従って、既存のコールバックを更新します。") と同様に機能しますが、ルーティングコンテキストとのサードパーティ統合でコールバックを更新または作成するために使用されます。

### インテリジェントルーティング {#omnichannel-callback-POST-actions__xxx}

/actions エンドポイントは、routingContext パラメーターに基づいてコールバック要求をインテリジェントにルーティングします。ルーティングルールが設定されている場合、API はすべてのアクションに対して単一の統一されたペイロード構造を使用し、 `routingContext` を使用して要求を CCaaS サブフローにルーティングします。ルーティングが設定されている場合、要求の内容は変更されません。トップレベルの action 値のみが異なります。  
注:  
API は、 routingContext パラメーターに基づいて、コールバックルーティング構成 \[sys_cs_callback_routing_config\] テーブルのルーティングルールをチェックします。一致するルールが見つかった場合、要求は設定されたカスタムサブフローに転送されます。サブフローは、外部 CCaaS プラットフォームと統合したり、カスタムビジネスロジックを実装したりできます。サブフローは要求を処理し、応答を返します。

routingContextが省略された場合、またはルーティングルールが一致しない場合、API はデフォルトのServiceNow動作にフォールバックし、対応する POST /create、PATCH /update、または PATCH /cancel エンドポイントの標準ペイロード形式を想定します。

### URL 形式

バージョニングされた URL: /api/sn_omni_callback/v1/actions

デフォルト URL: /api/sn_omni_callback/actions

### サポートされている要求パラメーター {#omnichannel-callback-POST-actions__section_hxc_cvl_k3c}

{#omnichannel-callback-POST-actions__table_ixc_cvl_k3c__entry__2}{#omnichannel-callback-POST-actions__version-not_optional-RESTAPI}

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

{#omnichannel-callback-POST-actions__table_ixc_cvl_k3c} {#omnichannel-callback-POST-actions__table_jxc_cvl_k3c__entry__2}

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

{#omnichannel-callback-POST-actions__table_jxc_cvl_k3c} {#omnichannel-callback-POST-actions__table_myd_yh1_zhc__entry__2}

| 名前 | 説明 |
|-|-|
| オブジェクト | 操作と詳細を含むオブジェクト。 データタイプ: オブジェクト { "action": "String", "payload": {Object}, "routingContext": {Object} } |
| action | 必須です。コールバックで実行するアクションを定義します。 指定できる値: * `create`:新しいコールバックレコードを作成します。 * `update`:コールバック番号に基づいて既存のコールバックレコードを更新します。 * `close`:コールバック要求が履行されたため、コールバックレコードをクローズします。コールバックを開始しません。コールバック \[sys_cs_callback\] テーブルの理由フィールドを更新します。 * `cancel`:顧客が要求をキャンセルし、エージェントに接続する必要がないため、コールバックレコードをキャンセルします。コールバック \[sys_cs_callback\] テーブルの理由フィールドを更新します。 {#omnichannel-callback-POST-actions__ul_ksm_z4t_k3c} データタイプ：文字列 |
| payload | 必須です。オブジェクトが渡されたときに、指定されたアクションに必要な特定のデータを含むオブジェクト routingContext 。クローズ操作とキャンセル操作の場合、ペイロードに必要なのは callbackID のみです。 注: 作成アクションと更新アクションでroutingContextが渡されない場合は、それぞれ[オムニチャネルコールバック:POST /api/sn_omni_callback/callback/create](https://servicenow-prod.fluidtopics.net/1vKwjQuoaGIo_xNR6bBsqg#omnichannel-callback-POST-create "要求本文に入力された詳細に基づいて、新しい即時コールバック要求またはスケジュールされたコールバック要求を開始します。即時コールバックの場合、この API はコールバックとインタラクションの両方を作成します。スケジュールされたコールバックの場合は、予約 ID を使用してコールバックを作成します。")操作と[オムニチャネルコールバック:PATCH /api/sn_omni_callback/callback/update](https://servicenow-prod.fluidtopics.net/1vKwjQuoaGIo_xNR6bBsqg#omnichannel-callback-PATCH-update "要求で指定された詳細に従って、既存のコールバックを更新します。")操作に記載されているpayloadオブジェクト構造を使用します。「例」セクションでは、ルーティングシナリオと非ルーティングシナリオの両方を示しています。 データタイプ: オブジェクト payload 作成アクションと更新アクションの構造。 { "callbackContext": {Object}, "callbackDetails": {Object}, "callbackId": "String", "phoneNumber": "String", "type": "String" } payload クローズアクションとキャンセルアクションの構造。 "payload": { "callbackId": "String" } |
| payload.callbackContext | オプション。コールバック要求に関するコンテキストの詳細を含むオブジェクト。 テーブル:コールバックコンテキスト \[sys_cs_callback_context\] データタイプ: オブジェクト "callbackContext": { "customer_timezone": "String", "ivr_path": "String", "queue": "String" } |
| payload.callbackContext.customer_timezone | コールバックを要求した顧客のタイムゾーン。タイムゾーンは、次の形式で指定できます。 * `国/市区町村:`たとえば、 `アメリカ/Los_Angeles`。 * `国/タイムゾーン`: `たとえば、米国/太平洋です`。 * `タイムゾーンの略称`: `PST` など。 {#omnichannel-callback-POST-actions__ul_qdp_cwx_4gc} 有効なタイムゾーンの完全なリストについては、ユーザー \[sys_user\] テーブルのタイムゾーンフィールドを参照してください。タイムゾーンの詳細については、「 [Time zones](https://www.servicenow.com/docs/access?context=r_TimeZones&version=australia&pubname=australia-platform-administration&ft:locale=en-US)」を参照してください。 データタイプ：文字列 |
| payload.callbackContext.ivr_path | 顧客が人間のエージェントに転送される前にたどる IVR (音声自動応答) パス。 通常、顧客が IVR システムで移動したキューまたはメニューオプションのリストが含まれています。この文字列は、Contact Center as a Service (CCaaS) によって渡されます。例: `「ivr_path」:「テクニカルサポート>アカウント管理」` データタイプ：文字列 |
| payload.callbackContext.queue | キュー内の番号割り当て。 データタイプ：文字列 |
| payload.callbackDetails | オプション。コールバック要求に関する詳細を含むオブジェクト。 テーブル:コールバック \[sys_cs_callback\] データタイプ: オブジェクト "callbackDetails": { "description": "String", "end_time": "String", "expire_time": "String", "first_name": "String", "last_name": "String", "opened_by": "String", "phone_number": "String", "next_retry": "String", "reason": "String", "scheduled_start_time": "String", "short_description": "String", "state": "String", "type": "String" } |
| payload.callbackDetails.description | コールバック要求の詳細な説明。顧客の具体的な懸念事項、コンテキスト、またはエージェントからのメモを含めることができます。 データタイプ：文字列 |
| payload.callbackDetails.end_time | コールバック要求の完了が予定されている期間。このタイムスタンプを過ぎると、再スケジュールされない限り、コールバックは期限切れまたは期限切れと見なされます。`スケジュールされた`コールバックタイプにのみ適用されます。 形式:`yyyy-MM-dd HH:mm:ss` などのglide_date_time値 データタイプ：文字列 |
| payload.callbackDetails.expire_time | これを超えるとコールバック要求を試行できなくなる最終カットオフ時間。これは、古い要求を自動的にクローズまたはキャンセルするためによく使用されます。 形式:`yyyy-MM-dd HH:mm:ss` などのglide_date_time値 データタイプ：文字列 |
| payload.callbackDetails.first_name | コールバックを要求している顧客の名。 データタイプ：文字列 |
| payload.callbackDetails.last_name | コールバックを要求している顧客の姓。 データタイプ：文字列 |
| payload.callbackDetails.opened_by | コールバック要求を作成または開始したユーザーまたはエージェントのSys_id。 テーブル： ユーザー \[sys_user\] |
| payload.callbackDetails.phone_number | 折り返しコールする顧客の電話番号。 データタイプ：文字列 |
| payload.callbackDetails.next_retry | 前回のコールバック試行が失敗した場合の次のスケジュールされた試行時間。自動または手動の再試行ロジックに役立ちます。 形式:`yyyy-MM-dd HH:mm:ss` などのglide_date_time値 データタイプ：文字列 |
| payload.callbackDetails.reason | コールバック要求の理由。コールバックに標準化された理由でタグを付けることで、ルーティング、分析、およびレポートに役立ちます。 有効な値： * `その他の問題` * 実装によって定義されたカスタム値。例:`「請求に関する照会」、「``テクニカルサポート」` {#omnichannel-callback-POST-actions__ul_tq1_x1z_hgc} テーブル:コールバック \[sys_cs_callback\]、フィールド:reason_type データタイプ：文字列 |
| payload.callbackDetails.scheduled_start_time | コールバック期間が開始される日付と時刻の値。`スケジュールされた`コールバックタイプにのみ適用されます。 形式:`yyyy-MM-dd HH:mm:ss` などのglide_date_time値 データタイプ：文字列 |
| payload.callbackDetails.short_description | コールバック要求の要約。通常はリストまたはダッシュボードで使用されます。 データタイプ：文字列 |
| payload.callbackDetails.state | コールバック要求の現在のワークフローステータス。 有効な値： * `承認待ち` * `進行中` * `完了` * `キャンセル` {#omnichannel-callback-POST-actions__ul_ykz_bwt_k3c} データタイプ：文字列 |
| payload.callbackDetails.type | 要求のカテゴリ。値は常に `コールバック`です。 |
| payload.callbackId | 必須です。コールバックのSys_idまたはexternal_id。 テーブル:コールバック \[sys_cs_callback\] データタイプ：文字列 |
| payload.phoneNumber | 必須です。コールバックを要求しているユーザーの電話番号。 データタイプ：文字列 |
| payload.type | 必須です。コールバックのタイプ。 有効な値: `callback_request` データタイプ：文字列 |
| ルーティングコンテキスト | ルーティング構成に必要です。渡されない場合、またはルーティングルールが一致しない場合、アクションエンドポイントは CCaaS サブフローを呼び出さず、デフォルトの ServiceNow 処理の使用にフォールバックします。 カスタムサブフローまたはルーティングルールを検索するために使用されるコンテキスト情報。省略すると、API はデフォルトのコールバック処理を使用します。 データタイプ: オブジェクト "routingContext": { "sourceTable": "String", "sourceId": "String", "userId": "String" } |
| routingContext.sourceId | コールバックを開始するソースレコードのSys_id。sourceTable の値に対応します。 データタイプ：文字列 |
| routingContext.sourceTable | 要求が開始されたテーブル名。 指定できる値: * `sp_portal` * `sn_csm_ec_engmnt_center_module` * `sn_embeddable_core_module` {#omnichannel-callback-POST-actions__ul_oyd_yh1_zhc} データタイプ：文字列 |
| routingContext.userId | 要求を開始するユーザー (多くの場合、エージェントまたはシステムユーザー)。 テーブル： ユーザー \[sys_user\] データタイプ：文字列 |
[表 : 3. 要求本文のパラメーター]

{#omnichannel-callback-POST-actions__table_myd_yh1_zhc}

### ヘッダー

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

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

{#omnichannel-callback-POST-actions__entry__72}

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

### ステータスコード

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

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
[表 : 6. ステータスコード]

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

{#omnichannel-callback-POST-actions__entry__80}

| 名前 | 説明 |
|-|-|
| 本文 | 要求に関する成功または失敗の情報を含むオブジェクト。 データタイプ: オブジェクト { "status": 200, "body": { "message": "String", "number": "String" } } |
| body.message | アクションの成功または失敗に関する簡単な詳細を含むメッセージ。 データタイプ：文字列 |
| body.number | コールバック参照番号。たとえば、「 `CAL0010012」`です。 テーブル:コールバック \[sys_cs_callback\] データタイプ：文字列 |
| status | 要求に対応するステータスコード。 データタイプ：文字列 |
[ ]

### 例を作成 (ルーティング有効)

このアクションにより、ルーティングコンテキストが構成された新しいコールバックレコードが作成されます。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/actions \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
      "action": "create",
      "routingContext": {
        "sourceTable": "sn_csm_ec_engmnt_center_module",
        "sourceId": "a1b2c3d4e5f6a7b8",
        "userId": "beth.anglin"
      },
      "payload": {
        "callbackId": "cb-98765",
        "callbackDetails": {
          "first_name": "Alice",
          "last_name": "Smith",
          "state": "Pending Approval",
          "reason": "Request updated by user",
          "end_time": "2025-12-17T23:00:00Z",
          "scheduled_start_time": "2025-12-17T22:00:00Z",
          "next_retry": "2025-12-18T10:00:00Z",
          "expiry_time": "2025-12-18T12:00:00Z",
          "phone_number": "+14155552671",
          "short_description": "Callback request for customer support",
          "description": "Customer requested a callback regarding their recent order.",
          "opened_by": "user_sys_id_12345",
          "type": "callback"
        },
        "type": "callback_request",
        "phoneNumber": "+14155552671",
        "callbackContext": {
          "queue": "Customer Support",
          "ivr_path": "support/ivr-path",
          "customer_timezone": "GMT-5"
        }
      },
      "additional_parameters": {}
    }

### 作成 (ルーティングコンテキストなし) {#omnichannel-callback-POST-actions__example_o5n_fpj_23c}

次の例は、ルーティングコンテキストなしで新しいコールバックレコードを作成する方法を示しています。  
注:  
ルーティングコンテキストなしでアクションを作成するには、「 [オムニチャネルコールバック:POST /api/sn_omni_callback/callback/create](https://servicenow-prod.fluidtopics.net/1vKwjQuoaGIo_xNR6bBsqg#omnichannel-callback-POST-create "要求本文に入力された詳細に基づいて、新しい即時コールバック要求またはスケジュールされたコールバック要求を開始します。即時コールバックの場合、この API はコールバックとインタラクションの両方を作成します。スケジュールされたコールバックの場合は、予約 ID を使用してコールバックを作成します。")」に記載されている要求構造に従います。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/actions \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
      "action": "create",
      "payload": {
      "type": "asap",
      "callbackDetails": {
        "appointment": "68cc0a5a9314521060320dd548373cbd",
        "description": "Customer reported issue with order #12345",
        "short_description": "Order issue",
        "reason_type": "product_issue",
        "expire_time": "2025-09-01 17:00",
        "messaging_channel": "web_channel_sys_id",
        "channel_to_callback": "genesys_channel_sys_id",
        "scheduled_start_time": "2025-09-01 1:00",
        "end_time": "2025-09-01 17:00",
        "user_document": "abel.tuter",
        "user_table": "sys_user"
    },
      },
      "callbackContext": {
        "queue": "sample queue",
        "ivr_path": "sample ivr path"
      },
      "inboundId": "ServiceNowVoice",
      "isExternal": true,
      "phoneNumber": "+123454768",
      "externalCallbackId": "new-external-id",
      "interactionDetails": {
        "clientSessionId": "f8453abb-a33d-45b7-bf01-52b7a821e99z",
        "userId": "32423424",
        "callerPhoneNumber": "+14089178877"
      }
    }

### アクションを更新 (ルーティング有効) {#omnichannel-callback-POST-actions__example_wb5_rxs_mhc}

このアクション例では、ルーティングコンテキストを使用して既存のコールバックレコードを更新します。callbackNumber値は、更新するレコードを識別します。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/actions \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
      "action": "update",
      "payload": {
        "callbackDetails": {
          "appointment": "68cc0a5a9314521060320dd548373cbd",
          "description": "Customer reported issue with order #12345",
          "short_description": "Order issue",
          "reason_type": "product_issue",
          "expire_time": "2025-09-01 17:00",
          "messaging_channel": "web_channel_sys_id",
          "channel_to_callback": "genesys_channel_sys_id",
          "scheduled_start_time": "2025-09-01 1:00",
          "end_time": "2025-09-01 17:00",
          "user_document": "abel.tuter",
          "user_table": "sys_user"
        },
        "callbackContext": {
          "queue": "5 value changed via api",
          "ivr_path": "5 some-ivr-path changed via api"
        },
        "inboundId": "AmazonConnect",
        "phoneNumber": "+14089178877",
        "callbackId": "a16ead53fff0621088c6ffffffffffce"
      }
    }

### 更新 (ルーティングコンテキストなし) {#omnichannel-callback-POST-actions__example_jfb_jpj_23c}

次の例 ルーティングコンテキストなしでコールバックレコードを更新する方法を示しています。  
注:  
ルーティングコンテキストのない更新アクションは、 [オムニチャネルコールバック:PATCH /api/sn_omni_callback/callback/update](https://servicenow-prod.fluidtopics.net/1vKwjQuoaGIo_xNR6bBsqg#omnichannel-callback-PATCH-update "要求で指定された詳細に従って、既存のコールバックを更新します。") に記載されている要求構造に従います。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/actions \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
      "action": "update",
      "payload": {
        "callbackDetails": {
          "appointment": "68cc0a5a9314521060320dd548373cbd",
          "description": "Customer reported issue with order #12345",
          "short_description": "Order issue",
          "reason_type": "product_issue",
          "expire_time": "2025-09-01 17:00",
          "messaging_channel": "web_channel_sys_id",
          "channel_to_callback": "genesys_channel_sys_id",
          "scheduled_start_time": "2025-09-01 1:00",
          "end_time": "2025-09-01 17:00",
          "user_document": "abel.tuter",
          "user_table": "sys_user"
        },
        "callbackContext": {
          "queue": "5 value changed via api",
          "ivr_path": "5 some-ivr-path changed via api"
        },
        "inboundId": "AmazonConnect",
        "phoneNumber": "+14089178877",
        "callbackId": "a16ead53fff0621088c6ffffffffffce"
      }
    }

### アクションをキャンセル {#omnichannel-callback-POST-actions__example_ir1_xxs_mhc}

このアクション例では、ルーティングコンテキストを使用して指定されたコールバックレコードをキャンセルし、コールバック \[sys_cs_callback\] テーブルの理由フィールドを更新します。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/actions \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
        "action": "cancel",
        "routingContext": {
            "sourceTable": "sn_csm_ec_engmnt_center_module",
            "sourceId": "a1b2c3d4e5f6a7b8",
            "userId": "beth.anglin"
        },
         "payload": {
            "callbackId": "CAL0001234"
        }
    }

### キャンセル (ルーティングコンテキストなし) {#omnichannel-callback-POST-actions__example_qsq_kpj_23c}

次の例は、ルーティングコンテキストなしでコールバックレコードをキャンセルする方法を示しています。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/actions \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
      "action": "cancel",
      "payload": {
        "callbackId": "cb-98765"
      }
    }

### アクションをクローズ (ルーティング有効) {#omnichannel-callback-POST-actions__example_vvy_yxs_mhc}

この例では、ルーティングコンテキストを持つコールバックレコードを閉じ、コールバック \[sys_cs_callback\] テーブルの理由フィールドを更新します。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/actions \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
        "action": "close",
        "routingContext": {
            "sourceTable": "sn_csm_ec_engmnt_center_module",
            "sourceId": "a1b2c3d4e5f6a7b8",
            "userId": "beth.anglin"
        },
        "payload": {
            "callbackId": "CAL0001234"
        }
    }

### クローズ (ルーティングコンテキストなし) {#omnichannel-callback-POST-actions__example_egf_mpj_23c}

次の例は、ルーティングコンテキストなしでコールバックレコードをクローズする方法を示しています。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/actions \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
      "action": "close",
      "payload": {
        "callbackId": "cb-98765"
      }
    }

## オムニチャネルコールバック:POST /api/sn_omni_callback/callback/attempt {#ariaid-title3}

再試行を含む、既存のコールバックのインタラクションを開始します。

### URL 形式

デフォルト URL: /api/sn_omni_callback/callback/attempt

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

{#omnichannel-callback-POST-attempt__entry__2}{#omnichannel-callback-POST-attempt__version-not_optional-RESTAPI}

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

{#omnichannel-callback-POST-attempt__entry__6}

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

{#omnichannel-callback-POST-attempt__entry__10}

| 名前 | 説明 |
|-|-|
| コールバック ID | 必須です。コールバックのSys_idまたはexternal_id。 テーブル:コールバック \[sys_cs_callback\] データタイプ：文字列 |
| interactionDetails | オプション。インタラクションの詳細。「すぐに」 (即時) コールバックタイプを対象としておりインタラクションの詳細が待機せずにエージェントに直接ルーティングされるようにします。 すべてのインタラクションの詳細は、 [音声インタラクションリソース:POST /cs/voice-interactions](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-POST-voice_inter "インタラクション [interaction] テーブル内に音声インタラクションレコードを作成します。")のペイロードで渡されます。 データタイプ: オブジェクト "interactionDetails": { "callerPhoneNumber": "String", "clientSessionId": "String", "userId": "String" } |
| interactionDetails.callerPhoneNumber | 発信者のコールバック電話番号。これは、コールが切断された場合にエージェントが発信者に連絡するために使用する番号です。 データタイプ：文字列 形式:E.164標準準拠 デフォルト：なし |
| interactionDetails.clientSessionId | この通話を追跡するために使用される外部システム内のレコードの一意の識別子。この情報は、2 つのシステム間のレコードをリンクします。 データタイプ：文字列 形式:通常、外部システムによって生成された UUID または一意のセッショントークン デフォルト：なし |
| interactionDetails.userId | コールバックするユーザーのSys_id。 テーブル： ユーザー \[sys_user\] データタイプ：文字列 |
[表 : 9. 要求本文パラメーター (XML または JSON)]

### ヘッダー

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

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

{#omnichannel-callback-POST-attempt__entry__26}{#omnichannel-callback-POST-attempt__d3014e86}

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

### ステータスコード

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

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

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

{#omnichannel-callback-POST-attempt__table_xp5_5td_fgc__entry__2}{#omnichannel-callback-POST-attempt__omni-response-errors-entry}{#omnichannel-callback-POST-attempt__omni-response-messages-entry}{#omnichannel-callback-POST-attempt__omni-response-result-row}{#omnichannel-callback-POST-attempt__omni-response-result.response-entry}{#omnichannel-callback-POST-attempt__omni-response-result.response.interaction_id-entry}{#omnichannel-callback-POST-attempt__omni-response-result.status-entry}

| 名前 | 説明 |
|-|-|
| エラー | 必要な要求 ID の欠落など、コールバック作成の失敗に関する詳細を含むメッセージ。 データタイプ：文字列のアレイ "errors": ["String", "String"] |
| メッセージ | コールバックの作成の成功に関する詳細を含むメッセージ。 データタイプ：文字列のアレイ "messages": ["String", "String"] |
| 結果 | 要求の結果です。 データタイプ: オブジェクト "result": { "status": "String", "response": {Object}, "errors": [Array], "messages": [Array] } |
| result.response | コールバック要求のコールバック ID とインタラクション ID を含むオブジェクト。 データタイプ: オブジェクト "response": { "callback_created": Boolean "callback_id": "String", "interaction_id": "String" } |
| result.response.interaction_id | 新しく作成されたインタラクションのSys_id。 テーブル:インタラクション \[interaction\] データタイプ：文字列 |
| result.status | 要求の成功または失敗のステータス。 有効な値： * 成功 * 失敗 データタイプ：文字列 |
[ ]

{#omnichannel-callback-POST-attempt__table_xp5_5td_fgc}  

### cURL 要求

次の例は、最初のインタラクションとその後の再試行インタラクションの詳細を含む POST 試行要求を示しています。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/attempt' \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
      "callbackId": "<ID#>",
      "interactionDetails": {
        "clientSessionId": "<ID#>",
        "userId": "<ID#>",
        "callerPhoneNumber": "+112345678901"
      }
    }

有効なcallback_Idが提供され、コールバックの新しいインタラクションが正常に作成されたときの応答本文。

    {
      "result": {
        "status": "success",
        "response": {
          "interaction_id": "<Interaction ID#>"
        }
      }
    }

要求に無効なcallback_Idが指定された場合の応答本文。

    {
      "result": {
        "status": "failure",
        "response": {
          "interactionId": null
        },
        "errors": [
          "Callback not found for callback ID: <ID#>"
        ]
      }
    }

指定されたコールバックのインタラクションが既に存在する場合の応答本文 (メッセージは既存のインタラクションの詳細を返します):

    {
      "result": {
        "status": "success",
        "response": {
          "interaction_id": "<Interaction ID#>"
        },
        "messages": [
          "Active Interaction <Interaction ID#> already exists for callback <ID#>"
        ]
      }
    }

## オムニチャネルコールバック:POST /api/sn_omni_callback/callback/create {#ariaid-title4}

要求本文に入力された詳細に基づいて、新しい即時コールバック要求またはスケジュールされたコールバック要求を開始します。即時コールバックの場合、この API はコールバックとインタラクションの両方を作成します。スケジュールされたコールバックの場合は、予約 ID を使用してコールバックを作成します。

### URL 形式

バージョニングされた URL: /api/sn_omni_callback/v1/callback/create

デフォルト URL: /api/sn_omni_callback/callback/create

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

{#omnichannel-callback-POST-create__entry__2}{#omnichannel-callback-POST-create__version-not_optional-RESTAPI}

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

{#omnichannel-callback-POST-create__entry__6}

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

{#omnichannel-callback-POST-create__entry__10}

| 名前 | 説明 |
|-|-|
| コールバックコンテキスト | コールバック要求に関するコンテキストの詳細を含むオブジェクト。 テーブル:コールバックコンテキスト \[sys_cs_callback_context\] データタイプ: オブジェクト "callbackContext": { "customer_timezone": "String", "ivr_path": "String", "source_channel": "String", "queue": "String", "voicemail_duration": "String", "voicemail_recorded_at": "String", "voicemail_transcript": "String", "voicemail_url": "String" } |
| callbackContext.customer_timezone | コールバックを要求した顧客のタイムゾーン。タイムゾーンは、次の形式で指定できます。 * `国/市区町村`。たとえば、 `アメリカ/Los_Angeles`などです。 * `国/タイムゾーン`。たとえば、「 `米国/太平洋」`などです。 * `タイムゾーンの略称`。例: `PST`。 {#omnichannel-callback-POST-create__ul_qdp_cwx_4gc} 有効なタイムゾーンの完全なリストについては、ユーザー \[sys_user\] テーブルの \[タイム ゾーン フィールドを参照してください。タイムゾーンの詳細については、「 [Time zones](https://www.servicenow.com/docs/access?context=r_TimeZones&version=australia&pubname=australia-platform-administration&ft:locale=en-US)」を参照してください。 データタイプ：文字列 |
| callbackContext.ivr_path | 顧客が人間のエージェントに転送される前にたどる IVR (音声自動応答) パス。 通常、顧客が IVR システムで移動したキューまたはメニューオプションのリストが含まれています。この文字列は、Contact Center as a Service (CCaaS) によって渡されます。例: `「ivr_path」:「テクニカルサポート>アカウント管理」` データタイプ：文字列 |
| callbackContext.queue | キュー内の番号割り当て。 データタイプ：文字列 |
| callbackContext.source_channel | コールバックのソース。たとえば、IVR、Web、VA などです。 データタイプ：文字列 |
| callbackContext.voicemail_duration | ボイスメールの長さ (時間、分、または秒単位)。 フィールド:ボイスメールの期間 データタイプ：数値 |
| callbackContext.voicemail_recorded_at | ボイスメールが記録されたタイムスタンプ。 フィールド:ボイスメール録音時刻 データタイプ：文字列 |
| callbackContext.voicemail_transcript | ボイスメールの文字起こしされたテキスト。 フィールド:ボイスメールのトランスクリプト データタイプ：文字列 |
| callbackContext.voicemail_url | ボイスメールを含むコールバックレコードへの相対リンク。 フィールド:ボイスメール URL データタイプ：文字列 |
| コールバック詳細 | コールバック要求に関する詳細を含むオブジェクト。 テーブル:コールバック \[sys_cs_callback\] データタイプ: オブジェクト "callbackDetails": { "appointment": "String", "channel_to_callback": "String", "description": "String", "end_time": "String", "expire_time": "String", "messaging_channel": "String", "reason_type": "String" "scheduled_start_time": "String", "short_description": "String", "user_document": "String", "user_table": "String" } |
| callbackDetails.appointment | 予約のSys_id。`スケジュールされた`コールバックタイプにのみ適用されます。 テーブル:予約 \[sn_apptmnt_booking_appointment_booking\] データタイプ：文字列 |
| callbackDetails.channel_to_callback | コールバックをルーティングするターゲットメッセージングチャネル。 テーブル:メッセージングチャネル \[sys_cs_channel\]、フィールド:sys_id データタイプ：文字列 |
| callbackDetails.description | コールバックの理由を説明する詳細な説明 (必要な場合)。 データタイプ：文字列 |
| callbackDetails.end_time | コールバックの試行を停止する日時の値。`スケジュールされた`コールバックタイプにのみ適用されます。 形式:`yyyy-MM-dd HH:mm:ss` などのglide_date_time値 データタイプ：文字列 |
| callbackDetails.expire_time | コールバック要求をクローズする日時。 形式:`yyyy-MM-dd HH:mm:ss` などのglide_date_time値 データタイプ：文字列 |
| callbackDetails.messaging_channel | コールバックのソース。Web クライアント、モバイルアプリ、埋め込みメッセンジャーなど、コールバック要求を開始したクライアントインターフェイスを識別します。 テーブル:メッセージングチャネル \[sys_cs_channel\]、フィールド:sys_id データタイプ：文字列 |
| callbackDetails.reason_type | コールバック要求の理由。コールバックに標準化された理由でタグを付けることで、ルーティング、分析、およびレポートに役立ちます。 有効な値： * `その他の問題` * 実装によって定義されたカスタム値。例:`「請求に関する照会」、「``テクニカルサポート」` {#omnichannel-callback-POST-create__ul_tq1_x1z_hgc} テーブル:コールバック \[sys_cs_callback\]、フィールド:reason_type データタイプ：文字列 |
| callbackDetails.scheduled_start_time | コールバックを開始する日付と時刻の値。`スケジュールされた`コールバックタイプにのみ適用されます。 形式:`yyyy-MM-dd HH:mm:ss` などのglide_date_time値 データタイプ：文字列 |
| callbackDetails.short_description | コールバック要求の詳細な説明を提供します。顧客の具体的な懸念事項、コンテキスト、またはエージェントからのメモを含めることができます。 データタイプ：文字列 |
| callbackDetails.user_document | コールバックを要求したユーザーのSys_id。コールバックを要求しているユーザーを識別するために callbackDetails.user_table で使用されます。 テーブル:ユーザー \[sys_user\]、フィールド:sys_id データタイプ：文字列 |
| callbackDetails.user_table | ユーザーレコードが存在するテーブル。コールバックを要求しているユーザーを識別するために callbackDetails.user_document で使用されます。値は常に `sys_user`です。 データタイプ：文字列 |
| externalCallbackId | サードパーティベンダーで作成されたコールバックの外部識別子。 データタイプ：文字列 |
| inboundId | コールバックに関連付けられた着信コールのSys_id。コールバック要求を、サードパーティプロバイダーまたは CCaaS プラットフォームから発信された可能性がある特定の着信コールレコードにリンクするトレーサビリティを提供します。 テーブル:コールバック \[sys_cs_callback\]、フィールド:provider_application_id データタイプ：文字列 |
| interactionDetails | オプション。インタラクションの詳細。「すぐに」 (即時) コールバックタイプを対象としておりインタラクションの詳細が待機せずにエージェントに直接ルーティングされるようにします。 すべてのインタラクションの詳細は、 [音声インタラクションリソース:POST /cs/voice-interactions](https://servicenow-prod.fluidtopics.net/07JiCmVFiDj_30Xm9Qbjkw#vir-POST-voice_inter "インタラクション [interaction] テーブル内に音声インタラクションレコードを作成します。")のペイロードで渡されます。 データタイプ: オブジェクト "interactionDetails": { "callerPhoneNumber": "String", "clientSessionId": "String", "userId": "String" } |
| interactionDetails.callerPhoneNumber | 発信者のコールバック電話番号。これは、コールが切断された場合にエージェントが発信者に連絡するために使用する番号です。 データタイプ：文字列 形式:E.164標準準拠 デフォルト：なし |
| interactionDetails.clientSessionId | この通話を追跡するために使用される外部システム内のレコードの一意の識別子。この情報は、2 つのシステム間のレコードをリンクします。 データタイプ：文字列 形式:通常、外部システムによって生成された UUID または一意のセッショントークン デフォルト：なし |
| interactionDetails.userId | コールバックするユーザーのSys_id。 テーブル： ユーザー \[sys_user\] データタイプ：文字列 |
| isExternal | コールバックが外部であり、別のサードパーティベンダーで要求されたかどうかを示すフラグ。 有効な値： * true:コールバックは外部です。 * false:コールバックは外部ではありません。 {#omnichannel-callback-POST-create__ul_mp5_5gd_fgc} デフォルト値：false |
| type | 必須。コールバックのタイプ。 有効な値： * `asap`:コールバックインタラクションは即座に作成されます。 * `scheduled`:コールバックインタラクションが作成され、顧客が選択した後回にスケジュールされます。 {#omnichannel-callback-POST-create__ul_ojg_yfd_fgc} データタイプ：文字列 |
[表 : 15. 要求本文パラメーター (XML または JSON)]

### ヘッダー

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

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

{#omnichannel-callback-POST-create__entry__74}{#omnichannel-callback-POST-create__d3014e86}

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

### ステータスコード

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

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

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

{#omnichannel-callback-POST-create__entry__86}{#omnichannel-callback-POST-create__omni-response-result-row}{#omnichannel-callback-POST-create__omni-response-result.response-entry}{#omnichannel-callback-POST-create__omni-response-result.response.callback_created-entry}{#omnichannel-callback-POST-create__omni-response-result.response.callback_id-entry}{#omnichannel-callback-POST-create__omni-response-result.response.interaction_id-entry}{#omnichannel-callback-POST-create__omni-response-result.status-entry}

| 名前 | 説明 |
|-|-|
| 結果 | 要求の結果です。 データタイプ: オブジェクト "result": { "status": "String", "response": {Object}, "errors": [Array], "messages": [Array] } |
| result.errors | 必要な要求 ID の欠落など、コールバック作成の失敗に関する詳細を含むメッセージ。 データタイプ：文字列のアレイ "errors": ["String", "String"] |
| result.messages | コールバックの作成の成功に関する詳細を含むメッセージ。 データタイプ：文字列のアレイ "messages": ["String", "String"] |
| result.response | コールバック要求のコールバック ID とインタラクション ID を含むオブジェクト。 データタイプ: オブジェクト "response": { "callback_created": Boolean "callback_id": "String", "interaction_id": "String" } |
| result.response.callback_created | 新しいコールバック要求が作成されたかどうかを示すフラグ 。 可能な値： * true:コールバックが正常に作成されました。 * false:コールバックは作成されませんでした。たとえば、コールバックは指定されたcallback_idに既に存在します。 データタイプ：ブーリアン |
| result.response.callback_id | 新しいコールバックのSys_id (該当する場合)。 テーブル:コールバック \[sys_cs_callback\] データタイプ：文字列 |
| result.response.interaction_id | 新しく作成されたインタラクションのSys_id。 テーブル:インタラクション \[interaction\] データタイプ：文字列 |
| result.status | 要求の成功または失敗のステータス。 有効な値： * 成功 * 失敗 データタイプ：文字列 |
[ ]

### cURL 要求

次の例では、エージェントが要求本文に入力した詳細に従って、簡単なコールバック要求を作成します。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/create' \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
      "type": "asap",
      "callbackDetails": {
        "appointment": "68cc0a5a9314521060320dd548373cbd",
        "description": "Customer reported issue with order #12345",
        "short_description": "Order issue",
        "reason_type": "product_issue",
        "expire_time": "2025-09-01 17:00",
        "messaging_channel": "web_channel_sys_id",
        "channel_to_callback": "genesys_channel_sys_id",
        "scheduled_start_time": "2025-09-01 1:00",
        "end_time": "2025-09-01 17:00",
        "user_document": "abel.tuter",
        "user_table": "sys_user"
    },
      },
      "callbackContext": {
        "queue": "sample queue",
        "ivr_path": "sample ivr path"
      },
      "inboundId": "ServiceNowVoice",
      "isExternal": true,
      "phoneNumber": "+123454768",
      "externalCallbackId": "new-external-id",
      "interactionDetails": {
        "clientSessionId": "f8453abb-a33d-45b7-bf01-52b7a821e99z",
        "userId": "32423424",
        "callerPhoneNumber": "+14089178877"
      }
    }

応答本文は、新しく作成されたコールバック要求のコールバックとインタラクション ID を含む成功応答を返します。

    {
      "status": "success",
      "response": {
        "callback_id": "a16ead53fff0621088c6ffffffffffce",
        "interaction_id": "696e6d57fff0621088c6ffffffffff7d"
      }
    }

インタラクションの詳細が指定されていない場合の応答本文:

    {
      "status": "success",
      "response": {
        "callback_created": true,
        "callback_id": "7df2059ffffc221088c6ffffffffff0c"
      }
    }

コールバック ID が既に存在するが、新しいインタラクションの詳細が提供されている場合の応答本文:

    {
      "result": {
        "status": "success",
        "response": {
          "interaction_id": "84054fff53786210011eddeeff7b12d6",
          "callback_id": "8b43c3fb53786210011eddeeff7b12a6",
          "callback_created": false
        },
        "messages": [
          "Successfully updated the callback 8b43c3fb53786210011eddeeff7b12a6",
          "Successfully created the interaction 84054fff53786210011eddeeff7b12d6"
        ]
      }
    }

コールバック ID が既に存在するが、新しいインタラクションの詳細が指定されていない場合の応答本文:

    {
      "result": {
        "status": "success",
        "response": {
          "callback_id": "8b43c3fb53786210011eddeeff7b12a6"
        },
        "messages": [
          "Successfully updated the callback 8b43c3fb53786210011eddeeff7b12a6"
        ]
      }
    }

要求に必須フィールドがない場合の応答本文:

    {
      "result": {
        "status": "failure",
        "response": {
          "callbackId": null
        },
        "errors": [
          "Parameter 'type' is required in request"
        ]
      }
    }

## オムニチャネルコールバック:POST api/sn_omni_callback/callback/get {#ariaid-title5}

クエリパラメーターに基づいてコールバック情報をフェッチします。

### URL 形式

バージョニングされた URL: /api/sn_omni_callback/v1/callback/get

デフォルト URL: /api/sn_omni_callback/callback/get

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

{#omnichannel-callback-POST-get__entry__2}{#omnichannel-callback-POST-get__version-not_optional-RESTAPI}

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

{#omnichannel-callback-POST-get__entry__6}

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

{#omnichannel-callback-POST-get__entry__10}

| 名前 | 説明 |
|-|-|
| queryParameters | 結果をフィルタリングするクエリパラメーターのキーと値のペアを含むオブジェクト。 データタイプ: オブジェクト "queryParameters": { "number": "String", "state": "String", "opened_by": "String", "sys_id", "String", "callback_type": "String", "external_callback_id": "String", "callback_number": "String" } |
| queryParameters.番号 | 検索するコールバック参照番号。たとえば、「 `CAL0010012」`です。 テーブル:コールバック \[sys_cs_callback\] データタイプ：文字列 |
| queryParameters.state | コールバックの現在のステータスを表す数値。 可能な値： * `1`:オープン * `2`:対応中 * `3`:完了してクローズ * `4`:破棄してクローズ * `7`: キャンセル データタイプ：数値 |
| queryParameters.opened_by | コールバックを要求するユーザーのユーザー ID。 テーブル： ユーザー \[sys_user\] データタイプ：文字列 |
| queryParameters.sys_id | コールバックレコードのSys_id。 テーブル:コールバック \[sys_cs_callback\] データタイプ：文字列 |
| queryParameters.callback_type | コールバックのタイプ。 有効な値： * `asap`:コールバックインタラクションは即座に作成されます。 * `scheduled`:コールバックインタラクションが作成され、顧客が選択した後回にスケジュールされます。 {#omnichannel-callback-POST-get__ul_ojg_yfd_fgc} データタイプ：文字列 |
| queryParameters.external_callback_id | サードパーティシステムで作成されたコールバックの外部識別子。 データタイプ：文字列 |
| queryParameters.callback_number | 折り返しコールする発信者の電話番号。 データタイプ：文字列 |
| 応答パラメーター | オプション。応答で返すフィールドを指定します。省略した場合、エンドポイントはデフォルトのフィールドを返します。 データタイプ: オブジェクト "responseParameters": { "callback": [Array], "context": [Array] } |
| responseParameters.callback | オプション。コールバックレコードのフィールド ( `数値`、 `phone_number` など) を返します。 テーブル:コールバック \[sys_cs_callback\] データタイプ: オブジェクト "callback": [String, String] 有効な値： * `number`:そのコールバックの一意の参照番号 ( `「CAL0010012」`など)。 * `phone_number`:発信者の電話番号。 {#omnichannel-callback-POST-get__ul_qsb_pts_mhc} |
| responseParameters.context | オプション。キュー、割り当て、関連するメタデータなどのコールバックのコンテキスト情報を「キー:値」ペアの形式で返します。 テーブル:コールバックコンテキスト \[sys_cs_callback_context\] データタイプ：文字列のアレイ "callbackContext": { "customer_timezone": "String", "ivr_path": "String", "source_channel": "String", "queue": "String", "voicemail_duration": "String", "voicemail_recorded_at": "String", "voicemail_transcript": "String", "voicemail_url": "String" } |
| responseParameters.context.customer_timezone | コールバックを要求している the ユーザーのタイムゾーン。 文字列 |
| responseParameters.context.ivr_path | 顧客が人間のエージェントに転送される前にたどる IVR (音声自動応答) パス。 通常、顧客が IVR システムで移動したキューまたはメニューオプションのリストが含まれています。この文字列は、 連絡先 サービスとしてのセンター (CCaaS) によって渡されます。例: `「ivr_path」:「テクニカルサポート>アカウント管理」` データタイプ：文字列 |
| responseParameters.context.source_channel | コールバックのソース。たとえば、IVR、Web、VA などです。 文字列 |
| responseParameters.context.queue | コールバックがアサインされているキューの名前または ID。 文字列 |
| responseParameters.context.voicemail_duration | ボイスメールの長さ (時間、分、または秒単位)。 テーブル:コールバックコンテキスト \[sys_cs_callback_context\]、フィールド:ボイスメール期間 文字列 |
| responseParameters.context.voicemail_recorded_at | ボイスメールが記録されたタイムスタンプ。 テーブル:コールバックコンテキスト \[sys_cs_callback_context\]、 フィールド:ボイスメールの記録時刻 データタイプ：文字列 |
| responseParameters.context.voicemail_transcript | ボイスメールの文字起こしされたテキスト。 テーブル:コールバックコンテキスト \[sys_cs_callback_context\]、フィールド:ボイスメールトランスクリプト データタイプ：文字列 |
| responseParameters.context.voicemail_url | ボイスメールを含むコールバックレコードへの相対リンク。 テーブル:コールバックコンテキスト \[sys_cs_callback_context\]、フィールド:ボイスメール URL データタイプ：文字列 |
[表 : 21. 要求本文パラメーター (XML または JSON)]

### ヘッダー

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

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 22. 要求ヘッダー]

{#omnichannel-callback-POST-get__table_edh_vht_mhc} {#omnichannel-callback-POST-get__entry__54}

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

### ステータスコード

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

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
[表 : 24. ステータスコード]

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

{#omnichannel-callback-POST-get__entry__62}

| 名前 | 説明 |
|-|-|
| result | 指定された検索条件に一致したコールバックレコードまたはコールバック情報を含むオブジェクト。 日付タイプ:オブジェクト "result": { "response": {Object}, "status": "String" } |
| result.response | コールバック情報。 データタイプ: オブジェクト "response": { "callbacks": [Array], "count": "Number" } |
| result.response.callbacks | 「キー:値」ペアの形式でコールバックレコードに関する詳細を含むオブジェクト。 注: 要求で responseParameters が指定されていない場合は、すべてのデフォルトフィールドを表示します。 データタイプ：文字列のアレイ "callbacks": [ { "number": "String", "state": "String", "first_name": "Virtual", "last_name": "Agent", "user_table": "sys_user", "opened_by": "Virtual Agent", "assigned_to": "" } ] |
| result.response.callbacks.assigned_to | 要求にアサインされたエージェントの ID。 データタイプ：文字列 |
| result.response.callbacks.context | コールバックレコードのコンテキスト情報。要求入力によって異なります。 テーブル:コールバックコンテキスト \[sys_cs_callback_context\] データタイプ：文字列のアレイ "callbackContext": { "customer_timezone": "String", "ivr_path": "String", "source_channel": "String", "queue": "String", "voicemail_duration": "String", "voicemail_recorded_at": "String", "voicemail_transcript": "String", "voicemail_url": "String" } |
| result.response.callbacks.context.customer_timezone | コールバックを要求しているユーザーのタイムゾーン。 文字列 |
| result.response.callbacks.context.ivr_path | 顧客が人間のエージェントに転送される前にたどる IVR (音声自動応答) パス。 通常、顧客が IVR システムで移動したキューまたはメニューオプションのリストが含まれています。この文字列は、Contact Center as a Service (CCaaS) によって渡されます。例: `「ivr_path」:「テクニカルサポート>アカウント管理」` データタイプ：文字列 |
| result.response.callbacks.context.source_channel | コールバックのソース。たとえば、IVR、Web、VA などです。 文字列 |
| result.response.callbacks.context.queue | コールバックがアサインされているキューの名前または ID。 文字列 |
| result.response.callbacks.context.voicemail_duration | ボイスメールの長さ (時間、分、または秒単位)。 文字列 |
| result.response.callbacks.context.voicemail_recorded_at | ボイスメールが記録されたタイムスタンプ。 データタイプ：文字列 |
| result.response.callbacks.context.voicemail_transcript | ボイスメールの文字起こしされたテキスト。 データタイプ：文字列 |
| result.response.callbacks.context.voicemail_url | ボイスメールを含むコールバックレコードへの相対リンク。 データタイプ：文字列 |
| result.response.callbacks.created_on | コールバックが作成されたタイムスタンプ 日時 。 データタイプ：文字列 |
| result.response.callbacks.first_name | コールバックを開始した、またはコールバックに関連付けられているユーザーの名。 データタイプ：文字列 |
| result.response.callbacks.last_name | 関連付けられたユーザーの姓。ログ記録、ルーティング、および表示のためのユーザーのフルネームを入力します。 データタイプ：文字列 |
| result.response.callbacks.number | 一意のコールバック参照番号。たとえば、「 `CAL0010012」`です。 データタイプ：文字列 |
| result.response.callbacks.opened_by | コールバックを要求するユーザーのユーザー ID。 テーブル： ユーザー \[sys_user\] データタイプ：文字列 |
| result.response.callbacks.phone_number | 発信者の電話番号。 データタイプ：文字列 |
| result.response.callbacks.status | コールバックの現在のステータス。 可能な値： * `1`:オープン * `2`:対応中 * `3`:完了してクローズ * `4`:破棄してクローズ * `7`:キャンセル {#omnichannel-callback-POST-get__ul_nyc_fpb_xhc} データタイプ：文字列 |
| result.response.callbacks.user_table | コールバックユーザーの詳細を検索するときに参照するテーブル。たとえば、sys_user などです。 データタイプ：文字列 |
| result.response.count | 検索条件に従って一致するレコードの数。 データタイプ：数値 |
| result.status | 要求の成功またはエラーのステータス。 可能な値： * error:データベース接続の失敗、サーバーの例外、キャッチされないランタイムエラーなど、内部エラーまたは予期しないエラー。 * failed:操作を完了できませんでした。例:レコードが見つからない、検証に失敗した、またはサポートされていないパラメーター。 * not_found:クエリされたエンティティが存在しません。 * unauthorized:問い合わせユーザーに権限、認証情報、またはアクセス権がありません。 * invalid_request:パラメーターの形式が正しくない、型が間違っているか、必須フィールドがない場合。 * タイムアウト:上流システムまたはデータベースが時間どおりに戻らなかった。 * partial_success:一部のレコードは正常に処理され、一部は失敗しました。 {#omnichannel-callback-POST-get__ul_xlh_zjb_xhc} データタイプ：文字列 |
[ ]

### cURL 要求

次の POST 例では、仮想エージェント (`"opened_by": "virtual.agent"`) によって明確にオープンされ、クローズ済みステータス (`4`) になっているコールバックレコードを照会し、キューコンテキスト ("context": "context": ) 内のコールバックレコードの参照番号と電話番号 ("`callback": ["number", "callback_number"]`) のみを返すように API に指示します`。 ["queue"]`) です。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/get' \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -u 'username':'password' \ 
      -d {
      "queryParameters": {
        "opened_by": "virtual.agent",
        "state": 4,
      },
      "responseParameters": {
        "callback": ["number", "callback_number"],
        "context": ["queue"]
      }
    }

応答本文。

    {
      "result": {
        "status": "success",
        "response": {
          "callbacks": [
            {
              "number": "CAL0010036",
              "callback_number": "+14089178878",
              "context": {
                "queue": "21 value changed via api"
              }
            },
            {
              "number": "CAL0010037",
              "callback_number": "+14089178878",
              "context": {
                "queue": "21 value changed via api"
              }
            },
            {
              "number": "CAL0010001",
              "callback_number": "+918008509174",
              "context": {
                "queue": "queue"
              }
            },
            {
              "number": "CAL0010033",
              "callback_number": "+14089178878",
              "context": {
                "queue": "21 value changed via api"
              }
            },
            {
              "number": "CAL0010003",
              "callback_number": "+918008509174",
              "context": {
                "queue": "Soumya queue"
              }
            },
            {
              "number": "CAL0010035",
              "callback_number": "+14089178878",
              "context": {
                "queue": "21 value changed via api"
              }
            },
            {
              "number": "CAL0010038",
              "callback_number": "+14089178878",
              "context": {
                "queue": "21 value changed via api"
              }
            },
            {
              "number": "CAL0010034",
              "callback_number": "+14089178878",
              "context": {
                "queue": "21 value changed via api"
              }
            }
          ],
          "count": 8
        }
      }
    }

次の例では、一致する外部 ID `new-external-2325` に基づいてコールバック情報を取得します。呼び出しは要求に responseParameters を提供しないため、応答は完全なデフォルトレコードを返します。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/get' \
      -H "Content-Type: application/json" \
      -H "Accept: application/json" \
      -u 'username':'password' \ 
      -d {
      "queryParameters": {
        "external_callback_id": "new-external-2325"
      }
    }

応答本文：

    {
      "result": {
        "status": "success",
        "response": {
          "callbacks": [
            {
              "number": "CAL0010038",
              "state": "Closed Abandoned",
              "first_name": "Virtual",
              "last_name": "Agent",
              "user_table": "sys_user",
              "opened_by": "Virtual Agent",
              "assigned_to": ""
            }
          ]
        }
      }
    }

## オムニチャネルコールバック:PATCH /api/sn_omni_callback/callback/update {#ariaid-title6}

要求で指定された詳細に従って、既存のコールバックを更新します。
要求本文には、更新する要求パラメーターのみを指定します。

### URL 形式

デフォルト URL: /api/sn_omni_callback/callback/update

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

{#omnichannel-callback-PATCH-update__entry__2}{#omnichannel-callback-PATCH-update__version-not_optional-RESTAPI}

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

{#omnichannel-callback-PATCH-update__entry__6}

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

{#omnichannel-callback-PATCH-update__entry__10}

| 名前 | 説明 |
|-|-|
| コールバックコンテキスト | コールバック要求に関するコンテキストの詳細を含むオブジェクト。 テーブル:コールバックコンテキスト \[sys_cs_callback_context\] データタイプ: オブジェクト "callbackContext": { "customer_timezone": "String", "ivr_path": "String", "source_channel": "String", "queue": "String", "voicemail_duration": "String", "voicemail_recorded_at": "String", "voicemail_transcript": "String", "voicemail_url": "String" } |
| callbackContext.customer_timezone | コールバックを要求した顧客のタイムゾーン。タイムゾーンは、次の形式で指定できます。 * `国/市区町村`。たとえば、 `アメリカ/Los_Angeles`などです。 * `国/タイムゾーン`。たとえば、「 `米国/太平洋」`などです。 * `タイムゾーンの略称`。例: `PST`。 {#omnichannel-callback-PATCH-update__ul_qdp_cwx_4gc} 有効なタイムゾーンの完全なリストについては、ユーザー \[sys_user\] テーブルの \[タイム ゾーン フィールドを参照してください。タイムゾーンの詳細については、「 [Time zones](https://www.servicenow.com/docs/access?context=r_TimeZones&version=australia&pubname=australia-platform-administration&ft:locale=en-US)」を参照してください。 データタイプ：文字列 |
| callbackContext.ivr_path | 顧客が人間のエージェントに転送される前にたどる IVR (音声自動応答) パス。 通常、顧客が IVR システムで移動したキューまたはメニューオプションのリストが含まれています。この文字列は、Contact Center as a Service (CCaaS) によって渡されます。例: `「ivr_path」:「テクニカルサポート>アカウント管理」` データタイプ：文字列 |
| callbackContext.queue | キュー内の番号割り当て。 データタイプ：文字列 |
| callbackContext.source_channel | コールバックのソース。たとえば、IVR、Web、VA などです。 データタイプ：文字列 |
| callbackContext.voicemail_duration | ボイスメールの長さ (時間、分、または秒単位)。 フィールド:ボイスメールの期間 データタイプ：数値 |
| callbackContext.voicemail_recorded_at | ボイスメールが記録されたタイムスタンプ。 フィールド:ボイスメール録音時刻 データタイプ：文字列 |
| callbackContext.voicemail_transcript | ボイスメールの文字起こしされたテキスト。 フィールド:ボイスメールのトランスクリプト データタイプ：文字列 |
| callbackContext.voicemail_url | ボイスメールを含むコールバックレコードへの相対リンク。 フィールド:ボイスメール URL データタイプ：文字列 |
| コールバック詳細 | コールバック要求に関する詳細を含むオブジェクト。 テーブル:コールバック \[sys_cs_callback\] データタイプ: オブジェクト "callbackDetails": { "appointment": "String", "channel_to_callback": "String", "description": "String", "end_time": "String", "expire_time": "String", "messaging_channel": "String", "reason_type": "String" "scheduled_start_time": "String", "short_description": "String", "user_document": "String", "user_table": "String" } |
| callbackDetails.appointment | 予約のSys_id。`スケジュールされた`コールバックタイプにのみ適用されます。 テーブル:予約 \[sn_apptmnt_booking_appointment_booking\] データタイプ：文字列 |
| callbackDetails.channel_to_callback | コールバックをルーティングするターゲットメッセージングチャネル。 テーブル:メッセージングチャネル \[sys_cs_channel\]、フィールド:sys_id データタイプ：文字列 |
| callbackDetails.description | コールバックの理由を説明する詳細な説明 (必要な場合)。 データタイプ：文字列 |
| callbackDetails.end_time | コールバックの試行を停止する日時の値。`スケジュールされた`コールバックタイプにのみ適用されます。 形式:`yyyy-MM-dd HH:mm:ss` などのglide_date_time値 データタイプ：文字列 |
| callbackDetails.expire_time | コールバック要求をクローズする日時。 形式:`yyyy-MM-dd HH:mm:ss` などのglide_date_time値 データタイプ：文字列 |
| callbackDetails.messaging_channel | コールバックのソース。Web クライアント、モバイルアプリ、埋め込みメッセンジャーなど、コールバック要求を開始したクライアントインターフェイスを識別します。 テーブル:メッセージングチャネル \[sys_cs_channel\]、フィールド:sys_id データタイプ：文字列 |
| callbackDetails.reason_type | コールバック要求の理由。コールバックに標準化された理由でタグを付けることで、ルーティング、分析、およびレポートに役立ちます。 有効な値： * `その他の問題` * 実装によって定義されたカスタム値。例:`「請求に関する照会」、「``テクニカルサポート」` {#omnichannel-callback-PATCH-update__ul_tq1_x1z_hgc} テーブル:コールバック \[sys_cs_callback\]、フィールド:reason_type データタイプ：文字列 |
| callbackDetails.scheduled_start_time | コールバックを開始する日付と時刻の値。`スケジュールされた`コールバックタイプにのみ適用されます。 形式:`yyyy-MM-dd HH:mm:ss` などのglide_date_time値 データタイプ：文字列 |
| callbackDetails.short_description | コールバック要求の詳細な説明を提供します。顧客の具体的な懸念事項、コンテキスト、またはエージェントからのメモを含めることができます。 データタイプ：文字列 |
| callbackDetails.user_document | コールバックを要求したユーザーのSys_id。コールバックを要求しているユーザーを識別するために callbackDetails.user_table で使用されます。 テーブル:ユーザー \[sys_user\]、フィールド:sys_id データタイプ：文字列 |
| callbackDetails.user_table | ユーザーレコードが存在するテーブル。コールバックを要求しているユーザーを識別するために callbackDetails.user_document で使用されます。値は常に `sys_user`です。 データタイプ：文字列 |
| コールバック ID | 必須です。コールバックのSys_idまたはexternal_id。 テーブル:コールバック \[sys_cs_callback\] データタイプ：文字列 |
| inboundId | コールバックに関連付けられた着信コールのSys_id。コールバック要求を、サードパーティプロバイダーまたは CCaaS プラットフォームから発信された可能性がある特定の着信コールレコードにリンクするトレーサビリティを提供します。 テーブル:コールバック \[sys_cs_callback\]、フィールド:provider_application_id データタイプ：文字列 |
| phoneNumber | 発信者の電話番号。 データタイプ: 数字の文字列 形式:E.164標準準拠 |
[表 : 27. 要求本文パラメーター (XML または JSON)]

### ヘッダー

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

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

{#omnichannel-callback-PATCH-update__entry__64}{#omnichannel-callback-PATCH-update__d3014e86}

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

### ステータスコード

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

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

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

{#omnichannel-callback-PATCH-update__table_xp5_5td_fgc__entry__2}{#omnichannel-callback-PATCH-update__omni-response-errors-entry}{#omnichannel-callback-PATCH-update__omni-response-messages-entry}{#omnichannel-callback-PATCH-update__omni-response-result-row}{#omnichannel-callback-PATCH-update__omni-response-result.response-entry}{#omnichannel-callback-PATCH-update__omni-response-result.response.callback_created-entry}{#omnichannel-callback-PATCH-update__omni-response-result.response.callback_id-entry}{#omnichannel-callback-PATCH-update__omni-response-result.response.interaction_id-entry}{#omnichannel-callback-PATCH-update__omni-response-result.status-entry}

| 名前 | 説明 |
|-|-|
| エラー | 必要な要求 ID の欠落など、コールバック作成の失敗に関する詳細を含むメッセージ。 データタイプ：文字列のアレイ "errors": ["String", "String"] |
| メッセージ | コールバックの作成の成功に関する詳細を含むメッセージ。 データタイプ：文字列のアレイ "messages": ["String", "String"] |
| 結果 | 要求の結果です。 データタイプ: オブジェクト "result": { "status": "String", "response": {Object}, "errors": [Array], "messages": [Array] } |
| result.response | コールバック要求のコールバック ID とインタラクション ID を含むオブジェクト。 データタイプ: オブジェクト "response": { "callback_created": Boolean "callback_id": "String", "interaction_id": "String" } |
| result.response.callback_created | 新しいコールバック要求が作成されたかどうかを示すフラグ 。 可能な値： * true:コールバックが正常に作成されました。 * false:コールバックは作成されませんでした。たとえば、コールバックは指定されたcallback_idに既に存在します。 データタイプ：ブーリアン |
| result.response.callback_id | 新しいコールバックのSys_id (該当する場合)。 テーブル:コールバック \[sys_cs_callback\] データタイプ：文字列 |
| result.response.interaction_id | 新しく作成されたインタラクションのSys_id。 テーブル:インタラクション \[interaction\] データタイプ：文字列 |
| result.status | 要求の成功または失敗のステータス。 有効な値： * 成功 * 失敗 データタイプ：文字列 |
[ ]

{#omnichannel-callback-PATCH-update__table_xp5_5td_fgc}  

### cURL 要求

次の例では、関連するコールバック要求のコールバックの詳細を更新します。

    curl -X POST 'https://instance.servicenow.com/api/sn_omni_callback/callback/update' \ 
      -H 'Accept: application/json' \ 
      -H 'Content-Type: application/json' \ 
      -u 'username':'password' \ 
      -d ' {
      "callbackDetails": {
        "appointment": "68cc0a5a9314521060320dd548373cbd",
        "description": "Customer reported issue with order #12345",
        "short_description": "Order issue",
        "reason_type": "product_issue",
        "expire_time": "2025-09-01 17:00",
        "messaging_channel": "web_channel_sys_id",
        "channel_to_callback": "genesys_channel_sys_id",
        "scheduled_start_time": "2025-09-01 1:00",
        "end_time": "2025-09-01 17:00",
        "user_document": "abel.tuter",
        "user_table": "sys_user"
    },
      "callbackContext": {
        "queue": "5 value changed via api",
        "ivr_path": "5 some-ivr-path changed via api"
      },
      "inboundId": "AmazonConnect",
      "phoneNumber": "+14089178877",
      "callbackId": "a16ead53fff0621088c6ffffffffffce"
    }

有効な既存のコールバック ID が正常に更新されたときの応答。

    {
      "result": {
        "status": "success",
        "response": {
          "callback_id": "952f763b53786210011eddeeff7b1297"
        },
        "messages": [
          "Successfully updated the callback 952f763b53786210011eddeeff7b1297"
        ]
      }
    }

要求で無効なコールバック ID が指定された場合の応答:


      "result": {
        "status": "failure",
        "response": {
          "callbackId": null
        },
        "errors": [
          "Callback not found for callback ID: 952f763b53786210011eddeef7b1297"
        ]
      }
    }

要求にコールバック ID がない場合の応答:


      "result": {
        "status": "failure",
        "response": {
          "callbackId": null
        },
        "errors": [
          "Parameter 'callbackId' is required in request"
        ]
      }
    }

## オムニチャネルコールバック:PATCH /api/sn_omni_callback/callback/close/{callback_number} {#ariaid-title7}

指定されたコールバック要求をキャンセルします

### URL 形式

バージョニングされた URL: /api/{api_version}/sn_omni_callback/callback/close/{callback_number}

デフォルト URL: /api/sn_omni_callback/callback/close/{callback_number}

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

{#omnichannel-callback-PATCH-cancel__entry__2}{#omnichannel-callback-PATCH-cancel__version-not_optional-RESTAPI}

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

{#omnichannel-callback-PATCH-cancel__entry__8}

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

{#omnichannel-callback-PATCH-cancel__entry__12}

| 名前 | 説明 |
|-|-|
| 理由 | オプション。指定されたコールバック キャンセルするように指定します。値は常に `[キャンセル済み`\] です。reasonが渡されない場合、要求はキャンセルされずにクローズされます。 データタイプ：文字列 |
[表 : 33. 要求本文パラメーター (XML または JSON)]

### ヘッダー

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

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

{#omnichannel-callback-PATCH-cancel__entry__20}

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

### ステータスコード

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

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
[表 : 36. ステータスコード]

### 応答本文のパラメーター

{#omnichannel-callback-PATCH-cancel__entry__28}

| 名前 | 説明 |
|-|-|
| 理由 | コールバック要求を更新する理由。値は常に `[キャンセル済み]` または `[クローズ済み`\] です。 テーブル:コールバック \[sys_cs_callback\]、フィールド:理由 データタイプ：文字列 { "reason": "Cancelled" } |
[ ]

### cURL 要求

次の要求は、コールバック ID CAL0001234のコールバック要求をキャンセルします。{#omnichannel-callback-PATCH-cancel__p_b1z_d4r_q3c}

    curl -X POST "https://instance.servicenow.com/api/sn_omni_callback/callback/close/CAL0001234" \
      -H "Accept: application/json" \
      -H "Content-Type: application/json" \
      -u "username:password" \
      -d '{
        "reason": "Cancelled"
      }'

応答本文でキャンセルが確認されます。

    {
    "reason":"Cancelled"
    }