Kode napak

Pri interakciji z API-jem SMSBAT lahko naletite na napake. Za označevanje uspeha ali neuspeha zahteve API uporabljamo običajne odzivne kode HTTP.

Na splošno: - Kode v območju 2xx pomenijo uspeh. - Kode v območju 4xx označujejo napako, ki ni uspela glede na posredovane informacije (npr. zahtevani parameter je bil izpuščen, vrsta sporočila ni veljavna itd.). - Kode v območju 5xx označujejo napako z našimi strežniki.

Statusne kode HTTP

Koda	Stanje	Opis
200	V redu	Zahteva je bila uspešna.
400	Slaba zahteva	Zahteva je bila nesprejemljiva, pogosto zaradi manjkajočega zahtevanega parametra ali napačno oblikovanega JSON-a.
401	Nepooblaščeno	Podan ni veljaven ključ API ali pa preverjanje pristnosti ni uspelo.
403	Prepovedano	Ključ API nima dovoljenj za izvedbo zahteve ali pa je vaš račun začasno blokiran.
404	Ni najdeno	Zahtevani vir ne obstaja.
415	Nepodprta vrsta medija	Glava »Content-Type« manjka ali pa ni nastavljena na »application/json«.
422	Neobdelana entiteta	Zahteva je bila pravilno oblikovana, vendar je vsebovala semantične napake (npr. neveljavna oblika telefonske številke).
429	Preveč zahtev	Preveč zahtev prehitro doseže API. Priporočamo eksponentno odlaganje vaših zahtev.
500, 502, 503, 504	Napake strežnika	Pri SMSBAT-u je šlo nekaj narobe.

Oblika odziva na napako

Ko zahteva API povzroči napako, telo odgovora vsebuje objekt JSON z več podrobnostmi o težavi.

{
  "status": 400,
  "error": "Bad Request",
  "message": "Missing required field: 'messages'",
  "code": 1001
}

Kode napak poslovne logike (notranje kode)

Poleg statusnih kod HTTP lahko vrnemo posebno notranjo kodo, ki vam pomaga ugotoviti točen razlog za napako.

Notranja koda	Opis	Predlagani ukrep
1001	Neveljavna oblika zahteve	Zagotovite, da je telo vaše zahteve veljaven JSON.
1002	Manjkajoče obvezno polje	Preverite lastnost message v odgovoru, da vidite, katero polje manjka.
1003	Neveljavna telefonska številka	Prepričajte se, da je številka prejemnika v formatu E.164 (npr. »380501234567«).
1004	Neregistrirano alfa ime	Parameter `from' vsebuje ime alfa, ki ni bilo odobreno za vaš račun.
1005	Nezadostno stanje	Vaš račun nima dovolj sredstev za obdelavo sporočilne kampanje.
1006	Neveljavna vrsta sporočila	Parameter type mora biti eden od podprtih vrst (npr. sms, viber_promo).
1007	Predloge ni bilo mogoče najti	Zahtevani ID predloge Viber/OTP je neveljaven ali ni odobren.
1008	Neveljavni elementi vrtiljaka	Viber Carousel mora vsebovati od 2 do 5 elementov.

[!TIP] Če naletite na kodo napake, ki ni navedena tukaj, ali če menite, da je bila napaka vrnjena pomotoma, se obrnite na [email protected] in navedite točen odziv in glave.