WeSend
mnen
Самбар

API заавар

Харилцагчид

Хэрэглэгчдээ бүртгүүлэх үед нь WeSend-ийн харилцагчийн жагсаалтад нэмж, самбараас сурталчилгаа нэг товчоор илгээнэ.

Харилцагч бол таны сурталчилгаа илгээх хүн: утасны дугаар, имэйл хаяг эсвэл хоёулаа. Тэднийг самбараас гараар, CSV эсвэл Excel файлаас, эсвэл энэ API-аар нэмнэ. Дараа нь «Мессеж илгээх» хэсэгт бүх харилцагч, ангилал эсвэл шошгоор нь сонгож илгээнэ.

Сурталчилгааг зөвхөн 09:00-21:00 цагийн хооронд (Улаанбаатар) илгээнэ. SMS бүр {brand}: угтвараар эхэлж, имэйл бүрийн төгсгөлд бүртгэлээс гарах холбоос автоматаар нэмэгдэнэ.

Харилцагч нэмэх, шинэчлэх

POST/v1/contacts

Шинэ харилцагч нэмнэ, эсвэл ижил external_id, утас, имэйлтэй харилцагчийг шинэчилнэ.

Таны системд хэрэглэгч бүртгүүлэх бүрд энэ хаягийг дуудна. Нэг хүнийг дахин илгээхэд давхардахгүй, шинэчлэгдэнэ: эхлээд external_id-аар, дараа нь утсаар, дараа нь имэйлээр хайна.

curl -X POST https://dev-api.wesend.mn/v1/contacts \
  -H "Authorization: Bearer $WESEND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "external_id": "user_1024",
  "name": "Бат-Эрдэнэ",
  "phone": "99112233",
  "email": "[email protected]",
  "company": "DoDo Shop",
  "tags": [
    "vip"
  ],
  "groups": [
    "Шинэ хэрэглэгч"
  ],
  "marketing": {
    "sms": true,
    "email": true
  }
}'
Хариу201 Created
{
  "id": "0b9c1a52-6f0e-4d8b-9a3c-2f1e5d7c8a90",
  "external_id": "user_1024",
  "name": "Бат-Эрдэнэ",
  "phone": "99112233",
  "email": "[email protected]",
  "company": "DoDo Shop",
  "note": null,
  "tags": [
    "vip"
  ],
  "groups": [
    "Шинэ хэрэглэгч"
  ],
  "marketing": {
    "sms": "subscribed",
    "email": "subscribed"
  },
  "sandbox": false,
  "created_at": "2026-10-23T03:15:30.000Z",
  "updated_at": "2026-10-23T03:15:30.000Z",
  "created": true
}

Хүсэлтийн талбарууд

phonestring
Монголын 8 оронтой гар утасны дугаар. phone, email-ийн аль нэг заавал.
emailstring
Имэйл хаяг.
external_idstring
Таны систем дэх хэрэглэгчийн ID, 100 хүртэл тэмдэгт. Утас, имэйл нь солигдсон ч ижил хүнийг олно.
namestring
Овог нэр, 120 хүртэл тэмдэгт.
companystring
Байгууллага.
notestring
Дотоод тэмдэглэл, 1000 хүртэл тэмдэгт.
tagsstring[]
Шошго, 20 хүртэл. Илгээсэн бол хуучныг орлоно.
groupsstring[]
Ангиллын нэрс. Байхгүй ангилал автоматаар үүснэ. Илгээсэн бол хуучныг орлоно.
marketing.smsboolean
true: сурталчилгаа SMS авахыг зөвшөөрсөн. false: татгалзсан.
marketing.emailboolean
true: сурталчилгаа имэйл авахыг зөвшөөрсөн. false: татгалзсан.
  • Шинэ харилцагч бол 201, байсныг шинэчилсэн бол 200 ирж, created талбар үүнийг заана.
  • Илгээгээгүй талбар өөрчлөгдөхгүй. null илгээвэл тухайн талбарыг хоосолно.
  • Нэг төсөлд 100,000 хүртэл харилцагч, 100 хүртэл ангилал хадгална.
  • Sandbox түлхүүрээр нэмсэн харилцагч тусдаа жагсаалтад хадгалагдаж, самбарт болон илгээлтэд орохгүй. 30 хоногийн дараа устна.

Сурталчилгааны зөвшөөрөл

Харилцагч бүр SMS, имэйл тус бүрээр marketing төлөвтэй: unknown (тодорхойгүй), subscribed (зөвшөөрсөн), unsubscribed (татгалзсан). unknown харилцагч татгалзах хүртлээ сурталчилгаа хүлээн авна; unsubscribed хүнд хэзээ ч илгээхгүй.

  • Татгалзал хадгалагдана. Харилцагчийг устгаад дахин нэмэх, файлаас оруулах нь түүнийг буцааж идэвхжүүлэхгүй.
  • Хэрэглэгч таны апп дээр сурталчилгаагаа унтраавал PATCH /contacts/{id}-ээр marketing.sms: false илгээнэ. SMS-д хариу бичиж татгалзах боломжгүй тул энэ нь SMS татгалзлын гол зам.
  • true нь таны төсөл бүртгэсэн татгалзлыг цуцална. Хүн өөрөө имэйлийн холбоосоор бүртгэлээс гарсан, эсвэл спам гэж тэмдэглэсэн бол true үйлчлэхгүй.

Олноор нь нэмэх

POST/v1/contacts/bulk

Нэг дуудлагаар 1000 хүртэл харилцагч. Мөр бүр тусдаа хариутай: алдаатай нэг мөр бусдыг зогсоохгүй.

curl -X POST https://dev-api.wesend.mn/v1/contacts/bulk \
  -H "Authorization: Bearer $WESEND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contacts": [
    {
      "external_id": "user_1024",
      "phone": "99112233",
      "name": "Бат-Эрдэнэ"
    },
    {
      "external_id": "user_1025",
      "email": "[email protected]",
      "name": "Сараа",
      "marketing": {
        "email": true
      }
    }
  ]
}'
Хариу200 OK
{
  "created": 1,
  "updated": 1,
  "results": [
    {
      "id": "0b9c1a52-6f0e-4d8b-9a3c-2f1e5d7c8a90",
      "created": false
    },
    {
      "id": "7d3e2f10-1c4b-4a8e-9f62-3b5a7c9d0e21",
      "created": true
    }
  ]
}

Хайх, жагсаах

GET/v1/contacts

Харилцагчдын жагсаалт, эсвэл external_id, phone, email-ээр нэг харилцагч.

curl "https://dev-api.wesend.mn/v1/contacts?external_id=user_1024" \
  -H "Authorization: Bearer $WESEND_API_KEY"

Шүүлтүүр

external_id, phone, emailstring
Нэг харилцагчийг олно.
qstring
Нэр, утас, имэйл, байгууллагаар хайна.
tagstring
Шошготой харилцагчид.
groupstring
Ангиллын нэр.
page, limitnumber
Хуудас, 1-100 хүртэл (анхдагч 50).
GET/v1/contacts/{id}

Нэг харилцагч.

GET/v1/contact-groups

Төслийн ангиллууд.

Засах, устгах

PATCH/v1/contacts/{id}

Илгээсэн талбаруудыг л өөрчилнө.

curl -X PATCH https://dev-api.wesend.mn/v1/contacts/0b9c1a52-6f0e-4d8b-9a3c-2f1e5d7c8a90 \
  -H "Authorization: Bearer $WESEND_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "marketing": {
    "sms": false
  }
}'
DELETE/v1/contacts/{id}

Харилцагчийг устгана. Түүний татгалзал хадгалагдсаар үлдэнэ.

curl -X DELETE https://dev-api.wesend.mn/v1/contacts/0b9c1a52-6f0e-4d8b-9a3c-2f1e5d7c8a90 \
  -H "Authorization: Bearer $WESEND_API_KEY"
Хариу200 OK
{
  "id": "0b9c1a52-6f0e-4d8b-9a3c-2f1e5d7c8a90",
  "deleted": true
}