Kódy chyb

Při interakci s SMSBAT API se můžete setkat s chybami. K označení úspěchu nebo selhání požadavku API používáme konvenční kódy odezvy HTTP.

Obecně:

• Kódy v rozsahu 2xx označují úspěch.
• Kódy v rozsahu 4xx označují chybu, která selhala na základě poskytnutých informací (např. byl vynechán požadovaný parametr, typ zprávy je neplatný atd.).
• Kódy v rozsahu 5xx označují chybu našich serverů.

Stavové kódy HTTP

Kód	Stav	Popis
200	”OK”	Žádost byla úspěšná.
400	”Špatný požadavek”	Požadavek byl nepřijatelný, často kvůli chybějícímu požadovanému parametru nebo chybnému formátu JSON.
401	”Neoprávněné”	Nebyl poskytnut žádný platný klíč API nebo ověření selhalo.
403	”Zakázáno”	Klíč API nemá oprávnění k provedení požadavku nebo je váš účet pozastaven.
404	”Nenalezeno”	Požadovaný zdroj neexistuje.
415	Nepodporovaný typ média	Záhlaví Content-Type chybí nebo není nastaveno na application/json.
422	Nezpracovatelná entita	Požadavek byl správně naformátován, ale obsahoval sémantické chyby (např. neplatný formát telefonního čísla).
429	”Příliš mnoho požadavků”	Příliš mnoho požadavků zasáhlo rozhraní API příliš rychle. Doporučujeme exponenciální ústup vašich požadavků.
500, 502, 503, 504	Chyby serveru	Na konci SMSBAT se něco pokazilo.

Formát odpovědi na chybu

Když požadavek API vyústí v chybu, tělo odpovědi obsahuje objekt JSON s dalšími podrobnostmi o problému.

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

Chybové kódy obchodní logiky (interní kódy)

Kromě stavových kódů HTTP můžeme vrátit specifický interní „kód“, který vám pomůže identifikovat přesný důvod selhání.

Interní kód	Popis	Navrhovaná akce
1001	Neplatný formát požadavku	Ujistěte se, že je tělo vašeho požadavku platné JSON.
1002	”Chybí povinné pole”	Zkontrolujte vlastnost message v odpovědi a zjistěte, které pole chybí.
1003	”Neplatné telefonní číslo”	Ujistěte se, že číslo příjemce je ve formátu E.164 (např. „380501234567“).
1004	Neregistrovaný název alfa	Parametr „from“ obsahuje název alfa, který nebyl pro váš účet schválen.
1005	”Nedostatečný zůstatek”	Váš účet nemá dostatek finančních prostředků na zpracování komunikační kampaně.
1006	Neplatný typ zprávy	Parametr type musí být jedním z podporovaných typů (např. sms, viber_promo).
1007	”Šablona nenalezena”	Požadované ID šablony Viber/OTP je neplatné nebo není schváleno.
1008	”Neplatné položky karuselu”	Viber Carousel musí obsahovat 2 až 5 položek.

[!TIP] Pokud narazíte na kód chyby, který zde není uveden, nebo pokud se domníváte, že chyba byla vrácena omylem, kontaktujte prosím [email protected] a poskytněte přesné údaje o odpovědi a záhlaví.