Kodovi grešaka
Prilikom interakcije sa SMSBAT API-jem, možete naići na greške. Koristimo konvencionalne HTTP kodove odgovora da označimo uspjeh ili neuspjeh API zahtjeva.
općenito:
- Kodovi u rasponu 2xx ukazuju na uspjeh.
- Kodovi u rasponu 4xx ukazuju na grešku koja nije uspjela s obzirom na date informacije (npr., izostavljen je traženi parametar, tip poruke je nevažeći, itd.).
- Kodovi u rasponu 5xx ukazuju na grešku na našim serverima.
HTTP statusni kodovi
| Šifra | Status | Opis |
|---|---|---|
| 200 | OK |
Zahtjev je 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 dozvole za izvršavanje zahtjeva ili je vaš račun suspendovan. |
| 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 | Neprocesni entitet |
Zahtjev je ispravno formatiran, ali je sadržavao semantičke greške (npr. nevažeći format telefonskog broja). |
| 429 | Previše zahtjeva |
Previše zahtjeva je prebrzo pogodilo API. Preporučujemo eksponencijalno povlačenje vaših zahtjeva. |
| 500, 502, 503, 504 | Greške servera |
Nešto je pošlo po zlu na kraju SMSBAT-a. |
Format odgovora na grešku
Kada API zahtjev rezultira greškom, tijelo odgovora sadrži JSON objekt s više detalja o problemu.
{
"status": 400,
"error": "Bad Request",
"message": "Missing required field: 'messages'",
"code": 1001
}
Kodovi grešaka poslovne logike (interni kodovi)
Pored HTTP statusnih kodova, možemo vratiti određeni interni kod kako bismo vam pomogli da identifikujete tačan razlog neuspjeha.
| Interni kod | Opis | Predložena radnja |
|---|---|---|
| 1001 | Nevažeći format zahtjeva |
Uvjerite se da je 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 broj telefona |
Uvjerite se da je broj primaoca u formatu E.164 (npr. 380501234567). |
| 1004 | Neregistrirano alfa ime |
Parametar from sadrži alfa ime koje nije odobreno za vaš račun. |
| 1005 | Nedovoljna ravnoteža |
Vaš račun nema dovoljno sredstava za obradu kampanje za razmjenu poruka. |
| 1006 | Nevažeća vrsta poruke |
Parametar type mora biti jedan od podržanih tipova (npr. sms, viber_promo). |
| 1007 | Šablon nije pronađen |
Zatraženi ID šablona Viber/OTP je nevažeći ili nije odobren. |
| 1008 | Nevažeći predmeti vrteške |
Viber vrtuljak mora sadržavati između 2 i 5 stavki. |
[!SAVJET] Ako naiđete na kod greške koji nije ovdje naveden, ili ako vjerujete da je greška vraćena greškom, kontaktirajte [email protected] i navedite tačan teret odgovora i zaglavlja.