--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Interaction Management API # Interaction Management API {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：11分 Interaction Management API は、インタラクションを作成するためのエンドポイントを提供します。このクラスには Interaction Logging, Routing, and Queueing プラグイン (com.glide.interaction) が必要です。 ## インタラクション - POST /now/interaction {#ariaid-title2} インタラクションテーブルのレコードを挿入または更新します。 ### URL 形式 {#interaction-POST__section_msq_nfz_cmb} バージョニングされた URL：/api/now/{api_version}/interaction デフォルトの URL：/api/now/interaction ### サポートされている要求パラメーター {#interaction-POST__entry__2}{#interaction-POST__version-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | [表 : 1. パスパラメーター] {#interaction-POST__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 2. クエリパラメーター] {#interaction-POST__entry__10} | 要素 | 説明 | |-|-| | channel | 必須です。インタラクションを作成するインタラクションコネクタの sys_id。データタイプ：文字列 | | context | マップまたはテーブル/sys_id のペア。デフォルトでは、インタラクションのレコードは、コンテキストデータを JSON オブジェクトとして保存する interaction_json_blob テーブルにあります。インタラクションがコンテキストの別のレコードを指すようにできます。context または context_table/context_id を使用して、インタラクションのコンテキストを定義します。データタイプ：文字列 | | context_id | コンテキストを保存するために使用するレコードのドキュメント ID。デフォルトは insteraction_json_blob テーブルの新しいレコードです。コンテキスト ID を定義する場合は、テーブルも定義する必要があります。データタイプ：文字列 | | context_table | インタラクションコンテキストを保存するために使用するコンテキストテーブル。デフォルトは interaction_json_blob です。コンテキストテーブルを定義する場合は、コンテキスト ID も定義する必要があります。データタイプ：文字列 | | channel_metadata | マップまたはテーブル/sys_id のペア。チャネルメタデータには、コネクタが関連するチャネルを介した通信に使用できる情報が含まれています。データタイプ：文字列 | | channel_metadata_id | チャネルメタデータを保存するために使用するレコードのドキュメント ID。デフォルトは live_group_profile テーブルの新しいレコードです。チャネルメタデータ ID を定義する場合は、テーブルも定義する必要があります。データタイプ：文字列 | | channel_metadata_table | チャネルメタデータを保存するために使用するテーブル。デフォルトは live_group_profile テーブルです。チャネルメタデータテーブルを定義する場合は、チャネルメタデータ ID も定義する必要があります。データタイプ：文字列 | | queue | インタラクションに関連付けるキューの sys_id。データタイプ：文字列 | [表 : 3. 要求本文パラメーター (XML または JSON)] ### ヘッダー次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#interaction-POST__entry__28}{#interaction-POST__accept-RESTAPI}{#interaction-POST__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 4. 要求ヘッダー] {#interaction-POST__entry__34} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#interaction-POST__entry__38}{#interaction-POST__entry-401-status-code}{#interaction-POST__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 201 | クエリが正常に実行されたことを示します。 | | 400 | 1 つ以上の必須パラメーターが要求になかったことを示します。 | | 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#interaction-POST__table_bsj_y3z_cmb__entry__2} | 要素 | 説明 | |-|-| | assigned_to | インタラクションがアサインされているユーザーの sys_id。データタイプ：文字列 | | channelMetadataDocument | インタラクションに関連付けられたチャネルメタデータドキュメントの sys_id。データタイプ：文字列 | | channelMetadataTable | インタラクションに関連付けられたチャネルメタデータテーブルのテーブル名。データタイプ：文字列 | | channel_metadata | インタラクションに含まれる任意のチャネルメタデータ。データタイプ：文字列 | | closed_by | インタラクションをクローズしたユーザーの sys_id。データタイプ：文字列 | | contextDocument | インタラクションに関連付けられたコンテキストドキュメントの sys_id。データタイプ：文字列 | | contextTable | インタラクションに関連付けられたテーブルの名前。データタイプ：文字列 | | number | 新しいインタラクションの番号。データタイプ：文字列 | | opened_for | インタラクションをオープンした対象のユーザーの sys_id。データタイプ：文字列 | | キュー | インタラクションを作成する対象のキューの sys_id。データタイプ：文字列 | | state | インタラクションのステータス。キューをアサインすると、ステータスは自動的に \[キューに格納\] に変わります。それ以外の場合は、デフォルトは \[新規\] になります。データタイプ：文字列 | | sys_id | インタラクションの sys_id。データタイプ：文字列 | [ ] {#interaction-POST__table_bsj_y3z_cmb} ### サンプル cURL 要求 curl "http://instance.servicenow.com/api/now/interaction" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --data "{\"channel\":\"28a59893873103002ae97e2526cb0b5d\",\"queue\":\"f3a50867b30303002186a72256a8dcb7\"}" \ --user "username":"password" { "result": { "channel": "28a59893873103002ae97e2526cb0b5d", "context": { "present": true }, "queue": "f3a50867b30303002186a72256a8dcb7", "state": "queued", "number": "IMS0000075", "contextDocument": "1863a6f0d9471300964f387107a8a36d", "contextTable": "interaction_json_blob", "channelMetadataDocument": "9463a6f0d9471300964f387107a8a36c", "channelMetadataTable": "live_group_profile", "channel_metadata": { "present": true }, "sys_id": "dc63a6f0d9471300964f387107a8a36b", "assigned_to": "", "closed_by": "", "opened_for": "" } } ## インタラクション - POST /now/interaction/{interaction_id}/close {#ariaid-title3} インタラクションのステータスを、クローズ済み、または完了してクローズに変更します。 ### URL 形式 {#interaction-POST-close__section_qhp_23z_cmb} バージョニングされた URL：/api/now/{api_version}interaction/{interaction_id}/close デフォルトの URL：/api/now/interaction/{interaction_id}/close ### サポートされている要求パラメーター {#interaction-POST-close__entry__2}{#interaction-POST-close__version-RESTAPI} | 名前 | 説明 | |-|-| | api_version | オプションアクセスするエンドポイントのバージョン。たとえば、v1 や v2。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。データタイプ：文字列 | | interaction_id | クローズするインタラクションの sys_id。データタイプ：文字列 | [表 : 7. パスパラメーター] {#interaction-POST-close__entry__8} | 名前 | 説明 | |-|-| | なし | | [表 : 8. クエリパラメーター] {#interaction-POST-close__entry__12} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文パラメーター (XML または JSON)] ### ヘッダー次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#interaction-POST-close__entry__16}{#interaction-POST-close__accept-RESTAPI}{#interaction-POST-close__content_type-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | | Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。デフォルト： application/json | [表 : 10. 要求ヘッダー] {#interaction-POST-close__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 応答ヘッダー] ### ステータスコードこの HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#interaction-POST-close__entry__26}{#interaction-POST-close__entry-200-status-code}{#interaction-POST-close__entry-401-status-code}{#interaction-POST-close__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 12. ステータスコード] ### 応答本文のパラメーター (JSON または XML) {#interaction-POST-close__table_ykz_y3z_cmb__entry__2} | 要素 | 説明 | |-|-| | assigned_to | インタラクションがアサインされているユーザーの sys_id。データタイプ：文字列 | | channelMetadataDocument | インタラクションに関連付けられたチャネルメタデータドキュメントの sys_id。データタイプ：文字列 | | channelMetadataTable | インタラクションに関連付けられたチャネルメタデータテーブルのテーブル名。データタイプ：文字列 | | channel_metadata | インタラクションに含まれる任意のチャネルメタデータ。データタイプ：文字列 | | closed_by | インタラクションをクローズしたユーザーの sys_id。データタイプ：文字列 | | contextDocument | インタラクションに関連付けられたコンテキストドキュメントの sys_id。データタイプ：文字列 | | contextTable | インタラクションに関連付けられたテーブルの名前。データタイプ：文字列 | | number | 新しいインタラクションの番号。データタイプ：文字列 | | opened_for | インタラクションをオープンした対象のユーザーの sys_id。データタイプ：文字列 | | キュー | インタラクションを作成する対象のキューの sys_id。データタイプ：文字列 | | state | インタラクションのステータス。キューをアサインすると、ステータスは自動的に \[キューに格納\] に変わります。それ以外の場合は、デフォルトは \[新規\] になります。データタイプ：文字列 | | sys_id | インタラクションの sys_id。データタイプ：文字列 | [ ] {#interaction-POST-close__table_ykz_y3z_cmb} ### サンプル cURL 要求 curl "http://instance.servicenow.com/api/now/interaction/b243cde4208f1700964f959e0488dee8/close" \ --request POST \ --header "Accept:application/json" \ --header "Content-Type:application/json" \ --user "username":"password" { "result": { "channel": "28a59893873103002ae97e2526cb0b5d", "context": { "present": true }, "queue": "f3a50867b30303002186a72256a8dcb7", "state": "closed_complete", "number": "IMS0000060", "contextDocument": "3a43cde4208f1700964f959e0488dee7", "contextTable": "interaction_json_blob", "channelMetadataDocument": "fa43cde4208f1700964f959e0488dee8", "channelMetadataTable": "live_group_profile", "channel_metadata": { "present": true }, "sys_id": "b243cde4208f1700964f959e0488dee8", "assigned_to": "", "closed_by": "6816f79cc0a8016401c5a33be04be441", "opened_for": "46d44a23a9fe19810012d100cca80666" } }