Mga Error Code
Kapag nakikipag-ugnayan sa SMSBAT API, maaari kang makatagpo ng mga error. Gumagamit kami ng mga kumbensyonal na HTTP response code upang isaad ang tagumpay o pagkabigo ng isang kahilingan sa API.
Sa pangkalahatan:
- Ang mga code sa hanay ng 2xx ay nagpapahiwatig ng tagumpay.
- Ang mga code sa hanay na 4xx ay nagpapahiwatig ng error na nabigo sa ibinigay na impormasyon (hal., isang kinakailangang parameter ang tinanggal, isang uri ng mensahe ay hindi wasto, atbp.).
- Ang mga code sa hanay na 5xx ay nagpapahiwatig ng isang error sa aming mga server.
Mga Code ng Katayuan ng HTTP
| Code | Katayuan | Paglalarawan |
|---|---|---|
| 200 | OK |
Ang kahilingan ay matagumpay. |
| 400 | Masamang Kahilingan |
Ang kahilingan ay hindi katanggap-tanggap, kadalasan dahil sa nawawalang kinakailangang parameter o mali ang pagkakabuo ng JSON. |
| 401 | Hindi awtorisado |
Walang ibinigay na valid na API key, o nabigo ang pagpapatotoo. |
| 403 | Bawal |
Ang API key ay walang mga pahintulot upang isagawa ang kahilingan, o ang iyong account ay nasuspinde. |
| 404 | Hindi Natagpuan |
Ang hiniling na mapagkukunan ay wala. |
| 415 | Hindi Sinusuportahang Uri ng Media |
Ang header na Uri-Nilalaman ay nawawala o hindi nakatakda sa application/json. |
| 422 | Hindi Maprosesong Entity |
Na-format nang tama ang kahilingan ngunit naglalaman ng mga semantic error (hal., di-wastong format ng numero ng telepono). |
| 429 | Masyadong Maraming Kahilingan |
Masyadong maraming kahilingan ang tumama sa API nang napakabilis. Inirerekomenda namin ang isang exponential backoff ng iyong mga kahilingan. |
| 500, 502, 503, 504 | Mga Error sa Server |
Nagkaproblema sa pagtatapos ng SMSBAT. |
Format ng Pagtugon ng Error
Kapag nagresulta sa error ang isang kahilingan sa API, naglalaman ang body ng tugon ng JSON object na may higit pang mga detalye tungkol sa problema.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
Business Logic Error Codes (Internal Codes)
Bilang karagdagan sa mga HTTP status code, maaari kaming magbalik ng isang partikular na panloob na code upang matulungan kang matukoy ang eksaktong dahilan ng pagkabigo.
| Panloob na Code | Paglalarawan | Iminungkahing Pagkilos |
|---|---|---|
| 1001 | Di-wastong Format ng Kahilingan |
Tiyaking wastong JSON ang laman ng iyong kahilingan. |
| 1002 | Nawawalang Kinakailangang Field |
Tingnan ang property na message sa tugon upang makita kung aling field ang nawawala. |
| 1003 | Di-wastong Numero ng Telepono |
Tiyaking nasa E.164 na format ang numero ng tatanggap (hal., 380501234567). |
| 1004 | Hindi Nakarehistrong Alpha Name |
Ang parameter na from ay naglalaman ng alpha name na hindi pa naaprubahan para sa iyong account. |
| 1005 | Hindi Sapat na Balanse |
Walang sapat na pondo ang iyong account upang iproseso ang kampanya sa pagmemensahe. |
| 1006 | Di-wastong Uri ng Mensahe |
Ang parameter na type ay dapat isa sa mga sinusuportahang uri (hal., sms, viber_promo). |
| 1007 | Hindi Nahanap ang Template |
Ang hiniling na Viber/OTP template ID ay hindi wasto o hindi naaprubahan. |
| 1008 | Mga Di-wastong Carousel Item |
Dapat maglaman ang isang Viber Carousel sa pagitan ng 2 at 5 item. |
[!TIP] Kung nakatagpo ka ng error code na hindi nakalista dito, o kung naniniwala kang may error na naibalik nang hindi sinasadya, mangyaring makipag-ugnayan sa [email protected] at ibigay ang eksaktong sagot na payload at mga header.