最終作業 API

  • リリースバージョン: Yokohama
  • 更新日 2025年02月19日
  • 所要時間：74分

    • Wrap Up API は、外部の Contact Center as a Service (CCaaS) システムまたはNow Platformワークスペースのラップアップ機能を管理するためのエンドポイントを提供します。

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

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

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

    最終作業: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)

    名前 説明
    結果 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 インタラクションと最終作業セグメントに関するデータを含むオブジェクト。

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

    "segment": {
  "agent": "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.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_codes エージェントがラップアップコードを選択する必要があるかどうかを示すフラグ。
    有効な値：
    • true:エージェントはラップアップコードを選択する必要があります。
    • false:エージェントはラップアップコードを選択する必要はありません。

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

    デフォルト値：false
    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
  }
}

    最終作業: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 インタラクションと最終作業セグメントに関するデータを含むオブジェクト。

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

    "segment": {
  "agent": "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.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_codes エージェントがラップアップコードを選択する必要があるかどうかを示すフラグ。
    有効な値：
    • true:エージェントはラップアップコードを選択する必要があります。
    • false:エージェントはラップアップコードを選択する必要はありません。

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

    デフォルト値：false
    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
  }
}

    最終作業: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)

    名前 説明
    結果 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] テーブルで作成されます。

    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]
    構成 外部ラップアップのコードと期間の詳細を含むオブジェクト。externalが true の場合は必須です。

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

    "configuration": {  
   "allowed_codes": [Array], 
   "default_code": "String", 
   "duration": "String", 
   "enable_codes": 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 最大許容最終作業期間。

    データタイプ：文字列

    単位：秒

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

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

    デフォルト値：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 インタラクションと最終作業セグメントに関するデータを含むオブジェクト。

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

    "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 インタラクションセグメントのステータス。最終作業 API が正常に作成されたインタラクションセグメントは、[オープン] ステータスになります。

    データタイプ：文字列
    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/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"agent_sys_id\": \"123412345678567890ab90abcdefcdef\",
  \"interaction_sys_id\": \"213412345678567890ab90abcdefcdef\",
  \"external\": \"true\",
  \"segmented\": \"true\",
  \"segment_table\": \"sn_openframe_phone_log\",
  \"segment_id\": \"dgajbcef12345678defdbxef123435678\",
  \"external_segment_id\": \"PL_402548\",
  \"configuration\": {
    \"enable_codes\": true,
    \"allowed_codes\": [
      {
        \"code\": \"Billing Issue\",
        \"translation\": {
          \"language\": \"de\",
          \"code\": \"Abrechnungsproblem\"
        }
      },
      {
        \"code\": \"Store Issue\",
        \"translation\": {
          \"language\": \"de\",
          \"code\": \"Einkaufsproblem\"
        }
      }
    ],
    \"default_code\": \"Billing Issue\",
    \"duration\": \"30\"
  },
  \"opened_on\": \"2024-09-16 17:52:01\"
}" \
--user 'username':'password'

    応答本文。

    {
  "success": true,
  "message": "Open wrap-up segment successfully created.",
  "sys_id": "98769876543254321fed1fedcba0cba0",
  "segment": {
    "agent": "123412345678567890ab90abcdefcdef",
    "segment_table": "sn_openframe_phone_log",
    "segment_id": "dgajbcef12345678defdbxef123435678",
    "external": true,
    "interaction": "213412345678567890ab90abcdefcdef",
    "state": "open",
    "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": "98769876543254321fed1fedcba0cba0",
    "opened_on": "2024-09-16 17:52:01"
  }
}

    最終作業: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 外部システムに基づく最終作業期間の終了日時。

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

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

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

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