HTTPステータスコード
このドキュメントは、MTPush REST APIのHTTP戻りコード仕様を定義しています。
新しいバージョンのMTPush Push API v4はこの仕様に準拠しています。
ステータスコードの定義
| コード | 説明 | 詳細 |
|---|---|---|
| 200 | OK | 成功しました！ |
| 400 | Bad request（不正なリクエスト） | リクエストが無効です。対応する説明で理由が説明されます。 |
| 401 | Not verified（認証されていません） | 認証情報がないか、認証に失敗しました |
| 403 | Rejected（拒否されました） | リクエストは理解されましたが、受け入れられませんでした。対応する説明で理由が説明されます。 |
| 404 | Not found（見つかりません） | リソースが存在しない、リクエストされたユーザーが存在しない、リクエストされた形式がサポートされていません。 |
| 405 | The request method is inappropriate（リクエストメソッドが適切ではありません） | インターフェースはこのメソッドのリクエストをサポートしていません。 |
| 410 | Offline（オフライン） | リクエストされたリソースはオフラインです。関連する告知を参照してください。 |
| 429 | Too many requests（リクエストが多すぎます） | リクエストが頻度制限を超えました。対応する説明で具体的な理由が説明されます。 |
| 500 | Internal service error（内部サービスエラー） | サーバーに内部エラーが発生しました。可能な限り早く我們に連絡して問題を解決してください。 |
| 502 | Invalid proxy（無効なプロキシ） | サービスサーバーがオフラインまたはアップグレード中です。後で再試行してください。 |
| 503 | Temporary service failure（一時的なサービス障害） | サーバーがリクエストに応答できませんでした。後で再試行してください。 |
| 504 | Agent timeout（エージェントタイムアウト） | サーバーは実行中ですが、リクエストに応答できませんでした。後で再試行してください。 |
遵守すべき仕様
- 200は必ず正しい場合に使用してください。すべての例外に200の戻りコードを使用しないでください。
- ビジネスロジックエラーの場合は、可能な限り4xxの特別なエラーコードを使用してください。そうでない場合は400を使用してください。
- サーバーの内部エラーで、特別なエラーコードがない場合は500を
