ตรวจสอบ Consent GET
ดูสถานะความยินยอม (PDPA consent) ล่าสุดของเบอร์มือถือหนึ่งเบอร์ในบัญชีของคุณ ใช้ก่อนส่งข้อความเพื่อยืนยันว่าผู้รับยังยินยอมอยู่
Authorization
ใช้ API Key (การยืนยันตัวตน) — ส่ง header Authorization: Bearer <API_KEY> (API Key ขึ้นต้นด้วย smsk_)
HTTP Request
http
GET https://public-api.smsup-plus.com/Consent/checkconsent/{mobile}?type={consentType}Content Type
ไม่มี body — ส่งค่าผ่าน path และ query string
Parameter Description
| Property | Type | Required | Description |
|---|---|---|---|
mobile | string (path) | Required | เบอร์มือถือ ระบบตัดอักขระที่ไม่ใช่ตัวเลขและ + ออก (เช่น ช่องว่าง, -) แล้วต้องเหลือตัวเลข 10–15 หลัก |
type | string (query) | Optional | กรองเฉพาะ consentType ที่ระบุ (เช่น marketing) — ถ้าไม่ส่ง จะคืนรายการล่าสุดของทุกประเภท |
Response Description
| Property | Type | Description |
|---|---|---|
status | number | 200 เมื่อพบข้อมูล |
data.granted | boolean | true = ยินยอม, false = ไม่ยินยอม / ถอนความยินยอม |
data.consentType | string | ประเภทความยินยอมของรายการนี้ |
data.source | string | ช่องทางที่ได้รับความยินยอม ตามที่ส่งตอนบันทึก (ว่างถ้าไม่ได้ส่ง) |
data.createdAt | string | เวลาที่บันทึก (ISO 8601, UTC) |
ตัวอย่าง Request
bash
curl -X GET 'https://public-api.smsup-plus.com/Consent/checkconsent/0812345678?type=marketing' \
-H 'Authorization: Bearer <API_KEY>'js
const res = await fetch('https://public-api.smsup-plus.com/Consent/checkconsent/0812345678?type=marketing', {
headers: { Authorization: 'Bearer <API_KEY>' },
})
console.log(await res.json())ตัวอย่าง Response
json
{
"status": 200,
"data": {
"granted": true,
"consentType": "marketing",
"source": "web",
"createdAt": "2026-11-16T03:15:42.512Z"
}
}Error ที่อาจเจอ
endpoint นี้ตอบ HTTP 200 เสมอ (ยกเว้น error การยืนยันตัวตน) — ให้ตรวจผลลัพธ์จากฟิลด์ status ใน body
| HTTP | Response | สาเหตุ |
|---|---|---|
| 200 | {"status":404,"description":"No consent record found.","data":null} | ยังไม่มีการบันทึก consent ของเบอร์นี้ (หรือของ type นี้) |
| 200 | {"status":400,"description":"Invalid mobile number."} | เบอร์มีตัวเลขน้อยกว่า 10 หรือมากกว่า 15 หลัก |
| 200 | {"status":500,"description":"Failed to query consent."} | ระบบดึงข้อมูลไม่สำเร็จ ลองใหม่อีกครั้ง |
| 200 | {"status":401,"description":"Unauthorized."} | ไม่สามารถระบุบัญชีจากข้อมูลยืนยันตัวตนได้ |
| 401 | {"error":"invalid api key"} | API Key ไม่ถูกต้อง — ดู Error |
WARNING
การค้นหาเทียบเบอร์แบบตรงตัว — ใช้รูปแบบเบอร์เดียวกับตอนบันทึก consent (เช่น บันทึกเป็น 0812345678 ต้องตรวจด้วย 0812345678 ไม่ใช่ 66812345678)
