Soracom

Users

開発者向けツール

エラーメッセージのフォーマット

SORACOM の API は、エラー発生の際には基本的に統一的なフォーマットに則ってエラーメッセージを返すようになっています。一部、API サーバーに入る前のロードバランサーなどの部分が返すエラーメッセージを除きます。

SORACOM API が返すメッセージは JSON 形式で以下のような構成になっています。

{
  "code": "ABC1234",
  "message": "Description of the error"
}

code はこのエラーに割り当てられた識別コードで、message はエンドユーザーに提示するためのエラーメッセージです。

API 呼び出しリクエストのヘッダーに X-Soracom-Lang: を含めると、その言語コードに対応している場合はエラーメッセージもその言語になります。(未対応の言語に対しては英語にフォールバックします)

現在対応している言語は en (英語) と ja (日本語) の 2 つです。

サポート窓口への問い合わせの時は、事象の詳細と合わせて、エラーメッセージをご連絡いただくと問題解決に役立つ場合があります。