Skip to main content

HTTP ステータスコード

API は標準的な HTTP ステータスコードを使用します。AIヘルプデスク API はリードオンリーのため、2xx 系では 200 のみを返します。

エラーレスポンス形式

エラーが発生した場合、API は以下の形式の JSON レスポンスを返します。

レスポンスフィールド

一般的なエラー

認証エラー (401)

原因: X-API-Key ヘッダーが設定されていない、または値が無効。

リソース未存在 (404)

原因: パスパラメータ(sessionKeydocIdtypePathintegrationId など)が存在しないか、別テナントに属している。

パラメータエラー (400)

原因: statusassigneeType などの enum パラメータに範囲外の値を指定した、limit1..100(procedures は 1..500)の範囲外、など。

エラー処理のベストプラクティス

  1. レスポンスは必ず ok フィールドの真偽で成否を判定する
  2. error メッセージはログに記録し、ユーザーへは内容に応じて適切に翻訳して表示する
  3. 401 はキー再発行が必要なため、自動リトライではなく運用者に通知する
  4. 404 は呼び出し側のロジックの問題なので、自動リトライしない
  5. センシティブな情報(API キー全体など)をエラーメッセージのログへ含めないようにする
最終更新日 2026年7月17日