API заавар

Алдаа

Алдаа бүр HTTP статус код болон машинд уншигдах кодтой ирнэ.

Амжилтгүй хүсэлтийн хариу үргэлж error объекттой. Кодоор нь шалгаж, message-ийг зөвхөн бүртгэл, дибаг хийхэд ашиглана: мессежийн үг өөрчлөгдөж болно.

Хариу402 Payment Required
{
  "error": {
    "code": "insufficient_credits",
    "message": "Not enough credits.",
    "balance": 40,
    "required": 70
  }
}

Алдааны кодууд

HTTPКодУтга
400invalid_requestХүсэлт буруу: талбар дутуу, утга буруу, эсвэл JSON биш.
401invalid_api_keyТүлхүүр байхгүй, буруу эсвэл хүчингүй.
402insufficient_creditsКредит хүрэлцэхгүй. balance, required талбартай.
402subscription_requiredТуршилт дууссан эсвэл суурь хураамж төлөгдөөгүй.
403forbiddenЭнэ үйлдлийг хийх эрхгүй.
403trial_recipientТуршилтын үед зөвхөн эзэмшигчийн баталгаажсан утас, имэйл рүү илгээнэ.
404not_foundИйм дугаартай зүйл энэ төсөлд алга, эсвэл хаяг буруу.
410verification_expiredБаталгаажуулалтын хугацаа дууссан.
422unsupported_numberДугаар дэмжигдсэн операторынх биш.
422message_too_longSMS 5 хэсгээс урт, имэйл 256 KB-аас их, эсвэл хүсэлт 1 MB-аас их.
422invalid_codeБаталгаажуулах код буруу. attempts_remaining талбартай.
429rate_limitedХэт олон хүсэлт. Retry-After толгойг харна уу.
429recipient_rate_limitedЭнэ хүлээн авагч руу хэт олон мессеж илгээсэн.
429max_attempts_reachedБуруу код хэт олон удаа оруулсан.
502provider_failedОператор мессежийг хүлээн аваагүй. Кредит буцаагдсан. id талбартай.
500server_errorМанай талд алдаа гарсан.

Хэрхэн хандах вэ

  • 4xx алдааг ижил хүсэлтээр дахин бүү оролд. Хүсэлтээ засах эсвэл хэрэглэгчид мэдэгдэнэ. Үл хамаарах нь 429: Retry-After секунд хүлээгээд дахин илгээнэ.
  • 502 provider_failed-ийг дахин оролдож болно: кредит буцсан. Операторын түр саатал байж магадгүй.
  • 500 server_error эсвэл сүлжээний тасалдлын үед мессеж илгээгдсэн эсэх тодорхойгүй. Давхар илгээхээс сэргийлж Idempotency-Key толгойтой дахин оролдоно.