API заавар

Мессеж ба багц

Илгээсэн мессеж, багцын төлвийг дугаараар нь шалгана.

GET/v1/messages/{id}

Нэг мессежийн төлөв. Мессежийн агуулгыг буцаахгүй.

curl https://api.wesend.mn/v1/messages/0b9c1a52-6f0e-4d8b-9a3c-2f1e5d7c8a90 \
  -H "Authorization: Bearer $WESEND_API_KEY"
Хариу200 OK
{
  "id": "0b9c1a52-6f0e-4d8b-9a3c-2f1e5d7c8a90",
  "status": "sent",
  "channel": "sms",
  "to": "99112233",
  "parts": 1,
  "rate_multiplier": 1,
  "credits": 80,
  "batch_id": null,
  "error": null,
  "sandbox": false,
  "created_at": "2026-10-06T08:15:30.000Z",
  "sent_at": "2026-10-06T08:15:31.000Z"
}

Хариуны талбарууд

idstring
Мессежийн дугаар (UUID).
statusstring
queued, processing, sent эсвэл failed.
channelstring
sms эсвэл email.
tostring
Хүлээн авагч: 8 оронтой дугаар эсвэл имэйл хаяг.
partsinteger
SMS-ийн хэсгийн тоо. Зөвхөн SMS-д.
rate_multiplierinteger
Баярын тарифын үржүүлэгч. Зөвхөн SMS-д.
creditsinteger
Суутгасан кредит.
batch_idstring | null
Багцаар илгээсэн бол багцын дугаар.
errorobject | null
Амжилтгүй бол code, message бүхий объект.
sandboxboolean
Sandbox түлхүүрээр илгээсэн бол true: хэнд ч хүрээгүй, кредит суутгаагүй.
created_atstring
Үүссэн цаг, ISO 8601 (UTC).
sent_atstring | null
Илгээгдсэн цаг.
deliveryobject | null
Зөвхөн имэйлд. Хүлээн авагчийн имэйл серверээс ирсэн сүүлийн мэдээ: status, detail, refunded, updated_at. Мэдээ ирээгүй бол null.
delivered_atstring | null
Зөвхөн имэйлд. Хүлээн авагчийн имэйл сервер хүлээн авсан цаг.
ТөлөвУтга
queuedДараалалд байна.
processingИлгээж байна.
sentОператор эсвэл имэйл үйлчилгээнд хүлээлгэн өгсөн.
failedИлгээгдээгүй. Кредит буцаагдсан.

SMS-ийн хувьд sent гэдэг нь операторт хүлээлгэн өгснийг илтгэнэ. Гар утсанд хүрсэн эсэхийн баталгаа (delivery report) SMS-д одоогоор байхгүй.

Имэйлийн хүргэлт

Имэйл sent болсны дараа хүлээн авагчийн имэйл серверээс мэдээ ирэхэд delivery талбар шинэчлэгдэнэ. Ихэвчлэн хэдхэн секундэд ирдэг. status нь sent хэвээр үлдэнэ.

Хариу200 OK
{
  "id": "0b9c1a52-6f0e-4d8b-9a3c-2f1e5d7c8a90",
  "status": "sent",
  "channel": "email",
  "to": "[email protected]",
  "credits": 10,
  "batch_id": null,
  "error": null,
  "sandbox": false,
  "created_at": "2026-10-06T08:15:30.000Z",
  "sent_at": "2026-10-06T08:15:31.000Z",
  "delivery": {
    "status": "delivered",
    "detail": null,
    "refunded": false,
    "updated_at": "2026-10-06T08:15:33.000Z"
  },
  "delivered_at": "2026-10-06T08:15:33.000Z"
}
`delivery.status`Утга
deliveredХүлээн авагчийн имэйл сервер хүлээж авсан.
delayedСервер түр хүлээж авахгүй байгаа тул дахин оролдож байна.
bouncedСервер хүлээж аваагүй. Хаяг буруу эсвэл идэвхгүй байж болзошгүй. Шалтгааныг detail заана.
complainedХүлээн авагч спам гэж тэмдэглэсэн. Энэ хаяг руу дахин илгээхгүй байхыг зөвлөж байна.
suppressedХаяг өмнө нь буцаж эсвэл спам гэж тэмдэглэгдсэн тул имэйлийг илгээгээгүй. Кредит буцна.
failedИмэйл үйлчилгээ хүргэж чадсангүй. Кредит буцна.
  • Мэдээ дараалал алдагдаж ирж болно. delayed нь delivered-ийг дарахгүй, харин delivered-ийн дараа ирсэн bounced, complained нь түүнийг солино.
  • failed болон suppressed имэйлийн кредит автоматаар буцаж, delivery.refunded нь true болно. bounced, complained имэйл илгээгдсэн тул кредит буцахгүй.
  • Ямар ч мэдээ имэйл спам хавтас руу орсныг заадаггүй: спам хавтсанд очсон имэйл ч delivered гэж ирнэ. complained нь хүлээн авагч өөрөө спам гэж тэмдэглэсэн гэсэн үг.
  • Бүрмөсөн буцсан (Permanent) эсвэл suppressed хаяг сурталчилгаанаас автоматаар хасагдана.
  • Сүүлийн 7 хоногт 200-с дээш имэйл илгээсэн төслийн имэйлийн 5% нь бүрмөсөн буцах, эсвэл 0.1% нь (3-аас доошгүй) спам гэж тэмдэглэгдвэл илгээлт WeSend-ийн ажилтан шалгах хүртэл зогсож, 403 sending_paused хариу ирнэ.
  • Мессеж бүрийн хүргэлтийн явцыг самбарын Мессежийн түүх хэсэгт харна.

Багц

GET/v1/batches/{id}

Багц илгээлтийн явц.

curl https://api.wesend.mn/v1/batches/5d2a7c1e-93b4-4f6a-8e0d-b1c2d3e4f5a6 \
  -H "Authorization: Bearer $WESEND_API_KEY"
Хариу200 OK
{
  "id": "5d2a7c1e-93b4-4f6a-8e0d-b1c2d3e4f5a6",
  "status": "completed",
  "channel": "sms",
  "total": 500,
  "sent": 497,
  "failed": 3,
  "credits": 40000,
  "sandbox": false,
  "created_at": "2026-10-06T08:15:30.000Z",
  "completed_at": "2026-10-06T08:19:02.000Z"
}

status нь processing эсвэл completed. credits нь эхэнд суутгасан нийт дүн; failed мессеж бүрийн кредит буцаагдсан байна.