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": 70,
  "batch_id": null,
  "error": null,
  "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 бүхий объект.
created_atstring: Үүссэн цаг, ISO 8601 (UTC).
sent_atstring | null: Илгээгдсэн цаг.

Төлөв	Утга
queued	Дараалалд байна.
processing	Илгээж байна.
sent	Оператор эсвэл имэйл үйлчилгээнд хүлээлгэн өгсөн.
failed	Илгээгдээгүй. Кредит буцаагдсан.

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

Багц

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": 35000,
  "created_at": "2026-10-06T08:15:30.000Z",
  "completed_at": "2026-10-06T08:19:02.000Z"
}

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