Klaidų kodai

Sąveikaujant su SMSBAT API, gali kilti klaidų. Naudojame įprastus HTTP atsako kodus, kad parodytume API užklausos sėkmę arba nesėkmę.

Apskritai: - Kodai diapazone „2xx“ rodo sėkmę. – Kodai diapazone „4xx“ rodo klaidą, kuri nepavyko dėl pateiktos informacijos (pvz., praleistas reikalingas parametras, netinkamas pranešimo tipas ir pan.). – „5xx“ diapazono kodai rodo mūsų serverių klaidą.

HTTP būsenos kodai

Kodas	Būsena	Aprašymas
200	"Gerai"	Prašymas buvo patenkintas.
400	„Blogas prašymas“	Užklausa buvo nepriimtina, dažnai dėl to, kad trūko būtino parametro arba netinkamai suformuotas JSON.
401	"Neteisėta"	Nepateiktas galiojantis API raktas arba autentifikavimas nepavyko.
403	Uždrausta	API raktas neturi leidimo vykdyti užklausą arba jūsų paskyra laikinai sustabdyta.
404	"Nerasta"	Prašomas šaltinis neegzistuoja.
415	Nepalaikomas medijos tipas	Trūksta antraštės „Content-Type“ arba ji nenustatyta į „application/json“.
422	Neapdorojamas objektas	Užklausa buvo tinkamai suformatuota, tačiau joje buvo semantinių klaidų (pvz., netinkamas telefono numerio formatas).
429	„Per daug užklausų“	Per daug užklausų per greitai pasiekia API. Rekomenduojame eksponentiškai atšaukti jūsų užklausas.
500, 502, 503, 504	„Serverio klaidos“	Kažkas negerai naudojant SMSBAT.

Atsakymo į klaidą formatas

Kai API užklausa sukelia klaidą, atsakymo turinyje yra JSON objektas su daugiau informacijos apie problemą.

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

Verslo logikos klaidų kodai (vidiniai kodai)

Be HTTP būsenos kodų, galime grąžinti konkretų vidinį „kodą“, kuris padės nustatyti tikslią gedimo priežastį.

| Vidaus kodas | Aprašymas | Siūlomas veiksmas | |---------------|----------------------------------| | 1001 | „Netinkamas užklausos formatas“ | Įsitikinkite, kad jūsų užklausos turinys yra tinkamas JSON. | | 1002 | „Trūksta būtino lauko“ | Atsakyme patikrinkite ypatybę „pranešimas“, kad pamatytumėte, kurio lauko trūksta. | | 1003 | „Neteisingas telefono numeris“ | Įsitikinkite, kad gavėjo numeris yra E.164 formatu (pvz., „380501234567“). | | 1004 | Neregistruotas alfa pavadinimas| Parametre „nuo“ yra alfa pavadinimas, kuris nebuvo patvirtintas jūsų paskyrai. | | 1005 | "Nepakankamas likutis" | Jūsų paskyroje nepakanka lėšų pranešimų kampanijai apdoroti. | | 1006 | „Netinkamas pranešimo tipas“ | Parametras „type“ turi būti vienas iš palaikomų tipų (pvz., „sms“, „viber_promo“). | | 1007 | „Šablonas nerastas“ | Prašomas Viber / OTP šablono ID yra netinkamas arba nepatvirtintas. | | 1008 | „Netinkami karuselės elementai“ | „Viber“ karuselėje turi būti nuo 2 iki 5 elementų. |

[!PATARIMAS] Jei aptinkate čia nepateiktą klaidos kodą arba manote, kad klaida buvo grąžinta per klaidą, susisiekite su adresu [email protected] ir pateikite tikslią atsakymo apkrovą bei antraštes.