最終作業 API

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：97分

    • 外部のサービスとしてのコンタクトセンター (CCaaS) システムまたは ServiceNow AI Platform ワークスペースの最終作業機能を管理するためのエンドポイントを提供します。

    この API には、インタラクション管理 (com.glide.interaction.awa) プラグインが必要です。この API を呼び出すには、interaction_integration_user ロールが必要です。

    エージェントがインタラクションをクローズするときに、ラップアップ機能を使用して、後で参照できるようにクローズの詳細とラップアップコードを入力できます。ラップアップ機能の詳細については、「 Wrap up overview」を参照してください。

    外部システムからのインタラクションのセグメント化された最終作業にこの API を使用するには、 InteractionSegment スクリプト拡張ポイントを実装して、選択したテーブルでセグメントレコードを作成および取得する必要があります。OpenFrame を使用している場合、拡張ポイントには、電話ログ [sn_openframe_phone_log] テーブルのセグメントレコードを作成および取得するための既存の実装があります。

    AI 最終作業の推奨事項

    AI の最終作業に関する推奨事項は、次の 2 つのソースから取得できます。

    • 内部 (Now Assist): use_third_party_ai が false の場合、セグメントの作成後にビジネスルールが自動的にトリガーされ、CSM API を呼び出して ai_wrap_up_code と ai_notesを入力します。
    • 外部 (サードパーティ/CCaaS): use_third_party_ai が true の場合、外部システムは新しい PUT /api/now/wrapup/segment/update/ai エンドポイントを介して AI データをプッシュします。
    ユースケース
    • ラップアップコードとメモに AI の提案を提供することで、エージェントの処理時間を短縮します。
    • CCaaS プラットフォームが、インタラクションの終了後に AI で生成されたコンテンツを ServiceNow AI Platform にプッシュできるようにします。
    • レポートと分析のために、よりクリーンで一貫性のあるラップアップデータをスーパーバイザーに提供します。
    AI 支援による最終作業フローのエンドポイントコール順序
    1. POST /api/now/wrapup/segment/create — セグメントを開くか、 ai_wrap_up_code / ai_notes および AI 構成フラグを渡します。
    2. PUT /api/now/wrapup/segment/update/ai — (外部 AI のみ) AI 推奨事項をオープンセグメントにプッシュします。
    3. PUT /api/now/wrapup/segment/update :エージェントがセグメントをファイナライズしてクローズします。
    4. GET /api/now/wrapup/segment/{segment_id} — 保存されている AI フィールドを含むセグメントを取得します。

    最終作業:GET /now/wrapup/code/{code_id}

    指定されたラップアップコードの詳細を取得します。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/wrapup/code/{code_id}

    デフォルト URL: /api/now/wrapup/code/{code_id}

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

    表 : 1. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    code_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    表 : 2. クエリパラメーター
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

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

    デフォルト： application/json
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

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

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

    名前 説明
    result API 要求とラップアップコードに関する情報を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
   "message": "String",
   "resultMap": {Object},
   "success": Boolean
}
    result.message API 要求の結果を説明するメッセージ。

    データタイプ：文字列
    result.result_map ラップアップコードを含むオブジェクト。

    データタイプ: オブジェクト

    "result_map": {
   "wrap_up_code": {Object}
}
    result.result_map.wrap_up_code ラップアップコードに関する詳細を含むオブジェクト。

    データタイプ: オブジェクト

    "wrap_up_code": {
   "active": Boolean,
   "code": "String",
   "description": "String",
   "external": Boolean,
   "sys_id": "String",
   "translated_code": "String",
   "translated_description": "String"
}
    result.result_map.wrap_up_code.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    result.result_map.wrap_up_code.code ラップアップコードのラベル。

    データタイプ：文字列
    result.result_map.wrap_up_code.description ラップアップコードの説明。

    データタイプ：文字列
    result.result_map.wrap_up_code.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    result.result_map.wrap_up_code.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    result.result_map.wrap_up_code.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    result.result_map.wrap_up_code.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    result.success API 要求が正常に処理されたかどうかを示すフラグ。
    有効な値：
    • true:API 要求は成功しました。
    • false:API 要求が失敗しました。

    データタイプ：ブーリアン

    cURL 要求

    この例では、指定されたラップアップコードの詳細を取得します。

    curl "https://instance.service-now.com/api/now/v1/wrapup/code/49c27b679f201210c89656effa0a1cd7" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    応答本文。

    {
  "result": {
    "message": "Wrap up code found.",
    "result_map": {
      "wrap_up_code": {
        "code": "Billing Issue",
        "description": "A code for billing issues",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": "Ein code für Abrechnungsprobleme"
      }
    },
    "success": true
  }
}

    最終作業:GET /now/wrapup/segment/{segment_id}

    指定された最終作業セグメントの詳細を取得します。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/wrapup/segment/{segment_id}

    デフォルト URL: /api/now/wrapup/segment/{segment_id}

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

    表 : 7. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    segment_id インタラクションの最終作業セグメント [interaction_wrap_up_segment] テーブルの最終作業セグメントのSys_id、または外部システムのインタラクションセグメントを表す識別子。

    データタイプ：文字列
    表 : 8. クエリパラメーター
    名前 説明
    なし
    表 : 9. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

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

    デフォルト： application/json
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

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

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

    名前 説明
    メッセージ API 要求の結果を説明するメッセージ。

    データタイプ：文字列
    セグメント インタラクションと最終作業セグメントに関するデータを含むオブジェクト。

    データタイプ: オブジェクト

    "segment": {
  "agent": "String",
  "ai_code_defined_at": "String",
  "ai_notes": "String",
  "ai_notes_defined_at": "String",
  "ai_wrap_up_code": "String",
  "awaiting_confirmation": Boolean,
  "confirmed_on": "String",
  "external": Boolean,
  "interaction": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "submitted_on": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segment.agent インタラクションにアサインされたエージェントのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    segment.ai_code_defined_at AI コードが保存されたときのタイムスタンプ。

    形式:Unix エポックミリ秒 (例:「1752252703000」)

    データタイプ：文字列
    segment.ai_notes セグメントに保存された AI 生成メモ。

    データタイプ：文字列
    segment.ai_notes_defined_at AI メモが保存されたときのタイムスタンプ。

    形式:Unix エポック ミリ秒

    データタイプ：文字列
    segment.ai_wrap_up_code セグメントに保存されている AI 推奨コード。

    データタイプ：文字列
    segment.awaiting_confirmation エージェントによって送信された最終作業セグメントが外部 CCaaS システムによって処理されたことの確認を待っているかどうかを示すフラグ。
    有効な値：
    • true:最終作業セグメントは確認を待っています。
    • false:最終作業セグメントは外部システムによって処理されました。

    データタイプ：ブーリアン
    segment.confirmed_on 送信された最終作業セグメントが外部 CCaaS システムで処理される日時。

    データタイプ：文字列
    segment.external インタラクションセグメントが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:インタラクションセグメントは外部システムからのものです。
    • false:インタラクションセグメントは内部です。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.interaction インタラクションのSys_id。

    データタイプ：文字列

    テーブル:インタラクション [interaction]
    segment.opened_on 外部システムに応じた最終作業期間の開始日時。

    データタイプ：文字列
    segment.segmented 最終作業がセグメント化されているかどうかを示すフラグ。
    有効な値：
    • true:最終作業は複数の部分に分割されます。
    • false:最終作業は 1 つの完全なセグメントです。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.segment_id インタラクションセグメントのSys_id。

    データタイプ：文字列
    segment.segment_table インタラクションセグメントを含むテーブルの名前。

    データタイプ：文字列
    segment.state インタラクションセグメントのステータス。

    データタイプ：文字列
    segment.submitted_on エージェントが最終作業セグメントを送信した日時。

    データタイプ：文字列
    segment.sys_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]
    segment.wrap_up_configuration 最終作業セグメントに使用される最終作業構成に関する詳細を含むオブジェクト。

    データタイプ: オブジェクト

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_ai_code": Boolean,
  "enable_ai_notes": Boolean,
  "enable_codes": Boolean,
  "use_ai_as_default": Boolean,
  "use_third_party_ai": Boolean
}
    segment.wrap_up_configuration.allowed_codes エージェントが使用できるラップアップコードを表すオブジェクトのアレイ。

    データタイプ：アレイ

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    segment.wrap_up_configuration.allowed_codes.code ラップアップコードのラベル。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.description ラップアップコードの説明。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.allowed_codes.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code デフォルトとして使用するラップアップコードを含むオブジェクト。

    データタイプ: オブジェクト

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    segment.wrap_up_configuration.default_code.code ラップアップコードのラベル。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.description ラップアップコードの説明。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.default_code.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.enable_ai_code この構成で AI コード生成が有効になっているかどうかを示すフラグ。
    有効な値：
    • true:この構成では AI コード生成が有効になっています。
    • false:この構成では AI コード生成が有効になっていません。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.enable_ai_notes この構成で AI メモ生成が有効かどうかを示すフラグ。
    有効な値：
    • true:この構成では AI メモ生成が有効です。
    • false:この構成では AI メモ生成が有効になっていません。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.enable_codes エージェントがラップアップコードを選択する必要があるかどうかを示すフラグ。
    有効な値：
    • true:エージェントはラップアップコードを選択する必要があります。
    • false:エージェントはラップアップコードを選択する必要はありません。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.wrap_up_configuration.use_ai_as_default AI コードがこの構成のデフォルトのラップアップコードとして自動的に設定されるかどうかを示すフラグ。
    有効な値：
    • true:AI コードがデフォルトのラップアップコードとして自動的に設定されます。
    • false:AI コードがデフォルトのラップアップコードとして自動的に設定されることはありません。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.use_third_party_ai AI コンテンツソースがサードパーティの外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:AI コンテンツソースはサードパーティの外部システムからのものです。
    • false: Now Assist が AI コンテンツソースです。

    データタイプ：ブーリアン
    segment_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]
    成功 API 要求が正常に処理されたかどうかを示すフラグ。
    有効な値：
    • true:API 要求は成功しました。
    • false:API 要求が失敗しました。

    データタイプ：ブーリアン

    cURL 要求

    この例では、指定された最終作業セグメントの詳細を取得します。

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/dgajbcef12345678defdbxef123435678" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    応答本文。

    {
  "success": true,
  "message": "Wrap up segment retrieved successfully.",
  "segment_id": "dgajbcef12345678defdbxef123435678",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}

    この例では、AI の推奨事項用に構成された指定されたラップアップセグメントの詳細を取得します。

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/abcd1234abcd1234abcd1234abcd1234" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    応答本文。

    {
  "success": true,
  "message": "Segment retrieved.",
  "segment_id": "abcd1234abcd1234abcd1234abcd1234",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "state": "closed",
    "ai_wrap_up_code": "Billing Issue",
    "ai_notes": "Customer called about an incorrect charge.",
    "ai_code_defined_at": "1752252703000",
    "ai_notes_defined_at": "1752252703000",
    "wrap_up_configuration": {
      "enable_ai_code": true,
      "enable_ai_notes": true,
      "use_ai_as_default": true,
      "use_third_party_ai": false
    }
  }
}

    最終作業:GET /now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

    指定されたエージェントとインタラクションに基づいて最終作業セグメントの詳細を取得します。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

    デフォルト URL: /api/now/wrapup/segment/agent/{agent_id}/interaction/{interaction_id}

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

    表 : 13. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    agent_id インタラクションにアサインされたエージェントのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    interaction_id インタラクションのSys_id。

    データタイプ：文字列

    テーブル:インタラクション [interaction]
    表 : 14. クエリパラメーター
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

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

    デフォルト： application/json
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

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

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

    名前 説明
    メッセージ API 要求の結果を説明するメッセージ。

    データタイプ：文字列
    セグメント インタラクションと最終作業セグメントに関するデータを含むオブジェクト。

    データタイプ: オブジェクト

    "segment": {
  "agent": "String",
  "ai_code_defined_at": "String",
  "ai_notes": "String",
  "ai_notes_defined_at": "String",
  "ai_wrap_up_code": "String",
  "awaiting_confirmation": Boolean,
  "confirmed_on": "String",
  "external": Boolean,
  "interaction": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "submitted_on": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segment.agent インタラクションにアサインされたエージェントのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    segment.agent インタラクションにアサインされたエージェントのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    segment.ai_code_defined_at AI コードが保存されたときのタイムスタンプ。

    形式:Unix エポックミリ秒 (例:「1752252703000」)

    データタイプ：文字列
    segment.ai_notes セグメントに保存された AI 生成メモ。

    データタイプ：文字列
    segment.ai_notes_defined_at AI メモが保存されたときのタイムスタンプ。

    形式:Unix エポック ミリ秒

    データタイプ：文字列
    segment.ai_wrap_up_code セグメントに保存されている AI 推奨コード。

    データタイプ：文字列
    segment.awaiting_confirmation エージェントによって送信された最終作業セグメントが外部 CCaaS システムによって処理されたことの確認を待っているかどうかを示すフラグ。
    有効な値：
    • true:最終作業セグメントは確認を待っています。
    • false:最終作業セグメントは外部システムによって処理されました。

    データタイプ：ブーリアン
    segment.confirmed_on 送信された最終作業セグメントが外部 CCaaS システムで処理される日時。

    データタイプ：文字列
    segment.external インタラクションセグメントが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:インタラクションセグメントは外部システムからのものです。
    • false:インタラクションセグメントは内部です。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.interaction インタラクションのSys_id。

    データタイプ：文字列

    テーブル:インタラクション [interaction]
    segment.opened_on 外部システムに応じた最終作業期間の開始日時。

    データタイプ：文字列
    segment.segmented 最終作業がセグメント化されているかどうかを示すフラグ。
    有効な値：
    • true:最終作業は複数の部分に分割されます。
    • false:最終作業は 1 つの完全なセグメントです。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.segment_id インタラクションセグメントのSys_id。

    データタイプ：文字列
    segment.segment_table インタラクションセグメントを含むテーブルの名前。

    データタイプ：文字列
    segment.state インタラクションセグメントのステータス。

    データタイプ：文字列
    segment.submitted_on エージェントが最終作業セグメントを送信した日時。

    データタイプ：文字列
    segment.sys_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]
    segment.wrap_up_configuration 最終作業セグメントに使用される最終作業構成に関する詳細を含むオブジェクト。

    データタイプ: オブジェクト

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_codes": Boolean
}
    segment.wrap_up_configuration.allowed_codes エージェントが使用できるラップアップコードを表すオブジェクトのアレイ。

    データタイプ：アレイ

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    segment.wrap_up_configuration.allowed_codes.code ラップアップコードのラベル。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.description ラップアップコードの説明。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.allowed_codes.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code デフォルトとして使用するラップアップコードを含むオブジェクト。

    データタイプ: オブジェクト

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    segment.wrap_up_configuration.default_code.code ラップアップコードのラベル。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.description ラップアップコードの説明。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.default_code.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.enable_ai_code この構成で AI コード生成が有効になっているかどうかを示すフラグ。
    有効な値：
    • true:この構成では AI コード生成が有効になっています。
    • false:この構成では AI コード生成が有効になっていません。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.enable_ai_notes この構成で AI メモ生成が有効かどうかを示すフラグ。
    有効な値：
    • true:この構成では AI メモ生成が有効です。
    • false:この構成では AI メモ生成が有効になっていません。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.enable_codes エージェントがラップアップコードを選択する必要があるかどうかを示すフラグ。
    有効な値：
    • true:エージェントはラップアップコードを選択する必要があります。
    • false:エージェントはラップアップコードを選択する必要はありません。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.wrap_up_configuration.use_ai_as_default AI コードがこの構成のデフォルトのラップアップコードとして自動的に設定されるかどうかを示すフラグ。
    有効な値：
    • true:AI コードがデフォルトのラップアップコードとして自動的に設定されます。
    • false:AI コードがデフォルトのラップアップコードとして自動的に設定されることはありません。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.use_third_party_ai AI コンテンツソースがサードパーティの外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:AI コンテンツソースはサードパーティの外部システムからのものです。
    • false: Now Assist が AI コンテンツソースです。

    データタイプ：ブーリアン
    segment_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]
    成功 API 要求が正常に処理されたかどうかを示すフラグ。
    有効な値：
    • true:API 要求は成功しました。
    • false:API 要求が失敗しました。

    データタイプ：ブーリアン

    cURL 要求

    この例では、指定されたエージェントとインタラクションに基づいて最終作業セグメントの詳細を取得します。

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/agent/123412345678567890ab90abcdefcdef/interaction/213412345678567890ab90abcdefcdef" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    応答本文。

    {
  "success": true,
  "message": "Wrap up segment retrieved successfully.",
  "segment_id": "dgajbcef12345678defdbxef123435678",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}

    cURL 要求

    この例では、AI の推奨事項用に構成されたラップアップセグメントの詳細を取得します。

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/agent/987698761234123456xy12ghijklmnoqrst/interaction/879065432198432109xy34mnopqrstuv" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    応答本文。

    {
  "success": true,
  "segment": {
    "ai_wrap_up_code": "Billing Issue",
    "ai_notes": "Customer called about incorrect charge.",
    "ai_code_defined_at": "1752252703000",
    "ai_notes_defined_at": "1752252703000",
    "wrap_up_configuration": {
      "enable_ai_code": true,
      "enable_ai_notes": true,
      "use_ai_as_default": true,
      "use_third_party_ai": false
    }
  }
}

    最終作業:POST /now/wrapup/code

    ラップアップコードを作成または更新します。

    ラップアップコードは、インタラクションの最終作業コード [interaction_wrap_up_code] テーブルに作成されます。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/wrapup/code

    デフォルト URL: /api/now/wrapup/code

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

    表 : 19. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 20. クエリパラメーター
    名前 説明
    なし
    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    コード 必須です。それぞれがラップアップコードを表すオブジェクトのアレイ。

    データタイプ：アレイ

    "codes": [
   {
      "active": Boolean,
      "code": "String",
      "description": "String",
      "translations": [Array]
   }
]
    codes.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    codes.code 必須です。 ラップアップコードのラベル。

    データタイプ：文字列
    codes.description ラップアップコードの説明。

    データタイプ：文字列
    codes.translations それぞれがラップアップコードの翻訳を表すオブジェクトのアレイ。

    データタイプ：アレイ

    "translations": [
   {    
      "code": "Abrechnungsproblem",
      "description": "Ein code für Abrechnungsprobleme",
      "language": "de"
   }
]
    codes.translations.code ラップアップコードラベル (codes.code) の翻訳。codes.translations パラメーターを使用する場合は必須です。

    データタイプ：文字列
    codes.translations.description ラップアップコードの説明 (codes.description) の翻訳。codes.translations パラメーターを使用し、codes.descriptionに値が指定されている場合は必須です。

    データタイプ：文字列
    codes.translations.language 翻訳で使用される言語の 2 文字のコード。codes.translations パラメーターを使用する場合は必須です。

    データタイプ：文字列

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

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

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    207 成功。一部のラップアップコードが正常に作成されました。他の作成中に検証エラーが発生しました。
    400 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。
    401 権限がありません。ユーザー認証情報が正しくないか、渡されていません。
    500 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

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

    名前 説明
    result API 要求と作成されたラップアップコードに関する情報を含むオブジェクト。

    データタイプ: オブジェクト

    "result": {
   "message": "String",
   "resultMap": {Object},
   "success": Boolean
}
    result.message API 要求の結果を説明するメッセージ。

    データタイプ：文字列
    result.result_map 作成されたラップアップコードのアレイを含むオブジェクト。

    データタイプ: オブジェクト

    "result_map": {
   "created_wrap_up_codes": [Array]
}
    result.result_map.created_wrap_up_codes それぞれが作成されたラップアップコードを表すオブジェクトのアレイ。

    データタイプ：アレイ

    "created_wrap_up_codes": [
   {
      "active": Boolean,
      "code": "String",
      "description": "String",
      "external": Boolean,
      "sys_id": "String",
      "translated_code": "String",
      "translated_description": "String"
   }
]
    result.result_map.created_wrap_up_codes.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    result.result_map.created_wrap_up_codes.code ラップアップコードのラベル。

    データタイプ：文字列
    result.result_map.created_wrap_up_codes.description ラップアップコードの説明。

    データタイプ：文字列
    result.result_map.created_wrap_up_codes.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    result.result_map.created_wrap_up_codes.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    result.result_map.created_wrap_up_codes.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    result.result_map.created_wrap_up_codes.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    result.success API 要求が正常に処理されたかどうかを示すフラグ。
    有効な値：
    • true:API 要求は成功しました。
    • false:API 要求が失敗しました。

    データタイプ：ブーリアン

    cURL 要求

    この例では、ドイツ語に翻訳して請求処理の問題に対するラップアップコードを作成します。

    curl "https://instance.service-now.com/api/now/v1/wrapup/code" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"codes\": [
    {
      \"code\": \"Billing Issue\",
      \"description\": \"A code for billing issues\",
      \"translations\": [
        {
          \"language\": \"de\",
          \"code\": \"Abrechnungsproblem\",
          \"description\": \"Ein code für Abrechnungsprobleme\"
        }
      ]
    }
  ]
}" \
--user 'username':'password'

    応答本文。

    {
  "result": {
    "message": "All wrap up codes created successfully.",
    "result_map": {
      "created_wrap_up_codes": [
        {
          "code": "Billing Issue",
          "description": "A code for billing issues",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": "Ein code für Abrechnungsprobleme"
        }
      ]
    },
    "success": true
  }
}

    最終作業:POST /now/wrapup/segment/create

    インタラクションの最終作業セグメントを開きます。

    最終作業は、インタラクションの最終作業セグメント [interaction_wrap_up_segment] テーブルに作成されます。ラップアップ期間の開始時にこのエンドポイントを呼び出します。

    このエンドポイントは、AI が生成したラップアップコードとメモを要求ペイロードで直接サポートし、ラップアップ構成に AI 構成フラグを保存します。external が false に設定され、構成で AI コードまたはメモが有効になっている場合、セグメントの作成後に同期ビジネスルールが実行されます。このエンドポイントは、内部 CSM (NowAssist) API を呼び出し、AI フィールドに自動的に入力します。発信者による追加のアクションは必要ありません。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/wrapup/segment/create

    デフォルト URL: /api/now/wrapup/segment/create

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

    表 : 25. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 26. クエリパラメーター
    名前 説明
    なし
    表 : 27. 要求本文パラメーター (XML または JSON)
    名前 説明
    agent_sys_id 必須です。インタラクションにアサインされたエージェントのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    ai_wrap_up_code AI が提案するラップアップコードラベル。use_third_party_ai の値が false の場合、またはフィールドが構成に存在しない場合、Now Assistによって自動的に入力されます。
    関連項目：

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]

    データタイプ：文字列
    ai_notes AI で生成されたメモ。

    最大長:4000 文字

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]

    データタイプ：文字列
    構成 外部最終作業のコードと期間の詳細を含むオブジェクト。externalが true の場合は必須です。

    データタイプ: オブジェクト

    "configuration": {  
   "allowed_codes": [Array], 
   "default_code": "String", 
   "duration": "String", 
   "enable_codes": Boolean,
   "enable_ai_code": Boolean,
   "enable_ai_notes": Boolean,
   "show_timer": Boolean,
   "use_ai_as_default": Boolean
}
    configuration.allowed_codes エージェントが使用できるラップアップコードを表すオブジェクトのアレイ。externalとconfiguration.enable_codesの両方が true の場合は必須です。

    データタイプ：アレイ

    "allowed_codes": [ 
   { 
      "code": "String", 
      "translation": {Object}  
   } 
]
    configuration.allowed_codes.code ラップアップコードのラベル。configuration.allowed_codes パラメーターを使用する場合は必須です。

    データタイプ：文字列
    configuration.allowed_codes.translation ラップアップコードの翻訳。

    データタイプ: オブジェクト

    "translation": {  
   "code": "String",
   "language": "String"  
}
    configuration.allowed_codes.translation.code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    configuration.allowed_codes.translation.language 翻訳で使用される言語の 2 文字のコード。

    データタイプ：文字列
    configuration.default_code デフォルトとして使用するラップアップコードのラベル。externalとconfiguration.enable_codesの両方が true の場合は必須です。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]

    フィールド:コード
    configuration.duration 許容最大最終作業期間。show_timer と一緒に使用する必要があります。

    データタイプ：文字列

    単位：秒

    デフォルト:空の文字列 (時間制限なし)。
    configuration.enable_codes エージェントがラップアップコードを選択する必要があるかどうかを示すフラグ。
    有効な値：
    • true:エージェントはラップアップコードを選択する必要があります。
    • false:エージェントはラップアップコードを選択する必要はありません。

    データタイプ：ブーリアン

    デフォルト値：false
    configuration.enable_ai_code この構成で AI コード生成が有効になっているかどうかを示すフラグ。
    有効な値：
    • true:この構成では AI コード生成が有効になっています。
    • false:この構成では AI コード生成が有効になっていません。
    テーブル:インタラクションの最終作業構成 [interaction_wrap_up_configuration]

    データタイプ：ブーリアン

    デフォルト値：false
    configuration.enable_ai_notes この構成で AI メモ生成が有効かどうかを示すフラグ。
    有効な値：
    • true:この構成では AI メモ生成が有効です。
    • false:この構成では AI メモ生成が有効になっていません。
    テーブル:インタラクションの最終作業構成 [interaction_wrap_up_configuration]

    データタイプ：ブーリアン

    デフォルト値：false
    configuration.use_ai_as_default AI コードがこの構成のデフォルトのラップアップコードとして自動的に設定されるかどうかを示すフラグ。
    有効な値：
    • true:AI コードがデフォルトのラップアップコードとして自動的に設定されます。
    • false:AI コードがデフォルトのラップアップコードとして自動的に設定されることはありません。
    テーブル:インタラクションの最終作業構成 [interaction_wrap_up_configuration]

    データタイプ：ブーリアン

    デフォルト値：false
    configuration.show_timer 期間プロパティを使用する場合は必須です。タイマーを表示するかどうかを示すフラグ。
    有効な値：
    • true:UI にタイマーが表示されます。
    • false:UI にタイマーを表示しません。

    データタイプ：ブーリアン

    デフォルト値：false
    外部 インタラクションセグメントが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:インタラクションセグメントは外部システムからのものです。
    • false:インタラクションセグメントは内部です。

    データタイプ：ブーリアン

    デフォルト値：false
    external_segment_id 外部システムのインタラクションセグメントを表す識別子。externalが true の場合は必須です。

    データタイプ：文字列
    interaction_sys_id 必須です。インタラクションのSys_id。

    データタイプ：文字列

    テーブル:インタラクション [interaction]
    opened_on 外部システムに応じた最終作業期間の開始日時。configuration.duration パラメーターを使用する場合は必須です。

    データタイプ：文字列
    セグメント済み 最終作業がセグメント化されているかどうかを示すフラグ。
    有効な値：
    • true:最終作業は複数の部分に分割されます。
    • false:最終作業は 1 つの完全なセグメントです。

    データタイプ：ブーリアン

    デフォルト値：false
    segment_id インタラクションセグメントのSys_id。externalとsegmentedの両方が true の場合は必須です。
    注:
    InteractionSegment スクリプト拡張ポイントを実装して、選択したテーブルでセグメントレコードを作成および取得するか、 OpenFrame 実装を使用して電話ログ [sn_openframe_phone_log] テーブルでセグメントレコードを作成および取得する必要があります。

    データタイプ：文字列
    segment_table インタラクションセグメントを含むテーブルの名前。externalとsegmentedの両方が true の場合は必須です。

    データタイプ：文字列
    wrap_up_configuration_sys_id 使用するラップアップ構成のSys_id。externalが false の場合は必須です。

    データタイプ：文字列

    テーブル:インタラクションの最終作業構成 [interaction_wrap_up_configuration]

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

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

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 29. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

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

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

    名前 説明
    メッセージ API 要求の結果を説明するメッセージ。

    データタイプ：文字列
    セグメント インタラクションと最終作業セグメントに関するデータを含むオブジェクト。

    データタイプ: オブジェクト

    "segment": {
  "agent": "String",
  "external": Boolean,
  "interaction": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segment.agent インタラクションセグメントにアサインされたエージェントのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    segment.external インタラクションセグメントが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:インタラクションセグメントは外部システムからのものです。
    • false:インタラクションセグメントは内部です。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.interaction インタラクションのSys_id。

    データタイプ：文字列

    テーブル:インタラクション [interaction]
    segment.opened_on 外部システムに応じた最終作業期間の開始日時。

    データタイプ：文字列
    segment.segmented 最終作業がセグメント化されているかどうかを示すフラグ。
    有効な値：
    • true:最終作業は複数の部分に分割されます。
    • false:最終作業は 1 つの完全なセグメントです。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.segment_id インタラクションセグメントのSys_id。

    データタイプ：文字列
    segment.segment_table インタラクションセグメントを含むテーブルの名前。

    データタイプ：文字列
    segment.state インタラクションセグメントのステータス。Wrap Up API によって正常に作成されたインタラクションセグメントは、オープンステータスになります。

    データタイプ：文字列
    segment.sys_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]
    segment.wrap_up_configuration 最終作業セグメントに使用される最終作業構成に関する詳細を含むオブジェクト。

    データタイプ: オブジェクト

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_ai_code": Boolean,
  "enable_ai_notes": Boolean,
  "enable_codes": Boolean,
  "use_ai_as_default": Boolean,
  "use_third_party_ai": Boolean
}
    segment.wrap_up_configuration.allowed_codes エージェントが使用できるラップアップコードを表すオブジェクトのアレイ。

    データタイプ：アレイ

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    segment.wrap_up_configuration.allowed_codes.code ラップアップコードのラベル。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.description ラップアップコードの説明。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.allowed_codes.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code デフォルトとして使用するラップアップコードを含むオブジェクト。

    データタイプ: オブジェクト

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    segment.wrap_up_configuration.default_code.code ラップアップコードのラベル。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.description ラップアップコードの説明。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.default_code.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.enable_ai_code この構成で AI コード生成が有効になっているかどうかを示すフラグ。
    有効な値：
    • true:この構成では AI コード生成が有効になっています。
    • false:この構成では AI コード生成が有効になっていません。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.enable_ai_notes この構成で AI メモ生成が有効かどうかを示すフラグ。
    有効な値：
    • true:この構成では AI メモ生成が有効です。
    • false:この構成では AI メモ生成が有効になっていません。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.enable_codes エージェントがラップアップコードを選択する必要があるかどうかを示すフラグ。
    有効な値：
    • true:エージェントはラップアップコードを選択する必要があります。
    • false:エージェントはラップアップコードを選択する必要はありません。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.wrap_up_configuration.use_ai_as_default AI コードがこの構成のデフォルトのラップアップコードとして自動的に設定されるかどうかを示すフラグ。
    有効な値：
    • true:AI コードがデフォルトのラップアップコードとして自動的に設定されます。
    • false:AI コードがデフォルトのラップアップコードとして自動的に設定されることはありません。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.use_third_party_ai AI コンテンツソースがサードパーティの外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:AI コンテンツソースはサードパーティの外部システムからのものです。
    • false: Now Assist が AI コンテンツソースです。

    データタイプ：ブーリアン
    成功 API 要求が正常に処理されたかどうかを示すフラグ。
    有効な値：
    • true:API 要求は成功しました。
    • false:API 要求が失敗しました。

    データタイプ：ブーリアン
    sys_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]

    cURL 要求

    この例では、インタラクションの最終作業セグメントを開きます。

    curl --request POST \
  --url 'https://instance.servicenow.com/api/now/wrapup/segment/create' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --user 'username:password' \
  --data '{
    "agent_sys_id": "123412345678567890ab90abcdefcdef",
    "interaction_sys_id": "213412345678567890ab90abcdefcdef",
    "external": true,
    "external_segment_id": "EXT-SEG-001",
    "ai_wrap_up_code": "Billing Issue",
    "ai_notes": "Customer called about an incorrect charge on their invoice.",
    "configuration": {
      "enable_codes": true,
      "enable_ai_code": true,
      "enable_ai_notes": true,
      "use_ai_as_default": true,
      "allowed_codes": [{"code": "Billing Issue"}, {"code": "Store Issue"}],
      "default_code": "Billing Issue"
    }
  }'

