Kódy chýb
Pri interakcii s SMSBAT API sa môžu vyskytnúť chyby. Na označenie úspechu alebo zlyhania požiadavky API používame konvenčné kódy odpovede HTTP.
Vo všeobecnosti:
- Kódy v rozsahu „2xx“ označujú úspech.
- Kódy v rozsahu „4xx“ označujú chybu, ktorá zlyhala na základe poskytnutých informácií (napr. bol vynechaný požadovaný parameter, typ správy je neplatný atď.).
- Kódy v rozsahu „5xx“ označujú chybu našich serverov.
Stavové kódy HTTP
| Kód | Stav | Popis |
|---|---|---|
| 200 | ”OK” | Žiadosť bola úspešná. |
| 400 | ”Zlá požiadavka” | Požiadavka bola neprijateľná, často kvôli chýbajúcemu požadovanému parametru alebo nesprávnemu formátu JSON. |
| 401 | ”Neoprávnené” | Nebol poskytnutý žiadny platný kľúč API alebo overenie zlyhalo. |
| 403 | ”Zakázané” | Kľúč API nemá povolenia na vykonanie požiadavky alebo je váš účet pozastavený. |
| 404 | ”Nenájdené” | Požadovaný zdroj neexistuje. |
| 415 | Nepodporovaný typ média | Hlavička „Content-Type“ chýba alebo nie je nastavená na „application/json“. |
| 422 | Nespracovateľná entita | Požiadavka bola naformátovaná správne, ale obsahovala sémantické chyby (napr. neplatný formát telefónneho čísla). |
| 429 | ”Príliš veľa žiadostí” | Príliš veľa požiadaviek zasiahlo API príliš rýchlo. Odporúčame vám exponenciálne ustúpiť od vašich požiadaviek. |
| 500, 502, 503, 504 | ”Chyby servera” | Na konci SMSBAT sa niečo pokazilo. |
Formát odpovede na chybu
Keď je výsledkom požiadavky API chyba, telo odpovede obsahuje objekt JSON s ďalšími podrobnosťami o probléme.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
Chybové kódy obchodnej logiky (interné kódy)
Okrem stavových kódov HTTP môžeme vrátiť aj špecifický interný „kód“, ktorý vám pomôže identifikovať presný dôvod zlyhania.
| Interný kód | Popis | Navrhovaná akcia |
|---|---|---|
| 1001 | ”Neplatný formát požiadavky” | Uistite sa, že telo vašej požiadavky je platné JSON. |
| 1002 | ”Chýba povinné pole” | Skontrolujte vlastnosť „správa“ v odpovedi a zistite, ktoré pole chýba. |
| 1003 | ”Neplatné telefónne číslo” | Uistite sa, že číslo príjemcu je vo formáte E.164 (napr. „380501234567“). |
| 1004 | Neregistrovaný názov alfa | Parameter „from“ obsahuje názov alfa, ktorý nebol schválený pre váš účet. |
| 1005 | ”Nedostatočný zostatok” | Váš účet nemá dostatok finančných prostriedkov na spracovanie kampane. |
| 1006 | ”Neplatný typ správy” | Parameter „type“ musí byť jedným z podporovaných typov (napr. „sms“, „viber_promo“). |
| 1007 | ”Šablóna sa nenašla” | Požadované ID šablóny Viber/OTP je neplatné alebo nie je schválené. |
| 1008 | ”Neplatné položky karuselu” | Viber Carousel musí obsahovať 2 až 5 položiek. |
[!TIP] Ak narazíte na chybový kód, ktorý tu nie je uvedený, alebo ak sa domnievate, že chyba bola vrátená omylom, kontaktujte [email protected] a uveďte presný obsah odpovede a hlavičky.