Kodovi grešaka
Prilikom interakcije s SMSBAT API-jem možete naići na pogreške. Koristimo konvencionalne HTTP kodove odgovora za označavanje uspjeha ili neuspjeha API zahtjeva.
općenito:
- Kodovi u rasponu 2xx označavaju uspjeh.
- Kodovi u rasponu 4xx označavaju pogrešku koja nije uspjela s obzirom na pružene informacije (npr. izostavljen je traženi parametar, vrsta poruke nije valjana itd.).
- Kodovi u rasponu 5xx označavaju pogrešku s našim poslužiteljima.
HTTP statusni kodovi
| Kod | Status | Opis |
|---|---|---|
| 200 | U redu |
Zahtjev je bio uspješan. |
| 400 | Loš zahtjev |
Zahtjev je bio neprihvatljiv, često zbog nedostatka potrebnog parametra ili neispravnog JSON-a. |
| 401 | Neovlašteno |
Nije dostavljen važeći API ključ ili autentifikacija nije uspjela. |
| 403 | Zabranjeno |
API ključ nema dopuštenja za izvođenje zahtjeva ili je vaš račun obustavljen. |
| 404 | Nije pronađeno |
Traženi resurs ne postoji. |
| 415 | Nepodržana vrsta medija |
Zaglavlje "Content-Type" nedostaje ili nije postavljeno na "application/json". |
| 422 | Entitet koji se ne može obraditi |
Zahtjev je bio ispravno oblikovan, ali je sadržavao semantičke pogreške (npr. nevažeći format telefonskog broja). |
| 429 | Previše zahtjeva |
Previše zahtjeva prebrzo dolazi do API-ja. Preporučujemo eksponencijalno odustajanje od vaših zahtjeva. |
| 500, 502, 503, 504 | Pogreške poslužitelja |
Nešto nije u redu na strani SMSBAT-a. |
Format odgovora na pogrešku
Kada API zahtjev rezultira pogreškom, tijelo odgovora sadrži JSON objekt s više pojedinosti o problemu.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
Kodovi grešaka poslovne logike (interni kodovi)
Uz HTTP statusne kodove, možemo vratiti određeni interni kod kako bismo vam pomogli da identificirate točan razlog kvara.
| Interni kod | Opis | Predložena radnja |
|---|---|---|
| 1001 | Nevažeći format zahtjeva |
Provjerite je li tijelo vašeg zahtjeva važeći JSON. |
| 1002 | Nedostaje obavezno polje |
Provjerite svojstvo message u odgovoru da vidite koje polje nedostaje. |
| 1003 | Nevažeći telefonski broj |
Provjerite je li broj primatelja u formatu E.164 (npr. 380501234567). |
| 1004 | Neregistrirano alfa ime |
Parametar `from' sadrži alfa naziv koji nije odobren za vaš račun. |
| 1005 | Nedovoljan saldo |
Vaš račun nema dovoljno sredstava za obradu kampanje slanja poruka. |
| 1006 | Nevažeća vrsta poruke |
Parametar type mora biti jedan od podržanih tipova (npr. sms, viber_promo). |
| 1007 | Predložak nije pronađen |
Traženi ID Viber/OTP predloška je nevažeći ili nije odobren. |
| 1008 | Nevažeći predmeti vrtuljka |
Viber vrtuljak mora sadržavati između 2 i 5 stavki. |
[!SAVJET] Ako naiđete na šifru pogreške koja nije ovdje navedena, ili ako vjerujete da je pogreška vraćena greškom, kontaktirajte [email protected] i navedite točan odgovor i zaglavlja.