AppPush
WebPush
WhatsApp
Email
SMS
OTP
HTTP 狀態碼
最新更新：2022-12-01
本文檔定義 MTPush REST API 的 HTTP 返回碼規範。
MTPush Push API v4 新版本 API 滿足此規範。
狀態碼定義
| Code | 描述 | 詳細解釋 |
|---|---|---|
| 200 | OK | Success! |
| 400 | 錯誤的請求 | 該請求是無效的。相應的描述信息會說明原因。 |
| 401 | 未驗證 | 冇有驗證信息或者驗證失敗 |
| 403 | 被拒絕 | 理解該請求，但不被接受。相應的描述信息會說明原因。 |
| 404 | 無法找到 | 資源不存在，請求的用戶的不存在，請求的格式不被支持。 |
| 405 | 請求方法不合適 | 該接口不支持該方法的請求。 |
| 410 | 已下線 | 請求的資源已下線。請參考相關公告。 |
| 429 | 過多的請求 | 請求超出了頻率限製。相應的描述信息會解釋具體的原因。 |
| 500 | 內部服務錯誤 | 服務器內部出錯了。請聯係我們盡快解決問題。 |
| 502 | 無效代理 | 業務服務器下線了或者正在升級。請稍後重試。 |
| 503 | 服務暫時失效 | 服務器無法回響請求。請稍後重試。 |
| 504 | 代理超時 | 服務器在運行，但是無法回響請求。請稍後重試。 |
遵守的規範
- 200 一定是正確。所有異常都不使用 200 返回碼
- 業務邏輯上的錯誤，有特別的錯誤碼盡量使用 4xx，否則使用 400。
- 服務器端內部錯誤，無特別錯誤碼使用 500。
- 業務異常時，返回內容使用 JSON 格式定義 error 信息。
