เริ่มต้นใช้งาน
SMSUP Plus API ให้ระบบของคุณส่ง SMS, OTP และจัดการข้อมูลผู้รับได้โดยตรงผ่าน HTTPS เอกสารนี้อธิบายภาพรวม รูปแบบ request/response และวิธียิง request แรก
API ที่มีให้ใช้
| กลุ่ม | Path | ใช้ทำอะไร |
|---|---|---|
| SMS | /sms/send, /sms/preview, /sms/senderlist, /sms/loginfo | ส่ง SMS, คำนวณเครดิตก่อนส่ง, ดูชื่อผู้ส่งที่อนุมัติแล้ว, ค้นประวัติการส่ง |
| OTP | /OTP/requestotp, /OTP/verifyotp, /OTP/resendotp | ส่งรหัส OTP, ตรวจรหัส, ส่งซ้ำ |
| ย่อลิงก์ | /shorten/create, /shorten/list, /shorten/stats/:code, /s/:code | สร้างลิงก์สั้น, ดูรายการและสถิติการคลิก |
| รายชื่อผู้ติดต่อ | /Person/... | เพิ่ม/แก้/ลบ/ค้นหารายชื่อและเบอร์ปลายทาง |
| แท็ก | /Tag/... | จัดกลุ่มรายชื่อด้วยแท็ก |
| Blacklist | /Blacklist/... | จัดการเบอร์ที่ไม่ต้องการให้ส่งถึง |
| Consent | /Consent/... | บันทึกและตรวจสอบความยินยอม (PDPA) |
| LINE | /line/send, /line/dashboard | ส่งข้อความผ่าน LINE token ที่ตั้งค่าไว้ |
| Callback | notifyUrl ใน /sms/send | รับสถานะการส่งถึงปลายทาง (Delivery Report) |
Base URL
https://public-api.smsup-plus.comทุก endpoint ใช้ HTTPS และต้องยืนยันตัวตน (ยกเว้นลิงก์ redirect /s/:code) ดู การยืนยันตัวตน
รูปแบบ Request / Response
| หัวข้อ | รายละเอียด |
|---|---|
| Request body | endpoint แบบ POST รับ JSON — ส่ง header Content-Type: application/json |
| Query / Path | endpoint แบบ GET รับค่าทาง query string หรือ path เช่น /sms/loginfo?bulkId=..., /Consent/checkconsent/{mobile} |
| Response | JSON (UTF-8) ทุก endpoint ยกเว้น /s/:code ที่ตอบเป็น HTTP 302 redirect |
| ชื่อ path | ตัวพิมพ์เล็ก/ใหญ่มีผล (/OTP/..., /Person/... ต้องพิมพ์ตามเอกสาร) |
| ข้อความภาษาไทย | ส่งเป็น UTF-8 ได้ตรง ๆ ไม่ต้อง encode เพิ่ม |
เบอร์โทรศัพท์ (SMS / OTP)
ระบบตัดอักขระที่ไม่ใช่ตัวเลขออกก่อน แล้วแปลงเป็นรูปแบบ 66XXXXXXXXX
| ค่าที่ส่งมา | หลังแปลง | ผล |
|---|---|---|
0812345678 | 66812345678 | ใช้ได้ |
+66 81-234-5678 | 66812345678 | ใช้ได้ |
66812345678 | 66812345678 | ใช้ได้ |
812345678 (9 หลัก) | 66812345678 | ใช้ได้ |
02123456 | 662123456 | ไม่ผ่าน (ต้องได้ 11 หลักขึ้นต้น 66) |
เบอร์ที่ไม่ผ่านจะถูกตอบเป็น REJECTED ในผลลัพธ์ของเบอร์นั้น และไม่ถูกส่งหรือคิดเครดิต
TIP
API กลุ่ม Blacklist และ Consent ใช้การตรวจเบอร์ของตัวเอง (ตัดช่องว่าง ขีด วงเล็บ และต้องมี 10–15 หลัก) ดูรายละเอียดในหน้าของแต่ละ endpoint
ความยาวข้อความและเครดิต
| ประเภทข้อความ | 1 เครดิต | ข้อความยาว (ต่อเครดิต) |
|---|---|---|
| มีอักขระที่ไม่ใช่ ASCII (เช่น ภาษาไทย) | ไม่เกิน 70 ตัวอักษร | 67 ตัวอักษร (71–134 ตัว = 2 เครดิต) |
| ASCII ล้วน | ไม่เกิน 160 ตัวอักษร | 153 ตัวอักษร (161–306 ตัว = 2 เครดิต) |
ข้อความยาวสุด 1,600 ตัวอักษร และส่งได้สูงสุด 1,000 เบอร์ต่อ request ใช้ /sms/preview เพื่อคำนวณเครดิตก่อนส่งจริง
เริ่มต้นอย่างรวดเร็ว
- เข้าสู่ระบบ พอร์ทัลลูกค้า แล้วสร้าง API Key ในพอร์ทัลลูกค้า
- คัดลอก key ที่ขึ้นต้นด้วย
smsk_เก็บไว้ในที่ปลอดภัย (ระบบแสดง key เต็มเพียงครั้งเดียว) - ตรวจว่าชื่อผู้ส่ง (sender) ของคุณได้รับอนุมัติแล้ว — ดูได้จาก
GET /sms/senderlist - ยิง request แรกตามตัวอย่างด้านล่าง
Request แรก: ส่ง SMS
curl -X POST 'https://public-api.smsup-plus.com/sms/send' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"messages": [
{
"from": "MYBRAND",
"destinations": [{ "to": "0812345678" }],
"text": "สวัสดีจาก SMSUP Plus"
}
]
}'const res = await fetch('https://public-api.smsup-plus.com/sms/send', {
method: 'POST',
headers: { Authorization: 'Bearer <API_KEY>', 'Content-Type': 'application/json' },
body: JSON.stringify({
messages: [
{ from: 'MYBRAND', destinations: [{ to: '0812345678' }], text: 'สวัสดีจาก SMSUP Plus' },
],
}),
})
console.log(await res.json())ผลลัพธ์ที่สำเร็จ (HTTP 200):
{
"bulkId": "6f1c2a8e-1b7a-4c35-9d0e-2b8f6f3e9a11",
"details": [
{
"messageId": "0b7e4d0c-5a3f-4f0e-8a51-4e2d9c7b1f20",
"mobile": "66812345678",
"to": "66812345678",
"from": "MYBRAND",
"credit": "1.00",
"shorturl": "N",
"status": {
"code": "101",
"name": "PENDING",
"description": "Pending -Message has been accepted by the system"
}
}
]
}PENDING หมายถึงระบบรับข้อความเข้าคิวแล้ว สถานะการส่งถึงปลายทางติดตามได้ด้วย Delivery Report callback หรือ /sms/loginfo
ขั้นต่อไป
- การยืนยันตัวตน — รูปแบบ header, rate limit, Idempotency-Key
- รหัสข้อผิดพลาด — รูปแบบ error ทั้งหมด
- ส่ง SMS — พารามิเตอร์ทั้งหมดของการส่ง
