API заавар

Баталгаажуулалт

Нэг удаагийн кодыг WeSend үүсгэж, илгээж, шалгана. Та кодыг хадгалах шаардлагагүй.

Хэрэглэгчийн утас эсвэл имэйлийг баталгаажуулах хоёр алхам: кодоо илгээлгэнэ, дараа нь хэрэглэгчийн оруулсан кодыг шалгуулна. Код WeSend дээр хэш хэлбэрээр л хадгалагдана.

1. Код илгээх

POST/v1/verify

Код үүсгэж илгээнэ. to нь @ агуулсан бол имэйлээр, үгүй бол SMS-ээр очно.

Биеийн талбарууд

tostringзаавал: Утасны дугаар эсвэл имэйл хаяг.
fallback_emailstring: Оператор SMS-ийг хүлээн аваагүй үед кодыг энэ хаяг руу илгээнэ. Зөвхөн to нь утас байхад.
localestring: Мессежийн хэл: mn (анхдагч) эсвэл en.
brandstring: Мессежийн эхэнд орох нэр, 20 тэмдэгт хүртэл. Өгөөгүй бол төслийн брэндийн нэр.
code_lengthinteger: Кодын урт, 4–8. Анхдагч нь 6.
ttlinteger: Кодын хүчинтэй хугацаа секундээр, 60–600. Анхдагч нь 300.

curl -X POST https://api.wesend.mn/v1/verify \
  -H "Authorization: Bearer $WESEND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "99112233",
  "brand": "Shop.mn",
  "fallback_email": "[email protected]"
}'

Хариу200 OK

{
  "id": "c4f1e2d3-7a8b-4c9d-a0e1-f2a3b4c5d6e7",
  "status": "pending",
  "channel": "sms",
  "to": "99112233",
  "expires_at": "2026-10-06T08:20:30.000Z",
  "credits": 70,
  "balance": 4930
}

Хүлээн авагчид «Shop.mn: Таны баталгаажуулах код 482913» гэсэн мессеж очно. id-г хадгалаад дараагийн алхамд ашиглана. Үнэ нь энгийн SMS (нэг хэсэг) эсвэл имэйлийнхтэй адил.

Код дахин илгээх бол /verify-г дахин дуудна. Тухайн хүлээн авагчийн өмнөх хүлээгдэж буй код хүчингүй болно.

2. Код шалгах

POST/v1/verify/{id}/check

Хэрэглэгчийн оруулсан кодыг шалгана.

Биеийн талбарууд

codestringзаавал: Хэрэглэгчийн оруулсан код.

curl -X POST https://api.wesend.mn/v1/verify/c4f1e2d3-7a8b-4c9d-a0e1-f2a3b4c5d6e7/check \
  -H "Authorization: Bearer $WESEND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "482913"
}'

Хариу200 OK

{
  "id": "c4f1e2d3-7a8b-4c9d-a0e1-f2a3b4c5d6e7",
  "status": "approved",
  "channel": "sms",
  "to": "99112233",
  "expires_at": "2026-10-06T08:20:30.000Z"
}

Зөв код 200 ба approved төлөв буцаана. Бусад тохиолдолд:

Хариу	Утга
422 invalid_code	Код буруу. Алдааны `attempts_remaining` талбарт үлдсэн оролдлогыг заана.
429 max_attempts_reached	5 удаа буруу оруулсан. Шинээр `/verify` дуудаж код илгээнэ.
410 verification_expired	Хугацаа дууссан, эсвэл шинэ код илгээснээр хүчингүй болсон.
400 invalid_request	Энэ баталгаажуулалт аль хэдийн батлагдсан.

Нэг хүлээн авагч 24 цагийн дотор нийт 10 удаа л буруу код оруулж болно. Хэтэрвэл шинэ код илгээх хүсэлт ч 429 max_attempts_reached буцаана. Энэ нь кодыг таах оролдлогоос хамгаална.

Төлөв харах

GET/v1/verify/{id}

Баталгаажуулалтын одоогийн төлвийг буцаана.

Төлөв	Утга
pending	Код илгээгдсэн, шалгахыг хүлээж байна.
approved	Зөв код оруулсан.
expired	Хугацаа дууссан.
failed	Буруу код хэт олон удаа оруулсан.
canceled	Шинэ код илгээснээр хүчингүй болсон.