แท็ก

อินเทอร์เฟซต่อไปนี้สามารถใช้สำหรับการค้นหา เพิ่ม แก้ไข และลบแท็ก SMS

ค้นหาแท็กเดียว

ส่งคืนข้อมูลพื้นฐานเกี่ยวกับแท็ก SMS

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_id}

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

GET

GET

โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	true	Basic base64(sms_user:sms_key)

ตัวอย่างคำขอ

curl -X GET "https://sms.api.engagelab.cc/v1/labels/598802" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/labels/598802" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

ฟิลด์	คำอธิบาย
label_id	รหัสแท็ก
label_name	ชื่อแท็ก
create_time	เวลาสร้าง
update_time	เวลาอัปเดต

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "result": { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }

              
              {
        "result": 
            {
                "label_id": 598802,
                "label_name": "xjm226",
                "create_time": "2022-11-14T14:27:48+0800",
                "update_time": "2022-11-14T14:27:48+0800"
            }
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :400

{ "code": 34020, "message": "label_id must be a integer" }

              
              {
  "code": 34020,
  "message": "label_id must be a integer"
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

ค้นหาแท็กหลายรายการ

ส่งคืนข้อมูลพื้นฐานเกี่ยวกับแท็ก SMS

URL

https://sms.api.engagelab.cc/v1/labels

              
              https://sms.api.engagelab.cc/v1/labels

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

GET

GET

โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	String	true	Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์การค้นหา

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
offset	Integer	No	ตำแหน่งเริ่มต้นการค้นหา, ช่วง [0-], ค่าเริ่มต้นคือ 0
limit	Integer	No	จำนวนการค้นหา, ช่วง [0-100], ค่าเริ่มต้นคือ 100
label_name	string	No	ชื่อแท็ก, รองรับการค้นหาแบบคลุมเครือ

ตัวอย่างคำขอ

curl -X GET "https://sms.api.engagelab.cc/v1/labels?label_name=test" --header "Authorization: Basic <<YOUR_AUTHORIZATION_KEY>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/labels?label_name=test" 
--header "Authorization: Basic <<YOUR_AUTHORIZATION_KEY>>"

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

ฟิลด์	คำอธิบาย
label_id	รหัสแท็ก
label_name	ชื่อแท็ก
create_time	เวลาสร้าง
update_time	เวลาอัปเดต

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "result": [ { "create_time": "2022-11-14T14:27:48+0800", "label_id": 10, "label_name": "test", "update_time": "2022-11-14T14:27:48+0800" } ] "total": 28, "count": 1 }

              
              {
        
        "result": [
           {
                "create_time": "2022-11-14T14:27:48+0800",
                "label_id": 10,
                "label_name": "test",
                "update_time": "2022-11-14T14:27:48+0800"
            }
        ]
        "total": 28,
        "count": 1
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }

              
              {  
    "code": 30000,
    "message": "Unauthorized."
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

เพิ่มแท็ก

ส่งคืนข้อมูลพื้นฐานของแท็ก SMS หลังจากเพิ่มสำเร็จ

URL

https://sms.api.engagelab.cc/v1/labels

              
              https://sms.api.engagelab.cc/v1/labels

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

POST

              
              POST

โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-type

application/json

              
              application/json

โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	string	true	Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
label_name	string	Yes	ชื่อแท็ก, สูงสุด 64 ตัวอักษร

หมายเหตุ:

ขีดจำกัดสูงสุดสำหรับการสร้างแท็กคือ 100,000

ตัวอย่างคำขอ

curl -X POST "https://sms.api.engagelab.cc/v1/labels" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name": "test2" }'

              
              curl -X POST "https://sms.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "label_name": "test2"
}'

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

ฟิลด์	คำอธิบาย
label_id	รหัสแท็ก
label_name	ชื่อแท็ก
create_time	เวลาสร้าง
update_time	เวลาอัปเดต

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "result": { "label_id": 11, "label_name": "test", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }

              
              {
        "result": {
            "label_id": 11,
            "label_name": "test",
            "create_time": "2022-11-14T14:27:48+0800",
            "update_time": "2022-11-14T14:27:48+0800"
        }
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

อัปเดตแท็ก

ส่งคืนข้อมูลพื้นฐานของแท็ก SMS หลังจากอัปเดตสำเร็จ

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_id}

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

PUT

PUT

โค้ดนี้โชว์เป็นหน้าต่างลอย

Content-type

application/json

              
              application/json

โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	String	true	Basic base64(sms_user:sms_key)

คำอธิบายพารามิเตอร์

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
label_name	string	Yes	ชื่อแท็ก, สูงสุด 64 ตัวอักษร

ตัวอย่างคำขอ

curl -X PUT "https://sms.api.engagelab.cc/v1/labels/11" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name": "test3" }'

              
              curl -X PUT "https://sms.api.engagelab.cc/v1/labels/11"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "label_name": "test3"
}'

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

พารามิเตอร์	คำอธิบาย
count	จำนวนการอัปเดตที่สำเร็จ

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "count":1 }

              
              {
    "count":1
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

ลบแท็ก

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_id}

โค้ดนี้โชว์เป็นหน้าต่างลอย

วิธีการร้องขอ HTTP

DELETE

              
              DELETE

โค้ดนี้โชว์เป็นหน้าต่างลอย

ส่วนหัวของคำขอ

ส่วนหัว	ประเภท	จำเป็น	คำอธิบาย
Authorization	String	true	Basic base64(sms_user:sms_key)

ตัวอย่างคำขอ

curl -X DELETE "https://sms.api.engagelab.cc/v1/labels/11" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://sms.api.engagelab.cc/v1/labels/11" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำอธิบายการตอบกลับ

พารามิเตอร์	คำอธิบาย
count	จำนวนการลบที่สำเร็จ

ตัวอย่างการตอบกลับ

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

Response-error

HTTP Status :401

{ "code": 30000, "message": "Unauthorized." }

              
              {
    "code": 30000,
    "message": "Unauthorized."
}

โค้ดนี้โชว์เป็นหน้าต่างลอย