Kodet e gabimit

Kur ndërveproni me SMSBAT API, mund të hasni gabime. Ne përdorim kodet konvencionale të përgjigjes HTTP për të treguar suksesin ose dështimin e një kërkese API.

Në përgjithësi:

• Kodet në rangun “2xx” tregojnë sukses.
• Kodet në intervalin 4xx tregojnë një gabim që dështoi duke marrë parasysh informacionin e dhënë (p.sh., një parametër i kërkuar është hequr, një lloj mesazhi është i pavlefshëm, etj.).
• Kodet në intervalin 5xx tregojnë një gabim me serverët tanë.

Kodet e statusit HTTP

Kodi	Statusi	Përshkrimi
200	OK	Kërkesa ishte e suksesshme.
400	Kërkesë e keqe	Kërkesa ishte e papranueshme, shpesh për shkak të mungesës së një parametri të kërkuar ose JSON të keqformuar.
401	’I paautorizuar’	Nuk u ofrua asnjë çelës i vlefshëm API ose vërtetimi dështoi.
403	’E ndaluar’	Çelësi API nuk ka leje për të kryer kërkesën ose llogaria juaj është pezulluar.
404	Nuk u gjet	Burimi i kërkuar nuk ekziston.
415	Lloji i medias i pambështetur	Titulli “Lloji i përmbajtjes” mungon ose nuk është caktuar në “aplikacion/json”.
422	”Entitet i papërpunueshëm”	Kërkesa ishte formatuar saktë, por përmbante gabime semantike (p.sh., format i pavlefshëm i numrit të telefonit).
429	Shumë Kërkesa	Shumë kërkesa goditën API-në shumë shpejt. Ne rekomandojmë një prapavijë eksponenciale të kërkesave tuaja.
500, 502, 503, 504	Gabimet e serverit	Diçka shkoi keq në fund të SMSBAT.

Formati i përgjigjes së gabimit

Kur një kërkesë API rezulton në një gabim, trupi i përgjigjes përmban një objekt JSON me më shumë detaje rreth problemit.

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

Kodet e gabimit të logjikës së biznesit (kodet e brendshme)

Përveç kodeve të statusit HTTP, ne mund të kthejmë një “kod” specifik të brendshëm për t’ju ndihmuar të identifikoni arsyen e saktë të dështimit.

Kodi i brendshëm	Përshkrimi	Veprimi i sugjeruar
1001	Format i pavlefshëm i kërkesës	Sigurohuni që trupi juaj i kërkesës është i vlefshëm JSON.
1002	Mungon Fusha e kërkuar	Kontrolloni veçorinë message në përgjigje për të parë se cila fushë mungon.
1003	”Numër i pavlefshëm telefoni”	Sigurohuni që numri i marrësit të jetë në formatin E.164 (p.sh., 380501234567).
1004	Emri alfa i paregjistruar	Parametri “nga” përmban një emër alfa që nuk është miratuar për llogarinë tuaj.
1005	’Bilanci i pamjaftueshëm’	Llogaria juaj nuk ka fonde të mjaftueshme për të përpunuar fushatën e mesazheve.
1006	Lloji i pavlefshëm i mesazhit	Parametri “lloj” duhet të jetë një nga llojet e mbështetura (p.sh., “sms”, “viber_promo”).
1007	”Model nuk u gjet”	ID-ja e shabllonit të kërkuar Viber/OTP është e pavlefshme ose nuk është miratuar.
1008	Artikuj karuseli të pavlefshëm	Një Viber Carousel duhet të përmbajë nga 2 deri në 5 artikuj.

[!KËSHILLA] Nëse hasni një kod gabimi që nuk renditet këtu, ose nëse besoni se një gabim është kthyer gabimisht, ju lutemi kontaktoni [email protected] dhe jepni ngarkesën e saktë të përgjigjes dhe titujt.