ป้ายอีเมล
ป้ายช่วยให้ผู้ใช้มีมิติพิเศษสำหรับสถิติอีเมล
คุณสามารถใช้ API เพื่อค้นหา เพิ่ม ลบ และแก้ไขป้ายได้
การค้นหา (การค้นหาแบบกลุ่ม)
ส่งคืนรายการข้อมูลป้าย
URL
https://email.api.engagelab.cc/v1/labels
https://email.api.engagelab.cc/v1/labels
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
พารามิเตอร์คำขอการค้นหา
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| offset | int | ไม่ | ตำแหน่งเริ่มต้นสำหรับการค้นหา ช่วง [0-] ค่าเริ่มต้นคือ 0 |
| limit | int | ไม่ | จำนวนรายการที่จะค้นหา ช่วง [0-100] ค่าเริ่มต้นคือ 100 |
| label_name | string | ไม่ | การค้นหาแบบคลุมเครือ |
ตัวอย่างคำขอ
curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| ฟิลด์ | คำอธิบาย |
|---|---|
| label_id | รหัสป้าย |
| label_name | ชื่อป้าย |
| create_time | เวลาสร้างป้าย |
| update_time | เวลาปรับปรุงป้าย |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-14T14:27:48+0800",
"update_time": "2022-11-14T14:27:48+0800"
}
]
}
{
"total": 28,
"count": 28,
"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 :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การค้นหา
URL
https://email.api.engagelab.cc/v1/labels/{label_id}
https://email.api.engagelab.cc/v1/labels/{label_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
ตัวอย่างคำขอ
curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| ฟิลด์ | คำอธิบาย |
|---|---|
| label_id | รหัสป้าย |
| label_name | ชื่อป้าย |
| create_time | เวลาสร้างป้าย |
| update_time | เวลาปรับปรุงป้าย |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"result": {
"label_id": 598100,
"label_name": "xiaoxiao"
"create_time": "2022-08-09T13:49:46+0800",
"update_time": "2022-11-12T14:12:12+0800"
}
}
{
"result": {
"label_id": 598100,
"label_name": "xiaoxiao"
"create_time": "2022-08-09T13:49:46+0800",
"update_time": "2022-11-12T14:12:12+0800"
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การเพิ่ม
URL
https://email.api.engagelab.cc/v1/labels
https://email.api.engagelab.cc/v1/labels
โค้ดนี้โชว์เป็นหน้าต่างลอย
Content-Type:
application/json; charset=utf-8
application/json; charset=utf-8
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
POST
POST
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์ในเนื้อหา
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| label_name | string | ใช่ | ชื่อป้ายที่ต้องการเพิ่ม ความยาวสูงสุด 64 ตัวอักษร |
หมายเหตุ: ขีดจำกัดสูงสุดสำหรับการสร้างป้ายคือ 100,000
ตัวอย่างคำขอ
curl -X POST "https://email.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"hongkong",
}'
curl -X POST "https://email.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"hongkong",
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| ฟิลด์ | คำอธิบาย |
|---|---|
| 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:34+0800",
"update_time": "2022-11-14T14:27:34+0800"
}
}
{
"result": {
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-14T14:27:34+0800",
"update_time": "2022-11-14T14:27:34+0800"
}
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :400
{
"code": 30105,
"message": "The label name should be 1-255 characters"
}
{
"code": 30105,
"message": "The label name should be 1-255 characters"
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การลบ
URL
https://email.api.engagelab.cc/v1/labels/{label_id}
https://email.api.engagelab.cc/v1/labels/{label_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
DELETE
DELETE
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
ตัวอย่างคำขอ
curl -X DELETE "https://email.api.engagelab.cc/v1/labels/21122"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://email.api.engagelab.cc/v1/labels/21122"
--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": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
การแก้ไข
URL
https://email.api.engagelab.cc/v1/labels/{label_id}
https://email.api.engagelab.cc/v1/labels/{label_id}
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
PUT
PUT
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำขอ
| ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์ในเนื้อหา
| พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
|---|---|---|---|
| label_name | string | ใช่ | ชื่อป้ายใหม่ ความยาวสูงสุด 64 ตัวอักษร |
ตัวอย่างคำขอ
curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"travel",
}'
curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"travel",
}'
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
| ฟิลด์ | คำอธิบาย |
|---|---|
| count | จำนวนรายการที่แก้ไขสำเร็จ |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
โค้ดนี้โชว์เป็นหน้าต่างลอย
