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


---

# エージェントマッピング API

# エージェントマッピング API {#ariaid-title1}

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

エージェントマッピング API は、Contact Center as a Service (CCaaS) システムの外部エージェント ID をServiceNow AI Platform内の内部エージェント ID にマッピングするためのエンドポイントを提供します。
この API には、外部エージェント管理ユーティリティパック (sn_external_agent) プラグインが必要です。この API を呼び出すには、interaction_agent ロールが必要です。

CCaaS システムとの統合の詳細については、「 [Integrating with contact centers](https://www.servicenow.com/docs/access?context=contactcenter-integration&version=australia&pubname=australia-customer-service-management&ft:locale=en-US)」を参照してください。

## エージェントマッピング:PUT /sn_ct_ctr_it_core/agent_mapping/agent/{agentId}/inboundId/{inboundId} {#ariaid-title2}

サービスとしてのコンタクトセンター (CCaaS) システムの外部エージェント ID を ServiceNow AI Platformの内部エージェント ID にマッピングします。
エージェントが CCaaS システムにログインまたはログアウトしてアクティブステータスを更新するときに、このエンドポイントを呼び出します。このエンドポイントは、次のデータを使用して外部エージェントマッピング \[external_agent_mapping\] テーブルのレコードを作成または更新します。

* 外部 CCaaS エージェント ID
* 受信 ID に関連付けられたプロバイダーチャネル ID
* CCaaS システムでのエージェントのアクティブステータス
* エージェントのユーザー \[sys_user\] レコードへの参照
{#agent-mapping-PUT-agent-inid__ul_ljy_ytt_32c}

### URL 形式

デフォルト URL: /api/sn_ct_ctr_it_core/agent_mapping/agent/{agentId}/inboundId/{inboundId}

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

{#agent-mapping-PUT-agent-inid__entry__2}

| 名前 | 説明 |
|-|-|
| agentId | 内部エージェントのSys_id。 データタイプ：文字列 テーブル： ユーザー \[sys_user\] |
| inboundId | CCaaS システムのプロバイダーチャネル ID レコードからの受信 ID。 データタイプ：文字列 テーブル:プロバイダーチャネル ID \[sys_cs_provider_application\] フィールド:受信 ID |
[表 : 1. パスパラメーター]

{#agent-mapping-PUT-agent-inid__entry__8}

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

{#agent-mapping-PUT-agent-inid__entry__12}

| 名前 | 説明 |
|-|-|
| アクティブ | エージェントが現在 CCaaS システムにログインしているかどうかを示すフラグ。 有効な値： * true:エージェントはログインしています。 * false:エージェントはログアウトしています。 {#agent-mapping-PUT-agent-inid__ul_qhf_vst_32c} デフォルト：true データタイプ：ブーリアン |
| external_agent_id | 必須です。CCaaS システムからの外部エージェント ID。 データタイプ：文字列 |
[表 : 3. 要求本文パラメーター (JSON)]

### ヘッダー

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

| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 |
| Content-Type | 要求本文のデータ形式。application/json のみをサポートします。 |
[表 : 4. 要求ヘッダー]

{#agent-mapping-PUT-agent-inid__entry__24}

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

### ステータスコード

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

| ステータスコード | 説明 |
|-|-|
| 200 | OK。 既存のエージェントマッピングレコードが更新されました。 |
| 201 | 作成されました。 新しいエージェントマッピングレコードが作成されました。 |
| 400 | 要求が正しくありません。 要求で指定されたエージェント ID または受信 ID が無効です。 |
[表 : 6. ステータスコード]

### 応答本文のパラメーター (JSON)

{#agent-mapping-PUT-agent-inid__entry__36}

| 名前 | 説明 |
|-|-|
| result | 要求に関する情報を含む結果オブジェクト。 データタイプ: オブジェクト |
| result.mappingIds | 外部エージェントマッピング \[external_agent_mapping\] テーブルで作成または更新されたレコードのSys_ids。 データタイプ：文字列のアレイ |
| result.message | 要求の結果を説明するメッセージ。 データタイプ：文字列 |
| result.status | 要求のステータス。 可能な値： * 成功 * 失敗 {#agent-mapping-PUT-agent-inid__ul_kqs_m5m_32c} データタイプ：文字列 |
[ ]

### cURL 要求

この例ではsys_id `da419c1fc312310015519f2974d3ae15` を持つ内部エージェントを、外部 CCaaS システムの対応する ID `12345` にマッピングします。

    curl "https://instance.service-now.com/api/sn_ct_ctr_it_core/agent_mapping/agent/da419c1fc312310015519f2974d3ae15/inboundId/ServiceNowVoice" \ 
    --request PUT \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \ 
    --data "{\"external_agent_id\":\"12345\"}" \ 
    --user 'username':'password'

応答本文：

    {
      "result": { 
        "message": "Agent Id mapping record inserted", 
        "status": "success", 
        "mappingIds": [ 
          "128b74fcc3931a50325a4ad9d00131c3" 
        ] 
      } 
    }

### cURL 要求 {#agent-mapping-PUT-agent-inid__example_izk_k5t_32c}

この例では、 active パラメーターを `false` に設定して、エージェントが CCaaS システムからログアウトしていることを示します。

    curl "https://instance.service-now.com/api/sn_ct_ctr_it_core/agent_mapping/agent/da419c1fc312310015519f2974d3ae15/inboundId/ServiceNowVoice" \ 
    --request PUT \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \ 
    --data "{"external_agent_id":"12345", "active":"false"}" \ 
    --user 'username':'password'

応答本文：

    { 
      "result": { 
        "message": "Agent Id mapping record updated", 
        "status": "success", 
        "mappingIds": [ 
          "cea77cebebef9e10a341fc7acad0cdc2" 
        ] 
      } 
    }