--user 'username':'password'

    応答本文。

    {
  "success": true,
  "message": "Wrap-up segment created successfully.",
  "sys_id": "abcd1234abcd1234abcd1234abcd1234",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "open",
    "sys_id": "abcd1234abcd1234abcd1234abcd1234",
    "wrap_up_configuration": {
      "enable_codes": true,
      "enable_ai_code": true,
      "enable_ai_notes": true,
      "use_ai_as_default": true,
      "allowed_codes": [...],
      "default_code": {...}
    }
  }
}

    cURL 要求

    この例では、AI の推奨事項用に構成された最終作業セグメントを開きます。

    curl --request POST \
  --url 'https://instance.servicenow.com/api/now/wrapup/segment/create' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --user 'username:password' \
  --data '{
    "agent_sys_id": "123412345678567890ab90abcdefcdef",
    "interaction_sys_id": "213412345678567890ab90abcdefcdef",
    "external": true,
    "external_segment_id": "EXT-SEG-001",
    "ai_wrap_up_code": "Billing Issue",
    "ai_notes": "Customer called about an incorrect charge on their invoice.",
    "configuration": {
      "enable_codes": true,
      "enable_ai_code": true,
      "enable_ai_notes": true,
      "use_ai_as_default": true,
      "allowed_codes": [{"code": "Billing Issue"}, {"code": "Store Issue"}],
      "default_code": "Billing Issue"
    }
  }'

    応答本文。

    {
  "success": true,
  "message": "Wrap-up segment created successfully.",
  "sys_id": "abcd1234abcd1234abcd1234abcd1234",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "open",
    "sys_id": "abcd1234abcd1234abcd1234abcd1234",
    "wrap_up_configuration": {
      "enable_codes": true,
      "enable_ai_code": true,
      "enable_ai_notes": true,
      "use_ai_as_default": true,
      "allowed_codes": [...],
      "default_code": {...}
    }
  }
}

    最終作業:PUT /now/wrapup/segment/update

    インタラクションの最終作業セグメントを更新して閉じます。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/wrapup/segment/update

    デフォルト URL: /api/now/wrapup/segment/update

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

    表 : 31. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 32. クエリパラメーター
    名前 説明
    agent_sys_id インタラクションにアサインされたエージェントのSys_id。segment_sys_idもexternal_segment_idも指定されていない場合は、interaction_sys_idとともに必須です。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    external_segment_id 外部システムのインタラクションセグメントを表す識別子。segment_sys_idが指定されていない場合に更新する最終作業セグメントを識別するために使用されます。
    interaction_sys_id インタラクションのSys_id。segment_sys_idもexternal_segment_idも指定されていない場合は、agent_sys_idとともに必須です。

    データタイプ：文字列

    テーブル:インタラクション [interaction]
    segment_sys_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]
    表 : 33. 要求本文パラメーター (XML または JSON)
    名前 説明
    confirmed_on 外部システムに応じた最終作業期間の終了日時。

    データタイプ：文字列
    notes エージェントによって最終作業に追加された追加のメモ。

    データタイプ：文字列
    wrap_up_code エージェントによって選択されたラップアップコードのラベル。エージェントがコードを選択しない場合は、設定されたデフォルトコードが使用されます。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]

    フィールド:コード

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

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

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 35. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

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

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

    名前 説明
    メッセージ API 要求の結果を説明するメッセージ。

    データタイプ：文字列
    セグメント インタラクションと最終作業セグメントに関するデータを含むオブジェクト。

    データタイプ: オブジェクト

    "segment": {
  "agent": "String",
  "awaiting_confirmation": Boolean,
  "code": {Object},
  "confirmed_on": "String",
  "external": Boolean,
  "interaction": "String",
  "notes": "String",
  "opened_on": "String",
  "segmented": Boolean,
  "segment_id": "String",
  "segment_table": "String",
  "state": "String",
  "submitted_on": "String",
  "sys_id": "String",
  "wrap_up_configuration": {Object} 
}
    segment.agent インタラクションにアサインされたエージェントのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    segment.awaiting_confirmation エージェントによって送信された最終作業セグメントが外部 CCaaS システムによって処理されたことの確認を待っているかどうかを示すフラグ。
    有効な値：
    • true:最終作業セグメントは確認を待っています。
    • false:最終作業セグメントは外部システムによって処理されました。

    データタイプ：ブーリアン
    segment.code エージェントによって選択されたラップアップコードを含むオブジェクト。

    データタイプ: オブジェクト

    "code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.code.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    segment.code.code ラップアップコードのラベル。

    データタイプ：文字列
    segment.code.description ラップアップコードの説明。

    データタイプ：文字列
    segment.code.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    segment.code.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    segment.code.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    segment.code.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    segment.confirmed_on 送信された最終作業セグメントが外部 CCaaS システムで処理される日時。

    データタイプ：文字列
    segment.external インタラクションセグメントが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:インタラクションセグメントは外部システムからのものです。
    • false:インタラクションセグメントは内部です。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.interaction インタラクションのSys_id。

    データタイプ：文字列

    テーブル:インタラクション [interaction]
    segment.notes エージェントによって最終作業に追加された追加のメモ。

    データタイプ：文字列
    segment.opened_on 外部システムに応じた最終作業期間の開始日時。

    データタイプ：文字列
    segment.segmented 最終作業がセグメント化されているかどうかを示すフラグ。
    有効な値：
    • true:最終作業は複数の部分に分割されます。
    • false:最終作業は 1 つの完全なセグメントです。

    データタイプ：ブーリアン

    デフォルト値：false
    segment.segment_id インタラクションセグメントのSys_id。

    データタイプ：文字列
    segment.segment_table インタラクションセグメントを含むテーブルの名前。

    データタイプ：文字列
    segment.state インタラクションセグメントのステータス。このエンドポイントが正常に更新したインタラクションセグメントは、クローズ済みステータスです。

    データタイプ：文字列
    segment.submitted_on エージェントが最終作業セグメントを送信した日時。

    データタイプ：文字列
    segment.sys_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]
    segment.wrap_up_configuration 最終作業セグメントに使用される最終作業構成に関する詳細を含むオブジェクト。

    データタイプ: オブジェクト

    "wrap_up_configuration": {  
  "allowed_codes": [Array],
  "default_code": {Object},
  "enable_codes": Boolean
}
    segment.wrap_up_configuration.allowed_codes エージェントが使用できるラップアップコードを表すオブジェクトのアレイ。

    データタイプ：アレイ

    "allowed_codes": [
  {
    "active": Boolean, 
    "code": "String",
    "description": "String",
    "external": Boolean,
    "sys_id": "String",
    "translated_code": "String",
    "translated_description": "String"
  }
]
    segment.wrap_up_configuration.allowed_codes.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    segment.wrap_up_configuration.allowed_codes.code ラップアップコードのラベル。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.description ラップアップコードの説明。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.allowed_codes.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    segment.wrap_up_configuration.allowed_codes.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.allowed_codes.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code デフォルトとして使用するラップアップコードを含むオブジェクト。

    データタイプ: オブジェクト

    "default_code": {
  "active": Boolean,
  "code": "String",
  "description": "String",
  "external": Boolean,
  "sys_id": "String",
  "translated_code": "String",
  "translated_description": "String"
}
    segment.wrap_up_configuration.default_code.active ラップアップコードがアクティブかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードはアクティブです。
    • false:ラップアップコードはアクティブではありません。

    データタイプ：ブーリアン

    デフォルト：true
    segment.wrap_up_configuration.default_code.code ラップアップコードのラベル。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.description ラップアップコードの説明。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.external ラップアップコードが外部システムからのものであるかどうかを示すフラグ。
    有効な値：
    • true:ラップアップコードは外部システムからのものです。
    • false:ラップアップコードは内部コードです。

    データタイプ：ブーリアン
    segment.wrap_up_configuration.default_code.sys_id ラップアップコードのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業コード [interaction_wrap_up_code]
    segment.wrap_up_configuration.default_code.translated_code ラップアップコードラベルの翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.default_code.translated_description ラップアップコードの説明の翻訳。

    データタイプ：文字列
    segment.wrap_up_configuration.enable_codes エージェントがラップアップコードを選択する必要があるかどうかを示すフラグ。
    有効な値：
    • true:エージェントはラップアップコードを選択する必要があります。
    • false:エージェントはラップアップコードを選択する必要はありません。

    データタイプ：ブーリアン

    デフォルト値：false
    成功 API 要求が正常に処理されたかどうかを示すフラグ。
    有効な値：
    • true:API 要求は成功しました。
    • false:API 要求が失敗しました。

    データタイプ：ブーリアン
    sys_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]

    cURL 要求

    この例では、インタラクションの最終作業セグメントを更新して閉じます。

    curl "https://instance.service-now.com/api/now/v1/wrapup/segment/update?segment_sys_id=98769876543254321fed1fedcba0cba0&agent_sys_id=123412345678567890ab90abcdefcdef&interaction_sys_id=213412345678567890ab90abcdefcde" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"wrap_up_code\": \"Billing Issue\",
  \"notes\": \"Customer's credit card expired. Had to switch to another one.\",
  \"confirmed_on\": \"2024-09-16 18:52:01\"
}" \
--user 'username':'password'

    応答本文。

    {
  "success": true,
  "message": "Wrap-up segment updated successfully.",
  "sys_id": "98769876543254321fed1fedcba0cba0",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "closed",
    "wrap_up_configuration": {
      "enable_codes": true,
      "allowed_codes": [
        {
          "code": "Billing Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "49c27b679f201210c89656effa0a1cd7",
          "translated_code": "Abrechnungsproblem",
          "translated_description": ""
        },
        {
          "code": "Store Issue",
          "description": "",
          "active": true,
          "external": true,
          "sys_id": "54327b679f201210c89656effa0a1cd7",
          "translated_code": " Einkaufsproblem",
          "translated_description": ""
        }
      ],
      "default_code": {
        "code": "Billing Issue",
        "description": "",
        "active": true,
        "external": true,
        "sys_id": "49c27b679f201210c89656effa0a1cd7",
        "translated_code": "Abrechnungsproblem",
        "translated_description": ""
      }
    },
    "code": {
      "code": "Billing Issue",
      "description": "",
      "active": true,
      "external": true,
      "sys_id": "49c27b679f201210c89656effa0a1cd7",
      "translated_code": "Abrechnungsproblem",
      "translated_description": ""
    },
    "notes": "Customer's credit card expired. Had to switch to another one.",
    "segmented": true,
    "sys_id": "dgajbcef12345678defdbxef123435678",
    "opened_on": "2024-09-16 17:52:01",
    "submitted_on": "2024-09-16 18:51:59",
    "confirmed_on": "2024-09-16 18:52:01",
    "awaiting_confirmation": false
  }
}

    最終作業:PUT /now/wrapup/segment/update/ai

    既存のオープンな最終作業セグメントを、AI が推奨する最終作業コードとメモで更新します。

    このエンドポイントは、AI コンテンツを個別に生成し、セグメントの作成後に ServiceNow プラットフォームにプッシュする外部 CCaaS システムを対象としています。use_third_party_ai プロパティは、最終作業構成で true である必要があります。

    構成で enable_ai_code または enable_ai_notes が false の場合、対応する AI フィールドは、要求ペイロードに含まれていても保存されます。ai_code_defined_atとai_notes_defined_atのタイムスタンプは、保存時に自動的に設定されます。

    AI 最終作業の推奨事項

    AI の最終作業に関する推奨事項は、次の 2 つのソースから取得できます。

    • 内部 (Now Assist): use_third_party_ai が false の場合、セグメントの作成後にビジネスルールが自動的にトリガーされ、CSM API を呼び出して ai_wrap_up_code と ai_notesを入力します。
    • 外部 (サードパーティ/CCaaS): use_third_party_ai が true の場合、外部システムは新しい PUT /api/now/wrapup/segment/update/ai エンドポイントを介して AI データをプッシュします。
    ユースケース
    • ラップアップコードとメモに AI の提案を提供することで、エージェントの処理時間を短縮します。
    • CCaaS プラットフォームが、インタラクションの終了後に AI で生成されたコンテンツを ServiceNow AI Platform にプッシュできるようにします。
    • レポートと分析のために、よりクリーンで一貫性のあるラップアップデータをスーパーバイザーに提供します。
    AI 支援による最終作業フローのエンドポイントコール順序
    1. POST /api/now/wrapup/segment/create — セグメントを開くか、 ai_wrap_up_code / ai_notes および AI 構成フラグを渡します。
    2. PUT /api/now/wrapup/segment/update/ai — (外部 AI のみ) AI 推奨事項をオープンセグメントにプッシュします。
    3. PUT /api/now/wrapup/segment/update :エージェントがセグメントをファイナライズしてクローズします。
    4. GET /api/now/wrapup/segment/{segment_id} — 保存されている AI フィールドを含むセグメントを取得します。

    URL 形式

    バージョニングされた URL: /api/now/{api_version}/wrapup/segment/update/ai

    デフォルト URL: /api/now/wrapup/segment/update/ai

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

    表 : 37. パスパラメーター
    名前 説明
    api_version オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。

    データタイプ：文字列
    表 : 38. クエリパラメーター
    名前 説明
    なし
    表 : 39. 要求本文パラメーター (XML または JSON)
    名前 説明
    agent_sys_id インタラクションにアサインされたエージェントのSys_id。segment_sys_idもexternal_segment_idも指定しない場合は、interaction_sys_idで必須です。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    ai_wrap_up_code AI が推奨するラップアップコードラベル。構成で enable_ai_code プロパティが true の場合にのみ保存されます。最終作業:POST /now/wrapup/segment/create

    データタイプ：文字列
    ai_notes AI で生成されたメモ。. 構成で enable_ai_notes が true の場合にのみ保存されます。最終作業:POST /now/wrapup/segment/create

    最大長:4000 文字

    データタイプ：文字列
    interaction_sys_id インタラクションのSys_id。segment_sys_idもexternal_segment_idも指定しない場合は、agent_sys_idで必須です。

    データタイプ：文字列

    テーブル:インタラクション [interaction]
    segment_sys_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]

    ヘッダー

    次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

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

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 41. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

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

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

    名前 説明
    メッセージ API 要求の結果を説明するメッセージ。

    データタイプ：文字列
    セグメント インタラクションと最終作業セグメントに関するデータを含むオブジェクト。

    データタイプ: オブジェクト

    "segment": {
  "agent": "String",
  "ai_code_defined_at": "String",
  "ai_notes": "String",
  "ai_notes_defined_at": "String",
  "ai_wrap_up_code": "String",
  "interaction": "String",
  "sys_id": "String"
}
    segment.agent インタラクションにアサインされたエージェントのSys_id。

    データタイプ：文字列

    テーブル： ユーザー [sys_user]
    segment.ai_code_defined_at AI コードが保存されたときのタイムスタンプ。

    形式:Unix エポックミリ秒 (例:「1752252703000」)

    データタイプ：文字列
    segment.ai_notes セグメントに保存された AI 生成メモ。

    データタイプ：文字列
    segment.ai_notes_defined_at AI メモが保存されたときのタイムスタンプ。

    形式:Unix エポック ミリ秒

    データタイプ：文字列
    segment.ai_wrap_up_code セグメントに保存されている AI 推奨コード。

    データタイプ：文字列
    segment.interaction インタラクションのSys_id。

    データタイプ：文字列

    テーブル:インタラクション [interaction]
    segment.sys_id 最終作業セグメントのSys_id。

    データタイプ：文字列

    テーブル:インタラクションの最終作業セグメント [interaction_wrap_up_segment]
    成功 API 要求が正常に処理されたかどうかを示すフラグ。
    有効な値：
    • true:API 要求は成功しました。
    • false:API 要求が失敗しました。

    データタイプ：ブーリアン

    cURL 要求

    この例では、インタラクションの最終作業セグメントを更新して閉じます。

    curl --request PUT \
  --url 'https://instance.servicenow.com/api/now/wrapup/segment/update/ai' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --user 'username:password' \
  --data '{
    "segment_sys_id": "abcd1234abcd1234abcd1234abcd1234",
    "agent_sys_id": "123412345678567890ab90abcdefcdef",
    "interaction_sys_id": "213412345678567890ab90abcdefcdef",
    "ai_wrap_up_code": "Plan Update",
    "ai_notes": "Customer requested an upgrade to the Premium plan."
  }' \
--user 'username':'password'

    応答本文。

    {
  "success": true,
  "message": "AI wrap-up data updated successfully.",
  "segment": {
    "sys_id": "abcd1234abcd1234abcd1234abcd1234",
    "agent": "123412345678567890ab90abcdefcdef",
    "interaction": "213412345678567890ab90abcdefcdef",
    "ai_wrap_up_code": "Plan Update",
    "ai_notes": "Customer requested an upgrade to the Premium plan.",
    "ai_code_defined_at": "1752252703000",
    "ai_notes_defined_at": "1752252703000"
  }
}