API заавар

Үлдэгдэл ба үнэ

Кредитийн үлдэгдэл, одоогийн үнэ, үнэ нэмэгдэх өдрүүдийг авна.

GET/v1/balance

Төслийн идэвхтэй кредитийн нийлбэр.

curl https://api.wesend.mn/v1/balance \
  -H "Authorization: Bearer $WESEND_API_KEY"
Хариу200 OK
{
  "balance": 4920,
  "next_expiry": {
    "credits": 920,
    "expires_at": "2027-01-14T03:00:00.000Z"
  },
  "unlimited": false
}
  • 1 кредит = 1₮. Кредит авснаас хойш 365 хоног хүчинтэй.
  • Хугацаа нь хамгийн ойр дуусах кредит эхэлж зарцуулагдана. next_expiry нь тэр хэсгийг заана; идэвхтэй кредит байхгүй бол null.
  • Илгээх хариу бүрд шинэ үлдэгдэл balance талбарт ирдэг тул тусад нь асуух шаардлага бага.
  • unlimited нь true бол WeSend төсөлд хязгааргүй эрх олгосон: үлдэгдэл хасагдахгүй тул илгээхийн өмнө үлдэгдэл шалгах шаардлагагүй.

Үнэ

GET/v1/pricing

Таны төсөлд үйлчлэх одоогийн үнэ.

curl https://api.wesend.mn/v1/pricing \
  -H "Authorization: Bearer $WESEND_API_KEY"
Хариу200 OK
{
  "sms": {
    "credits_per_part": 80,
    "rate_multiplier": 1,
    "holiday": null,
    "latin_part_size": 155,
    "unicode_part_size": 65,
    "max_parts": 4,
    "prefix": {
      "name": "WeSend",
      "length": 8,
      "is_latin": true
    }
  },
  "email": {
    "credits": 10
  },
  "holidays": [
    {
      "name": "Шинэ жил",
      "starts_on": "2026-12-31",
      "ends_on": "2027-01-01",
      "rate_multiplier": 2
    },
    {
      "name": "Цагаан сар",
      "starts_on": "2027-02-06",
      "ends_on": "2027-02-09",
      "rate_multiplier": 2
    }
  ]
}

Баярын тариф

Үүрэн операторууд Шинэ жил, Цагаан сар, Наадам зэрэг өдрүүдэд SMS-ийн тарифаа нэмэгдүүлдэг. Тэр өдрүүдэд SMS-ийн кредит rate_multiplier-ээр үржигдэнэ. Имэйлд үйлчлэхгүй.

  • holidays жагсаалтад ирэх өдрүүд Улаанбаатарын цагаар, эхлэх ба дуусах өдрийг оролцуулан байна.
  • Одоо үйлчилж буй үржүүлэгч sms.rate_multiplier-д, баярын нэр sms.holiday-д байна.
  • Мессеж бүрийн хариуны rate_multiplier талбар тухайн мессежид ямар үржүүлэгч үйлчилснийг заана.

Брэндийн угтвар

Баталгаажуулах кодын SMS {name}: угтвараар эхэлнэ. sms.prefix нь төслийн брэндийн нэр, түүнийг тохируулаагүй бол латин үсгээр бичсэн төслийн нэрийг заана (Монгол Шувуу → Mongol Shuvuu). Хүсэлтэд brand заасан бол тэр нь давуу үйлчилнэ.

  • length нь угтварын тэмдэгтийн тоо, ард нь орох : хоёр тэмдэгтийг оролцуулна. Энэ тоо SMS-ийн эхний хэсгийн хэмжээнд багтаж тооцогдоно.
  • is_latin нь false бол нэрэнд кирилл үсэг эсвэл тусгай тэмдэгт орсон байна. Ийм үед SMS бүхэлдээ unicode_part_size хэмжээгээр хуваагдана.