Veakoodid
SMSBAT API-ga suhtlemisel võib tekkida vigu. Kasutame API päringu õnnestumise või ebaõnnestumise näitamiseks tavapäraseid HTTP vastuse koode.
Üldiselt:
- Koodid vahemikus “2xx” näitavad edu.
- Koodid vahemikus „4xx” näitavad viga, mis esitatud teabe tõttu ebaõnnestus (nt nõutav parameeter jäeti välja, sõnumi tüüp on kehtetu jne).
- Koodid vahemikus “5xx” näitavad meie serverite tõrke.
HTTP olekukoodid
| Kood | Olek | Kirjeldus |
|---|---|---|
| 200 | ”OK” | Taotlus õnnestus. |
| 400 | ”Halb taotlus” | Taotlus oli vastuvõetamatu, sageli nõutava parameetri puudumise või valesti vormindatud JSON-i tõttu. |
| 401 | ”Volitamata” | Puudub kehtiv API võti või autentimine ebaõnnestus. |
| 403 | Keelatud | API võtmel pole päringu täitmiseks õigusi või teie konto on peatatud. |
| 404 | ”Ei leitud” | Taotletud ressurssi pole olemas. |
| 415 | Toetamata meediatüüp | Päis „Content-Type” puudub või pole seatud väärtusele „application/json”. |
| 422 | Töötlematu üksus | Taotlus oli õigesti vormindatud, kuid sisaldas semantilisi vigu (nt vale telefoninumbri vorming). |
| 429 | ”Liiga palju taotlusi” | Liiga palju taotlusi jõudis API-le liiga kiiresti. Soovitame teie taotlusi eksponentsiaalselt tagasi lükata. |
| 500, 502, 503, 504 | ”Serveri vead” | Midagi läks SMSBAT-i lõpus valesti. |
Vea vastuse vorming
Kui API päring põhjustab tõrke, sisaldab vastuse keha JSON-objekti, mis sisaldab probleemi kohta rohkem üksikasju.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
Äriloogika veakoodid (sisemised koodid)
Lisaks HTTP olekukoodidele võime tagastada konkreetse sisemise koodi, mis aitab teil tuvastada tõrke täpse põhjuse.
| Sisekood | Kirjeldus | Soovitatav tegevus |
|---|---|---|
| 1001 | Kehtetu päringu vorming | Veenduge, et teie taotluse sisu oleks kehtiv JSON. |
| 1002 | ”Kohustuslik väli puudub” | Kontrollige vastuses atribuuti “sõnum”, et näha, milline väli puudub. |
| 1003 | Vigane telefoninumber | Veenduge, et saaja number oleks vormingus E.164 (nt “380501234567”). |
| 1004 | Registreerimata alfanimi | Parameeter „from” sisaldab alfanime, mis pole teie konto jaoks heaks kiidetud. |
| 1005 | ”Ebapiisav saldo” | Teie kontol ei ole sõnumikampaania töötlemiseks piisavalt raha. |
| 1006 | ”Vigane sõnumi tüüp” | Parameeter „type” peab olema üks toetatud tüüpidest (nt „sms”, „viber_promo”). |
| 1007 | Malli ei leitud | Taotletud Viberi/OTP malli ID on kehtetu või kinnitamata. |
| 1008 | ”Kehtetud karusselliüksused” | Viberi karussell peab sisaldama 2–5 eset. |
[!VIPP] Kui leiate veakoodi, mida siin pole loetletud, või kui arvate, et viga tagastati kogemata, võtke ühendust aadressil [email protected] ja esitage täpne vastuse koormus ja päised.