รายการที่อยู่
รายการที่อยู่ถูกใช้สำหรับการส่งแบบกลุ่มโดยผู้ใช้
คุณสามารถใช้ API เพื่อค้นหา เพิ่ม แก้ไข และลบรายการที่อยู่
คุณยังสามารถค้นหา เพิ่ม แก้ไข และลบสมาชิกในรายการที่อยู่ได้
ค้นหารายการที่อยู่ (ค้นหาแบบกลุ่ม)
URL
https://email.api.engagelab.cc/v1/address_lists
วิธีการร้องขอ HTTP
GET
ส่วนหัวของคำขอ
ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์การค้นหา
พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
offset | int | ไม่ | ตำแหน่งเริ่มต้นการค้นหา ช่วง [0-] ค่าเริ่มต้นคือ 0 |
limit | int | ไม่ | จำนวนการค้นหา ช่วง [0-100] ค่าเริ่มต้นคือ 100 |
name | string | ไม่ | ชื่อรายการ ค้นหาแบบคลุมเครือ |
address | string | ไม่ | ที่อยู่นามแฝง ค้นหาแบบตรง |
ตัวอย่างคำขอ
curl 'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='
คำอธิบายการตอบกลับ
ฟิลด์ | คำอธิบาย |
---|---|
address_list_id | รหัสรายการที่อยู่ |
name | ชื่อรายการ |
address | ที่อยู่นามแฝง ใช้สำหรับการเรียกใช้ รูปแบบคือ xxx@maillist.email.engagelab.com |
member_count | จำนวนที่อยู่ในรายการที่อยู่ |
desc | คำอธิบายรายการที่อยู่ |
create_time | เวลาสร้างรายการที่อยู่ |
update_time | เวลาปรับปรุงรายการที่อยู่ |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"result": [
{
"address_list_id": 65499,
"address": "jg2@maillist.email.engagelab.com",
"name": "1113-mailist",
"member_count": 2,
"Description": "desc222ss",
"create_time": "2022-11-12T16:46:12+0800",
"update_time": "2022-11-12T16:50:01+0800"
}
],
"total": 1,
"count": 1
}
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
ค้นหารายการที่อยู่
https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
วิธีการร้องขอ HTTP
GET
ส่วนหัวของคำขอ
ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
ตัวอย่างคำขอ
curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
คำอธิบายการตอบกลับ
ฟิลด์ | คำอธิบาย |
---|---|
address_list_id | รหัสรายการที่อยู่ |
name | ชื่อรายการ |
address | ที่อยู่นามแฝง ใช้สำหรับการเรียกใช้ รูปแบบคือ xxx@maillist.email.engagelab.com |
member_count | จำนวนที่อยู่ในรายการที่อยู่ |
desc | คำอธิบายรายการที่อยู่ |
create_time | เวลาสร้างรายการที่อยู่ |
update_time | เวลาปรับปรุงรายการที่อยู่ |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"result":
{
"address_list_id": 65499,
"address": "jg2@maillist.email.engagelab.com",
"name": "1113-mailist",
"member_count": 2,
"Description": "desc222ss",
"create_time": "2022-11-12T16:46:12+0800",
"update_time": "2022-11-12T16:50:01+0800"
}
}
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
เพิ่มรายการที่อยู่
URL
https://email.api.engagelab.cc/v1/address_lists
Content-Type:
Content-Type: application/json;charset=utf-8
วิธีการร้องขอ HTTP
POST
ส่วนหัวของคำขอ
ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
พารามิเตอร์ในเนื้อหา
พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
name | string | ใช่ | ชื่อรายการ สูงสุด 48 ตัวอักษร |
address | string | ใช่ | ที่อยู่นามแฝง รูปแบบที่อยู่อีเมล เช่น marketing@maillist.email.engagelab.com |
desc | string | ไม่ | คำอธิบาย สูงสุด 255 ตัวอักษร |
ตัวอย่างคำขอ
curl -X POST "https://email.api.engagelab.cc/v1/address_lists"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"address":"scgd@email.engagelab.com",
"name":"hongKong",
"desc":""
}'
คำอธิบายการตอบกลับ
ฟิลด์ | คำอธิบาย |
---|---|
address_list_id | รหัสรายการ |
name | ชื่อรายการ |
address | ที่อยู่นามแฝง |
member_count | จำนวนที่อยู่ในรายการ |
desc | คำอธิบายรายการ |
create_time | เวลาสร้างรายการที่อยู่ |
update_time | เวลาปรับปรุงรายการที่อยู่ |
ตัวอย่างการตอบกลับ
response success
{
"result": {
"address_list_id": 65504,
"address": "jg3@maillist.email.engagelab.com",
"name": "1113-mailist",
"member_count": 0,
"desc": "desc",
"create_time": "2022-11-15T16:25:02+0800",
"update_time": "2022-11-15T16:25:02+0800"
}
}
response error
{
"code": 30000,
"message": "Authentication failed."
}
ลบรายการที่อยู่
URL
https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
วิธีการร้องขอ HTTP
DELETE
ส่วนหัวของคำขอ
ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
ตัวอย่างคำขอ
curl -X DELETE "https://email.api.engagelab.cc/v1/address_list/2112423"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
คำอธิบายการตอบกลับ
พารามิเตอร์ | คำอธิบาย |
---|---|
count | จำนวนรายการที่ลบสำเร็จ |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"count": 1
}
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
แก้ไขรายการที่อยู่
URL
https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
Content-Type:
Content-Type: application/json;charset=utf-8
วิธีการร้องขอ HTTP
PUT
ส่วนหัวของคำขอ
ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์ในเนื้อหา
พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
address | string | ไม่ | ที่อยู่นามแฝง ใช้สำหรับการเรียกใช้ รูปแบบคือ xxx@@maillist.email.engagelab.com |
name | string | ไม่ | ชื่อรายการที่แก้ไข สูงสุด 48 ตัวอักษร |
desc | string | ไม่ | คำอธิบายรายการที่แก้ไข สูงสุด 255 ตัวอักษร |
คำอธิบาย
การรวมกันของ 【name】หรือ【desc】
ตัวอย่างคำขอ
curl -X PUT "https://email.api.engagelab.cc/v1/address_lists"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"address":"new@maillist.email.engagelab.com",
"name":"GZ",
"desc":"2"
}'
คำอธิบายการตอบกลับ
ฟิลด์ | คำอธิบาย |
---|---|
count | จำนวนรายการที่แก้ไขสำเร็จ |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"count": 1
}
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
ค้นหาสมาชิกในรายการ
URL
https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
วิธีการร้องขอ HTTP
GET
ส่วนหัวของคำขอ
ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์การค้นหา
พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
offset | int | ไม่ | ตำแหน่งเริ่มต้นการค้นหา ช่วง [0-] ค่าเริ่มต้นคือ 0 |
limit | int | ไม่ | จำนวนการค้นหา ช่วง [0-100] ค่าเริ่มต้นคือ 100 |
string | ไม่ | ค้นหาที่อยู่อีเมลของสมาชิก รองรับการค้นหาแบบคลุมเครือ | |
member_ids | string | ไม่ | รหัสสมาชิก แยกด้วยเครื่องหมายอัฒภาค สูงสุด 100 รายการ |
ตัวอย่างคำขอ
curl "https://email.api.engagelab.cc/v1/address_lists/123/members?offset=0&limit=20 --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
คำอธิบายการตอบกลับ
ฟิลด์ | คำอธิบาย |
---|---|
member_id | รหัสสมาชิก |
ที่อยู่อีเมลของสมาชิก | |
name | ชื่อสมาชิก |
vars | ตัวแปร |
create_time | เวลาสร้าง |
update_time | เวลาปรับปรุง |
ตัวอย่างการตอบกลับ Response-success
HTTP Status: 200
{
"result": [
{
"member_id": "11719293",
"email": "example2@abc.com",
"name": null,
"vars": "{\"loc\":\"sss\"}",
"create_time": "2022-11-13 11:23:44",
"update_time": "2022-11-13 11:23:44"
},
{
"member_id": "11719294",
"email": "example5@abc.com",
"name": null,
"vars": "{\"loc\":\"sss\"}",
"create_time": "2022-11-15 16:34:47",
"update_time": "2022-11-15 16:34:47"
}
],
"total": 2,
"count": 2,
"address_list_id": "65499"
}
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
เพิ่มสมาชิกในรายการ
URL
https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
Content-Type:
application/json; charset=utf-8
วิธีการร้องขอ HTTP
POST
ส่วนหัวของคำขอ
ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์ในเนื้อหา
พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
members | array[object] | ใช่ | สมาชิก สูงสุด 1000 รายการ |
string | ใช่ | ที่อยู่อีเมลของสมาชิก รูปแบบอีเมล | |
name | string | ไม่ | ชื่อเล่น สูงสุด 128 ตัวอักษร |
vars | object | ไม่ | ตัวแปร ขนาดสูงสุด 1KB |
คำอธิบาย
1.เมื่อเพิ่มตัวแปร vars โปรดทราบว่าคีย์ไม่จำเป็นต้องรวม '%' และความยาวของคีย์ต้องไม่เกิน 32 ตัวอักษร
2.ในตัวแปร vars ตัวแปรที่มีชื่อคีย์จะถูกเขียนทับโดยพารามิเตอร์ name
3.เมื่อส่งรายการที่อยู่ คุณสามารถใช้ตัวแปร global recipient ซึ่งเป็นที่อยู่อีเมลของผู้รับ
ตัวอย่างคำขอ
curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'
คำอธิบายการตอบกลับ
ฟิลด์ | คำอธิบาย |
---|---|
count | จำนวนที่อยู่ที่เพิ่มสำเร็จ |
invalid | ที่อยู่ที่ล้มเหลว |
invalidCount | จำนวนที่อยู่อีเมลที่ล้มเหลว |
reasonList | เหตุผลสำหรับที่อยู่อีเมลที่ล้มเหลว (สอดคล้องกับรายละเอียดที่อยู่แบบหนึ่งต่อหนึ่ง) |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"result": {
"count": 2,
"invalidCount": 1,
"invalid": [
"wang.@yahoo.com"
],
"reasonList": [
"Member email format erorr"
]
}
}
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
แก้ไขสมาชิกในรายการ
URL
https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}
Content-Type:
application/json; charset=utf-8
วิธีการร้องขอ HTTP
PUT
ส่วนหัวของคำขอ
ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์ในเนื้อหา
พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
string | ไม่ | ที่อยู่อีเมลของสมาชิก รูปแบบอีเมล | |
name | string | ไม่ | ชื่อเล่น สูงสุด 128 ตัวอักษร |
vars | object | ไม่ | ตัวแปร ขนาดสูงสุด 1KB ความยาวคีย์ต้องไม่เกิน 32 ตัวอักษร |
ตัวอย่างคำขอ
curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{"email":"x@engagelab.com","name":"jim"}'
คำอธิบายการตอบกลับ
ฟิลด์ | คำอธิบาย |
---|---|
count | จำนวนที่อยู่ที่แก้ไขสำเร็จ |
reason | เหตุผลที่ล้มเหลว (ฟิลด์นี้จะไม่มีเมื่อสำเร็จ) |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{
"count": 0,
"reason": "Member email format erorr"
}
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}
ลบสมาชิกในรายการ
URL
https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
วิธีการร้องขอ HTTP
DELETE
ส่วนหัวของคำร้อง
ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
Authorization | string | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์การค้นหา
พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
member_ids | string | yes | ที่อยู่ของสมาชิกที่ต้องการลบ แยกหลายที่อยู่ด้วย ; ได้สูงสุด 100 สมาชิก |
ตัวอย่างคำร้อง
curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
คำอธิบายการตอบกลับ
ฟิลด์ | คำอธิบาย |
---|---|
count | จำนวนที่อยู่ที่ลบสำเร็จ |
ตัวอย่างการตอบกลับ
Response-success
HTTP Status: 200
{ "count": 1}
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Authentication failed."
}