ดูรายการแท็ก POST
ดึงรายการแท็ก (กลุ่มรายชื่อ) ของบัญชีคุณแบบแบ่งหน้า ค้นหาจากชื่อแท็กได้
Authorization
ใช้ API Key (การยืนยันตัวตน) — ส่ง header Authorization: Bearer <API_KEY> (API Key ขึ้นต้นด้วย smsk_)
HTTP Request
http
POST https://public-api.smsup-plus.com/Tag/requestTagContent Type
application/json — body เป็น optional ถ้าไม่ส่งหรือ JSON ผิดรูปแบบ ระบบจะใช้ค่าเริ่มต้นทั้งหมด
Parameter Description
| Property | Type | Required | Description |
|---|---|---|---|
search | string | Optional | คำค้นแบบบางส่วนในชื่อแท็ก ไม่สนตัวพิมพ์เล็ก-ใหญ่ |
page | number | Optional | หน้าที่ต้องการ เริ่มที่ 1 (ค่าเริ่มต้น 1) |
pageSize | number | Optional | จำนวนต่อหน้า 1–100 (ค่าเริ่มต้น 50) — ถ้าส่ง 101–200 ระบบจะใช้ 20, ค่าอื่นนอกช่วงใช้ 50 |
Response Description
| Property | Type | Description |
|---|---|---|
status | number | 200 เมื่อสำเร็จ |
data | array | null | รายการ Tag เรียงจากสร้างล่าสุดก่อน — เป็น null เมื่อไม่พบข้อมูล |
total | number | จำนวนแท็กทั้งหมดที่ตรงเงื่อนไข |
page | number | หน้าปัจจุบัน |
pageSize | number | จำนวนต่อหน้าที่ระบบใช้จริง |
totalPages | number | จำนวนหน้าทั้งหมด |
Tag
| Property | Type | Description |
|---|---|---|
tagId | string | รหัสแท็ก (UUID) |
accountId | number | รหัสบัญชีของคุณ |
name | string | ชื่อแท็ก |
isDeleted | boolean | false เสมอในผลลัพธ์นี้ |
createdBy | number | รหัสผู้ใช้ที่สร้าง |
createdAt | string | เวลาสร้าง (ISO 8601) |
updatedAt | string | เวลาแก้ไขล่าสุด (ISO 8601) |
ตัวอย่าง Request
bash
curl -X POST 'https://public-api.smsup-plus.com/Tag/requestTag' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"search": "vip",
"page": 1,
"pageSize": 50
}'js
const res = await fetch('https://public-api.smsup-plus.com/Tag/requestTag', {
method: 'POST',
headers: { Authorization: 'Bearer <API_KEY>', 'Content-Type': 'application/json' },
body: JSON.stringify({ search: 'vip', page: 1, pageSize: 50 }),
})
console.log(await res.json())ตัวอย่าง Response
json
{
"status": 200,
"data": [
{
"tagId": "a1c2e3f4-5b6d-4e7f-8a9b-0c1d2e3f4a5b",
"accountId": 1024,
"name": "VIP",
"isDeleted": false,
"createdBy": 2048,
"createdAt": "2026-11-16T03:10:00.000Z",
"updatedAt": "2026-11-16T03:10:00.000Z"
}
],
"total": 1,
"page": 1,
"pageSize": 50,
"totalPages": 1
}Error ที่อาจเจอ
| HTTP | Response | สาเหตุ |
|---|---|---|
| 200 | {"status":500,"description":"Failed to query tags."} | ค้นหาไม่สำเร็จ เช่น search เป็นรูปแบบ regex ที่ไม่ถูกต้อง |
| 401 | {"error":"invalid api key"} | API Key ไม่ถูกต้อง — ดู Error |
WARNING
เมื่อผ่านการยืนยันตัวตนแล้ว endpoint นี้ตอบ HTTP 200 เสมอ ให้ตรวจผลจากฟิลด์ status ใน body
TIP
search ถูกตีความเป็น regular expression — อักขระพิเศษอย่าง + ( ) . * ? ต้องใส่ \ นำหน้าถ้าต้องการค้นตามตัวอักษร
