ヘルプ要求 API
ヘルプ要求 API は、上司のヘルプアクションを追跡するためのエンドポイントを提供します。
この API は、ヘルプの開始時間と終了時間、ヘルプのタイプなど、インタラクションに取り組んでいるエージェントのスーパーバイザーのヘルプを記録します。ヘルプ要求の詳細については、「 Agent help request for voice calls」を参照してください。
この API には、インタラクション管理プラグイン (com.glide.interaction) が必要です。呼び出し元ユーザーにはinteraction_integration_userロールが必要です。
ヘルプ要求:POST /now/helprequest/action/create_or_update
上司のヘルプアクションを作成または更新します。
スーパーバイザーがインタラクションヘルプ要求を受け入れたときに、このエンドポイントを呼び出します。ヘルプを追跡するレコードが上司のヘルプアクション [supervisor_help_action] テーブルに作成されます。スーパーバイザーがヘルプを完了したら、このエンドポイントを再度呼び出して、ヘルプアクションレコードを終了時間で更新します。
URL 形式
バージョニングされた URL: /api/now/{api_version}/helprequest/action/create_or_update
デフォルト URL: /api/now/helprequest/action/create_or_update
サポートされている要求パラメーター
| 名前 | 説明 |
|---|---|
| api_version | オプション。アクセスするエンドポイントのバージョン。たとえば、 v1 や v2 などです。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| 名前 | 説明 |
|---|---|
| なし |
| 名前 | 説明 |
|---|---|
| action | スーパーバイザーによって提供される支援のタイプ。上司のヘルプアクションを作成するときに必要です。 有効な値 (大文字と小文字を区別):
上司のアクションの詳細については、「 Monitoring calls」を参照してください。 データタイプ：文字列 |
| action_sys_id | 上司のヘルプアクションのSys_id。 指定された単一の上司のヘルプアクションを更新するときに必要ですが、インタラクションのすべての上司のヘルプアクションを一括更新する場合は除外できます。 テーブル:上司のヘルプアクション [supervisor_help_action] データタイプ：文字列 |
| end_time | 上司が支援を終了した日時。 注: 指定された単一の上司ヘルプアクションを終了時間で更新するには、このパラメーターに有効な値を指定する必要があります。ただし、インタラクションのすべての上司ヘルプアクションを一括更新する場合、このパラメーターを除外すると、現在の時刻が終了時刻として設定されます。 データタイプ：文字列 |
| help_request | インタラクションヘルプ要求のSys_id。 テーブル:インタラクションヘルプ要求 [interaction_help_request] データタイプ：文字列 |
| インタラクション | 必須です。インタラクションのSys_id。 テーブル:インタラクション [interaction] データタイプ：文字列 |
| start_time | スーパーバイザーが支援を開始した日時。 デフォルト:上司のヘルプアクションレコードの作成日時。 データタイプ：文字列 |
ヘッダー
次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。
| ヘッダー | 説明 |
|---|---|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
| Content-Type | 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
| ヘッダー | 説明 |
|---|---|
| なし |
ステータスコード
この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。
| ステータスコード | 説明 |
|---|---|
| 200 | 成功。要求が正常に処理されました。 |
| 400 | 要求が正しくありません。不適切な要求タイプまたは誤った要求が検出されました。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 404 | 見つかりません。要求されたアイテムが見つかりませんでした。 |
応答本文のパラメーター (JSON または XML)
| 名前 | 説明 |
|---|---|
| result | API 要求の結果に関する詳細。 データタイプ: オブジェクト |
| result.action_sys_id | 作成または更新された上司のヘルプアクションのSys_id。 テーブル:上司のヘルプアクション [supervisor_help_action] データタイプ：文字列 |
| result.message | API 要求の成功または失敗に関する詳細を含むメッセージ。 データタイプ：文字列 |
| result.success | API 要求が成功したかどうかを示すフラグ。 可能な値：
データタイプ：ブーリアン |
cURL 要求
この例では、上司のヘルプアクションを作成します。
curl "https://instance.service-now.com/api/now/helprequest/action/create_or_update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"interaction\": \"d4dec70f3b4bfe101baa9f7e53e45a5d\",
\"action\": \"coach\"
}" \
--user 'username':'password'応答本文。
{
"result": {
"success": true,
"message": "Supervisor help action created successfully",
"action_sys_id": "d25f034f3b4bfe101baa9f7e53e45a9f"
}
}cURL 要求
この例では、上司のヘルプアクションを終了時間で更新します。
curl "https://instance.service-now.com/api/now/helprequest/action/create_or_update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"interaction\": \"d4dec70f3b4bfe101baa9f7e53e45a5d\",
\"action_sys_id\": \"d25f034f3b4bfe101baa9f7e53e45a9f\",
\"end_time\": \"2026-02-18 11:30:00\"
}" \
--user 'username':'password'応答本文。
{
"result": {
"success": true,
"message": "Supervisor help action updated successfully",
"action_sys_id": "d25f034f3b4bfe101baa9f7e53e45a9f"
}
}cURL 要求
この例では、インタラクションのすべての上司のヘルプアクションを終了時間とともに更新します。
curl "https://instance.service-now.com/api/now/helprequest/action/create_or_update" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"interaction\": \"cd87db433bcbfe101baa9f7e53e45a4d\",
\"end_time\": \"2026-02-18 11:24:18\"
}" \
--user 'username':'password'応答本文。
{
"result": {
"success": true,
"message": "end_time updated for all supervisor help actions associated with the interaction id: cd87db433bcbfe101baa9f7e53e45a4d"
}
}