Սխալի կոդեր

SMSBAT API-ի հետ շփվելիս կարող եք սխալների հանդիպել: Մենք օգտագործում ենք սովորական HTTP պատասխանի կոդերը՝ նշելու համար API հարցումի հաջողությունը կամ ձախողումը:

Ընդհանուր առմամբ. - «2xx» տիրույթի կոդերը ցույց են տալիս հաջողություն: - «4xx» տիրույթում գտնվող կոդերը ցույց են տալիս սխալ, որը ձախողվեց՝ հաշվի առնելով ներկայացված տեղեկատվությունը (օրինակ՝ պահանջվող պարամետրը բաց է թողնվել, հաղորդագրության տեսակն անվավեր է և այլն): - «5xx» տիրույթի կոդերը ցույց են տալիս մեր սերվերների հետ կապված սխալ:

HTTP կարգավիճակի կոդեր

Կոդ	Կարգավիճակը	Նկարագրություն
200	«Լավ»	Հարցումը հաջողվեց։
400	«Վատ խնդրանք»	Հարցումն անընդունելի էր՝ հաճախ պահանջվող պարամետրը բաց թողնելու կամ JSON սխալ ձևաչափի պատճառով:
401	«Չլիազորված»	Վավեր API բանալի չի տրամադրվել, կամ նույնականացումը ձախողվել է:
403	«Արգելված»	API ստեղնը հարցումը կատարելու թույլտվություն չունի, կամ ձեր հաշիվը կասեցված է:
404	«Չի գտնվել»	Պահանջվող ռեսուրսը գոյություն չունի:
415	«Չաջակցվող լրատվամիջոցի տեսակ»	«Content-Type» վերնագիրը բացակայում է կամ սահմանված չէ «application/json»:
422	«Անմշակելի սուբյեկտ»	Հարցումը ճիշտ ձևաչափված էր, բայց պարունակում էր իմաստային սխալներ (օրինակ՝ հեռախոսահամարի անվավեր ձևաչափ):
429	«Չափազանց շատ հարցումներ»	Չափազանց շատ հարցումներ շատ արագ հարվածեցին API-ին: Մենք խորհուրդ ենք տալիս հետաձգել ձեր հարցումները:
500, 502, 503, 504	«Սերվերի սխալներ»	Սխալ առաջացավ SMSBAT-ի վերջում:

Սխալների արձագանքման ձևաչափ

Երբ API հարցումը հանգեցնում է սխալի, պատասխան մարմինը պարունակում է JSON օբյեկտ՝ խնդրի մասին ավելի շատ մանրամասներով:

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

Բիզնես տրամաբանական սխալի կոդեր (ներքին կոդեր)

Բացի HTTP կարգավիճակի կոդերից, մենք կարող ենք վերադարձնել հատուկ ներքին «կոդ», որը կօգնի ձեզ բացահայտել ձախողման ճշգրիտ պատճառը:

| Ներքին կոդը | Նկարագրություն | Առաջարկվող գործողություն | |-------------------------------|------------------| | 1001 | «Անվավեր հայտի ձևաչափ» | Համոզվեք, որ ձեր հարցումը վավեր է JSON: | | 1002 | «Բացակայում է պարտադիր դաշտը» | Ստուգեք «հաղորդագրություն» հատկությունը պատասխանում՝ տեսնելու, թե որ դաշտն է բացակայում: | | 1003 | «Անվավեր հեռախոսահամար» | Համոզվեք, որ ստացողի համարը E.164 ձևաչափով է (օրինակ՝ «380501234567»): | | 1004 | «Չգրանցված ալֆա անուն»| «from» պարամետրը պարունակում է ալֆա անուն, որը հաստատված չէ ձեր հաշվի համար: | | 1005 | «Անբավարար մնացորդ» | Ձեր հաշիվը բավարար միջոցներ չունի հաղորդագրությունների արշավը մշակելու համար: | | 1006 | «Անվավեր հաղորդագրության տեսակ» | «type» պարամետրը պետք է լինի աջակցվող տեսակներից մեկը (օրինակ՝ «sms», «viber_promo»): | | 1007 | «Կաղապարը չի գտնվել» | Հայցվող Viber/OTP ձևանմուշի ID-ն անվավեր է կամ հաստատված չէ: | | 1008 | «Անվավեր կարուսելի իրեր» | Viber կարուսելը պետք է պարունակի 2-ից 5 ապրանք: |

[!ԽՈՐՀՈՒՐԴ] Եթե հանդիպեք սխալի կոդին, որը նշված չէ այստեղ, կամ եթե կարծում եք, որ սխալը սխալմամբ է վերադարձվել, խնդրում ենք կապվել [email protected] հետ և տրամադրել պատասխանի ճշգրիտ բեռը և վերնագրերը: