Skip to content

เพิ่มเบอร์เข้า Blacklist POST ​

เพิ่มเบอร์มือถือเข้า Blacklist ของบัญชีคุณ เบอร์ใน Blacklist จะไม่ได้รับ SMS จากบัญชีนี้ มีผลกับการส่งครั้งถัดไปทันที

Authorization ​

ใช้ API Key (การยืนยันตัวตน) — ส่ง header Authorization: Bearer <API_KEY> (API Key ขึ้นต้นด้วย smsk_)

HTTP Request ​

http
POST https://public-api.smsup-plus.com/Blacklist/insertBlacklist

Content Type ​

application/json

Parameter Description ​

PropertyTypeRequiredDescription
mobilestringRequiredเบอร์มือถือไทย ส่งได้ทั้ง 0812345678, +66812345678, 66812345678 หรือมีช่องว่าง / - — ระบบแปลงเป็นรูปแบบ 66XXXXXXXXX แบบเดียวกับตอนส่ง SMS
reasonstringOptionalเหตุผลที่เพิ่มเข้า Blacklist

Response Description ​

PropertyTypeDescription
statusnumber200 เมื่อสำเร็จ
dataobjectรายการที่บันทึก — ฟิลด์เดียวกับ Blacklist
data.mobilestringเบอร์ในรูปแบบ 66XXXXXXXXX (ค่าที่ระบบใช้เทียบตอนส่ง)
data.sourcestringapi

ตัวอย่าง Request ​

bash
curl -X POST 'https://public-api.smsup-plus.com/Blacklist/insertBlacklist' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "mobile": "66812345678",
    "reason": "ลูกค้าขอยกเลิกรับข่าวสาร"
  }'
js
const res = await fetch('https://public-api.smsup-plus.com/Blacklist/insertBlacklist', {
  method: 'POST',
  headers: { Authorization: 'Bearer <API_KEY>', 'Content-Type': 'application/json' },
  body: JSON.stringify({ mobile: '66812345678', reason: 'ลูกค้าขอยกเลิกรับข่าวสาร' }),
})
console.log(await res.json())

ตัวอย่าง Response ​

json
{
  "status": 200,
  "data": {
    "accountId": 1024,
    "mobile": "66812345678",
    "reason": "ลูกค้าขอยกเลิกรับข่าวสาร",
    "source": "api",
    "createdBy": 2048,
    "createdAt": "2026-11-16T03:30:00.123456789Z"
  }
}

Error ที่อาจเจอ ​

HTTPResponseสาเหตุ
200{"status":400,"description":"mobile is required."}ไม่ได้ส่ง mobile, ส่งเป็นค่าว่าง หรือ body ไม่ใช่ JSON
200{"status":400,"description":"Invalid mobile number."}ไม่ใช่เบอร์มือถือไทย (หลังแปลงแล้วต้องเป็น 66 ตามด้วยตัวเลข 9 หลัก)
200{"status":500,"description":"Failed to add to blacklist."}บันทึกไม่สำเร็จ ลองใหม่อีกครั้ง
401{"error":"invalid api key"}API Key ไม่ถูกต้อง — ดู Error

WARNING

เมื่อผ่านการยืนยันตัวตนแล้ว endpoint นี้ตอบ HTTP 200 เสมอ ให้ตรวจผลจากฟิลด์ status ใน body

ผลของ Blacklist ต่อการส่ง SMS ​

  • Blacklist แยกตามบัญชี — มีผลเฉพาะ SMS ที่ส่งจากบัญชีของคุณ
  • เมื่อเรียก ส่ง SMS ไปยังเบอร์ใน Blacklist เบอร์นั้นจะได้ status เป็น {"code":"403","name":"REJECTED","description":"Number is blacklisted"} และไม่ถูกส่งออก ส่วนเบอร์อื่นในคำขอเดียวกันส่งตามปกติ
  • ข้อความที่รับเข้าระบบไปแล้วแต่ยังไม่ส่ง (เช่น ตั้งเวลาส่งไว้) จะถูกตรวจซ้ำก่อนส่ง ถ้าเบอร์อยู่ใน Blacklist ตอนนั้นจะไม่ถูกส่ง

INFO

ระบบไม่ตรวจเบอร์ซ้ำก่อนบันทึก ควรตรวจรายการก่อนเพิ่ม