Hibakódok

Az SMSBAT API-val való interakció során hibák léphetnek fel. Hagyományos HTTP-válaszkódokat használunk az API-kérés sikerének vagy sikertelenségének jelzésére.

Általánosságban:

• A “2xx” tartományba eső kódok a sikert jelzik.
• A „4xx” tartományban lévő kódok olyan hibát jeleznek, amely a megadott információk alapján sikertelen volt (pl. egy kötelező paraméter kimaradt, az üzenettípus érvénytelen stb.).
• Az „5xx” tartományba eső kódok hibára utalnak szervereinknél.

HTTP állapotkódok

Kód	Állapot	Leírás
200	”OK”	A kérés sikeres volt.
400	Rossz kérés	A kérés elfogadhatatlan volt, gyakran azért, mert hiányzott egy szükséges paraméter, vagy rosszul formázott JSON.
401	”Jogosulatlan”	Nincs érvényes API-kulcs, vagy a hitelesítés sikertelen.
403	”Tiltott”	Az API-kulcsnak nincs engedélye a kérés végrehajtására, vagy fiókja fel van függesztve.
404	”Nem található”	A kért erőforrás nem létezik.
415	Nem támogatott médiatípus	A „Content-Type” fejléc hiányzik, vagy nincs beállítva „application/json”-ra.
422	Feldolgozhatatlan entitás	A kérés formátuma helyes volt, de szemantikai hibákat tartalmazott (pl. érvénytelen telefonszám-formátum).
429	Túl sok kérés	Túl sok kérés érkezett túl gyorsan az API-hoz. Javasoljuk a kérések exponenciális visszaszorítását.
500, 502, 503, 504	Szerverhibák	Valami hiba történt az SMSBAT végén.

Hibaválasz formátuma

Ha egy API-kérés hibát eredményez, a válasz törzse egy JSON-objektumot tartalmaz a probléma további részleteivel.

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

Üzleti logikai hibakódok (belső kódok)

A HTTP-állapotkódokon kívül egy adott belső “kódot” is visszaadhatunk, amely segít azonosítani a hiba pontos okát.

| Belső kód | Leírás | Javasolt intézkedés | |---------------|----------------------------------| | 1001 | Érvénytelen kérésformátum | Győződjön meg arról, hogy a kérelem törzse érvényes JSON. | | 1002 | “Hiányzó kötelező mező” | Ellenőrizze az “üzenet” tulajdonságot a válaszban, hogy megtudja, melyik mező hiányzik. | | 1003 | Érvénytelen telefonszám | Győződjön meg arról, hogy a címzett száma E.164 formátumban van (pl. “380501234567”). | | 1004 | Nem regisztrált alfa név| A “from” paraméter olyan alfa nevet tartalmaz, amelyet nem hagytak jóvá az Ön fiókjában. | | 1005 | “Elégtelen egyenleg” | Fiókjában nincs elég pénz az üzenetküldő kampány feldolgozásához. | | 1006 | Érvénytelen üzenettípus | A “type” paraméternek a támogatott típusok egyikének kell lennie (pl. “sms”, “viber_promo”). | | 1007 | Sablon nem található | A kért Viber/OTP sablonazonosító érvénytelen vagy nincs jóváhagyva. | | 1008 | Érvénytelen Carousel Items | A Viber Carouselnek 2–5 elemet kell tartalmaznia. |

[!TIPP] Ha olyan hibakódot talál, amely nem szerepel itt, vagy ha úgy gondolja, hogy egy hiba tévedésből adódott vissza, kérjük, lépjen kapcsolatba a [email protected] címmel, és adja meg a pontos válasz terhelhetőségét és fejléceit.