Kļūdu kodi

Mijiedarbojoties ar SMSBAT API, var rasties kļūdas. Mēs izmantojam parastos HTTP atbildes kodus, lai norādītu uz API pieprasījuma panākumiem vai neveiksmēm.

Vispārīgi: - Kodi diapazonā “2xx” norāda uz panākumiem. - Kodi diapazonā “4xx” norāda uz kļūdu, kas neizdevās, ņemot vērā sniegto informāciju (piemēram, tika izlaists obligātais parametrs, ziņojuma veids nav derīgs utt.). - Kodi diapazonā “5xx” norāda uz kļūdu mūsu serveros.

HTTP statusa kodi

Kods	Statuss	Apraksts
200	”Labi”	Pieprasījums bija veiksmīgs.
400	Slikts pieprasījums	Pieprasījums bija nepieņemams, bieži vien tāpēc, ka trūka obligātā parametra vai bija nepareizi veidots JSON.
401	”Neatļauts”	Nav norādīta derīga API atslēga, vai autentifikācija neizdevās.
403	Aizliegts	API atslēgai nav atļauju izpildīt pieprasījumu, vai arī jūsu konta darbība ir apturēta.
404	Nav atrasts	Pieprasītais resurss neeksistē.
415	Neatbalstīts multivides veids	Trūkst galvenes “Content-Type”, vai tā nav iestatīta uz “application/json”.
422	Neapstrādājama entītija	Pieprasījums tika formatēts pareizi, taču tajā bija semantiskas kļūdas (piemēram, nederīgs tālruņa numura formāts).
429	Pārāk daudz pieprasījumu	Pārāk daudz pieprasījumu API sasniedza pārāk ātri. Mēs iesakām jūsu pieprasījumu eksponenciālu atkāpšanos.
500, 502, 503, 504	Servera kļūdas	SMSBAT beigās radās problēma.

Kļūdas atbildes formāts

Ja API pieprasījums rada kļūdu, atbildes pamattekstā ir JSON objekts ar plašāku informāciju par problēmu.

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

Biznesa loģikas kļūdu kodi (iekšējie kodi)

Papildus HTTP statusa kodiem mēs varam atgriezt īpašu iekšējo “kodu”, lai palīdzētu jums noteikt precīzu kļūmes iemeslu.

Iekšējais kods	Apraksts	Ieteicamā darbība
1001	”Nederīgs pieprasījuma formāts”	Pārliecinieties, vai jūsu pieprasījuma pamatteksts ir derīgs JSON.
1002	”Trūkst obligātā lauka”	Atbildē pārbaudiet rekvizītu ‘message’, lai redzētu, kura lauka trūkst.
1003	Nederīgs tālruņa numurs	Pārliecinieties, vai adresāta numurs ir E.164 formātā (piemēram, “380501234567”).
1004	Nereģistrēts alfa vārds	Parametrs “no” satur alfa nosaukumu, kas nav apstiprināts jūsu kontam.
1005	”Nepietiekams atlikums”	Jūsu kontā nav pietiekami daudz līdzekļu, lai apstrādātu ziņojumapmaiņas kampaņu.
1006	”Nederīgs ziņojuma veids”	Parametram “type” ir jābūt vienam no atbalstītajiem veidiem (piemēram, “sms”, “viber_promo”).
1007	Veidne nav atrasta	Pieprasītā Viber/OTP veidnes ID nav derīgs vai nav apstiprināts.
1008	”Nederīgi karuseļa vienumi”	Viber karuselī ir jābūt no 2 līdz 5 vienumiem.

[!PADOMS] Ja pamanāt kļūdas kodu, kas šeit nav norādīts, vai ja uzskatāt, ka kļūda tika atgriezta kļūdas dēļ, lūdzu, sazinieties ar [email protected] un norādiet precīzu atbildes lietderīgo slodzi un galvenes.