Kodiċi ta' Żball

Meta tinteraġixxi mal-API SMSBAT, tista’ tiltaqa’ ma’ żbalji. Aħna nużaw kodiċijiet ta ‘rispons HTTP konvenzjonali biex nindikaw is-suċċess jew il-falliment ta’ talba API.

B’mod ġenerali:

• Kodiċijiet fil-medda 2xx jindikaw suċċess.
• Kodiċijiet fil-medda 4xx jindikaw żball li falla minħabba l-informazzjoni pprovduta (eż., parametru meħtieġ tħalla barra, tip ta’ messaġġ mhux validu, eċċ.).
• Kodiċijiet fil-medda 5xx jindikaw żball mas-servers tagħna.

Kodiċi tal-Istatus HTTP

Kodiċi	Status	Deskrizzjoni
200	”OK”	It-talba rnexxiet.
400	”Talba Ħażina”	It-talba ma kinitx aċċettabbli, ħafna drabi minħabba li ma kienx hemm parametru meħtieġ jew JSON ħażin.
401	”Mhux awtorizzat”	Ebda ċavetta API valida pprovduta, jew l-awtentikazzjoni falliet.
403	”Projbit”	Iċ-ċavetta API m’għandhiex permessi biex twettaq it-talba, jew il-kont tiegħek huwa sospiż.
404	”Mhux misjub”	Ir-riżors mitluba ma teżistix.
415	Tip ta' Media mhux appoġġjat	L-intestatura Content-Type hija nieqsa jew mhux issettjata għal application/json.
422	Entità mhux ipproċessabbli	It-talba kienet ifformattjata b’mod korrett iżda kien fiha żbalji semantiċi (eż., format invalidu tan-numru tat-telefon).
429	”Wisq Talbiet”	Wisq talbiet jolqtu l-API malajr wisq. Nirrakkomandaw backoff esponenzjali tat-talbiet tiegħek.
500, 502, 503, 504	”Żbalji tas-Server”	Xi ħaġa marret ħażin fi tmiem SMSBAT.

Format ta’ Rispons ta’ Żball

Meta talba API tirriżulta fi żball, il-korp tar-rispons ikun fih oġġett JSON b’aktar dettalji dwar il-problema.

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

Kodiċi ta’ Żball tal-Loġika tan-Negozju (Kodiċijiet Interni)

Minbarra l-kodiċi tal-istatus HTTP, nistgħu nirritornaw “kodiċi” intern speċifiku biex jgħinek tidentifika r-raġuni eżatta għall-falliment.

Kodiċi Intern	Deskrizzjoni	Azzjoni Suġġerita
1001	`Format ta’ Talba Invalidu’	Kun żgur li l-korp tat-talba tiegħek huwa JSON validu.
1002	Qasam Meħtieġa Nieqes	Iċċekkja l-proprjetà “messaġġ” fir-rispons biex tara liema qasam huwa nieqes.
1003	Numru tat-Telefon Invalidu	Kun żgur li n-numru tar-riċevitur ikun fil-format E.164 (eż., 380501234567).
1004	Isem Alfa Mhux Reġistrat	Il-parametru minn fih isem alfa li ma ġiex approvat għall-kont tiegħek.
1005	”Bilanċ Insuffiċjenti”	Il-kont tiegħek m’għandux biżżejjed fondi biex jipproċessa l-kampanja tal-messaġġi.
1006	”Tip ta’ Messaġġ Invalidu”	Il-parametru “tip” għandu jkun wieħed mit-tipi appoġġjati (eż., “sms”, “viber_promo”).
1007	”Mudell mhux misjub”	L-ID tal-mudell Viber/OTP mitlub huwa invalidu jew mhux approvat.
1008	”Oġġetti tal-karużell invalidi”	A Viber Carousel għandu jkun fih bejn 2 u 5 oġġetti.

[!TIP] Jekk tiltaqa’ ma’ kodiċi ta’ żball mhux elenkat hawn, jew jekk temmen li żball ġie rritornat bi żball, jekk jogħġbok ikkuntattja lil [email protected] u agħti t-tagħbija eżatta tar-rispons u l-headers.