การจัดการผู้ติดต่อ

ที่อยู่การโทร

ศูนย์ข้อมูล	URL
สิงคโปร์	https://email.api.engagelab.cc
ตุรกี	https://emailapi-tr.engagelab.com

เมื่อใช้ REST API ให้แน่ใจว่าศูนย์ข้อมูลที่เลือกตรงกับ URL พื้นฐานที่เหมาะสม

POST/v1/marketing/lists/members

เพิ่มหรืออัปเดตผู้ติดต่อเป็นชุด

URL

https://email.api.engagelab.cc/v1/marketing/lists/members

              
              https://email.api.engagelab.cc/v1/marketing/lists/members

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

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

POST

              
              POST

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

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

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

พารามิเตอร์ในเนื้อหา

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
members	array[object]	true	รายชื่อผู้ติดต่อ จำนวนสูงสุดคือ 1000
email	string	true	ที่อยู่อีเมล
phone	string	false	หมายเลขโทรศัพท์
name	string	false	ชื่อเล่น
fields	object	false	คุณสมบัติของผู้ติดต่อ
tags	string[]	false	รายชื่อแท็ก
tag_flag	integer	false	วิธีการอัปเดตแท็ก, 0: เขียนทับ, 1: เพิ่ม, 2: ข้าม, ค่าเริ่มต้นคือ 1
update_existing	boolean	true	อัปเดตคุณสมบัติหรือไม่ (หากที่อยู่นั้นมีอยู่ในรายการ)

หมายเหตุ:

หากฟิลด์ Email ของผู้ติดต่อจับคู่กับค่าของ members.email ผู้ติดต่อจะได้รับการอัปเดต มิฉะนั้นจะเพิ่มผู้ติดต่อใหม่
สำหรับค่าต่างๆ ของ tag_flag และวิธีการอัปเดตแท็กที่เกี่ยวข้อง ดูตัวอย่างด้านล่าง:

tag_flag	แท็กเดิม	แท็กในพารามิเตอร์	แท็กใหม่
0	[1,2,3]	[]	[]
0	[1,2,3]	null, ไม่ส่งผ่าน	[1,2,3]
0	[1,2,3]	[3,4,5]	[3,4,5]
1	[1,2,3]	[]	[1,2,3]
1	[1,2,3]	null, ไม่ส่งผ่าน	[1,2,3]
1	[1,2,3]	[3,4,5]	[1,2,3,4,5]
2	[1,2,3]	[]	[1,2,3]
2	[1,2,3]	null, ไม่ส่งผ่าน	[1,2,3]
2	[1,2,3]	[3,4,5]	[1,2,3]
2	[]	[3,4,5]	[]

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

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members --data '{"members":[{"email":"xjmfc@126.com","phone":"13681312919","name":"Zhusuosuo","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}],"tag_flag":0,"update_existing":true}'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' 
-i https://email.api.engagelab.cc/v1/marketing/lists/members 
--data '{"members":[{"email":"xjmfc@126.com","phone":"13681312919","name":"Zhusuosuo","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}],"tag_flag":0,"update_existing":true}'

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

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

Response-Success

HttpStatus: 200

{ "created_count": 2, "created_members": [{ "email": "202205ab233444444444446@qq.com", "member_id": "6294b0fa490f33c5ee3b5b0c" },{ "email": "202205ab3331@qq.com", "member_id": "6294b0fa490f33c5ee3b5b0d" }], "updated_count": 2, "updated_members": [{ "email": "202205ab233444444444447@qq.com", "member_id": "6294b0fa490f33c5ee3b5b1c" },{ "email": "202205ab3332@qq.com", "member_id": "6294b0fa490f33c5ee3b5b1d" }], "error_count": 2, "error_members": [{ "email": "202205ab233444444444446@qq.com", "message": "..." },{ "email": "202205ab3331@qq.com", "message": "..." }] }

              
              {
    "created_count": 2,
    "created_members": [{
            "email": "202205ab233444444444446@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b0c"
        },{
            "email": "202205ab3331@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b0d"
    }],
    "updated_count": 2,
    "updated_members": [{
            "email": "202205ab233444444444447@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b1c"
        },{
            "email": "202205ab3332@qq.com",
            "member_id": "6294b0fa490f33c5ee3b5b1d"
    }],
    "error_count": 2,
    "error_members": [{
            "email": "202205ab233444444444446@qq.com",
            "message": "..."
        },{
            "email": "202205ab3331@qq.com",
            "message": "..."
    }]
}

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

Response-Error

{ "code": 30000, "message": "Authentication failed" }

              
              {
    
    "code": 30000,
    "message": "Authentication failed"
      
}

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

ลบผู้ติดต่อรายเดียว

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

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

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

DELETE

              
               DELETE

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

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

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

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

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

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

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/8

              
              curl -X DELETE -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/8

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

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

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

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

ลบผู้ติดต่อเป็นชุด

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/delete

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/delete

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

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

DELETE

              
              DELETE

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

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

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

พารามิเตอร์ในเนื้อหา

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
condition	object	false	เงื่อนไขการค้นหา
relation	string	true	ความสัมพันธ์ของเงื่อนไข (and หรือ or)
items	object[]	true	เงื่อนไขการกรอง: รองรับสูงสุด 10 เงื่อนไขการกรอง, เงื่อนไขทั้งหมดต้องเป็น and หรือ or
field_name	string	true	field_name คือชื่อคุณสมบัติ, value คือค่าคุณสมบัติ; field_name คือ tag เมื่อ value = ชื่อแท็ก
op	string	true	ตัวดำเนินการ (== , != , > , >= , < , <= , exist , contain , does not contain)
value	string	true	เมื่อ field_name คือ tag, value = ชื่อแท็ก เมื่อ field_name คือชื่อคุณสมบัติ, รูปแบบตาม เงื่อนไขการกรอง

หมายเหตุ:

ความสัมพันธ์ระหว่าง field_name และ op สามารถพบได้ใน เงื่อนไขการกรอง

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

curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/delete --data ' { "condition": { "relation": "or", "items": [ { "field_name": "Email", "op": "contain", "value": "hotmail.com" }, { "field_name": "Phone", "op": "contain", "value": "188" } ] } } '

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/delete --data '
{
    "condition": {
        "relation": "or",
        "items": [
            {
                "field_name": "Email",
                "op": "contain",
                "value": "hotmail.com"
            },
            {
                "field_name": "Phone",
                "op": "contain",
                "value": "188"
            }
        ]
    }
}
'

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

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

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

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

อัปเดตผู้ติดต่อรายเดียว

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

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

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

PUT

PUT

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

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

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

พารามิเตอร์ในเนื้อหา

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
phone	string	false	หมายเลขโทรศัพท์
name	string	false	ชื่อเล่น
fields	object	false	คุณสมบัติของผู้ติดต่อ
tags	string[]	false	รายชื่อแท็ก

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

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2 --data '{"phone":"13681312919","name":"朱锁锁","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i 
https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2 
--data '{"phone":"13681312919","name":"朱锁锁","fields":{"Birthday":"03/30","Age":"12","customField":"My test"},"tags":["testTag"]}'

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

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

พารามิเตอร์	ประเภท	คำอธิบาย
member_id	string	รหัสผู้ติดต่อ
list_id	integer	รหัสรายการ
user_id	integer	รหัสผู้ใช้
email	string	ที่อยู่อีเมล
phone	string	หมายเลขโทรศัพท์
name	string	ชื่อ
create_time	string	เวลาสร้าง (UTC+8)
update_time	string	เวลาการอัปเดตการสมัครสมาชิก (UTC+8)
unsubscribe_time	string	เวลายกเลิกการสมัครสมาชิก (UTC+8)
fields	object	คุณสมบัติของผู้ติดต่อ
tags	string[]	คอลเลกชันรหัสแท็ก
tag_names	string[]	คอลเลกชันชื่อแท็ก

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

Response-Success

HttpStatus: 200

{ "count": 1 }

              
              {
     "count": 1
}

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

Response-Error

HttpStatus: 200

{ "code": 30036, "message": "resource not found" }

              
              {
    "code": 30036,
    "message": "resource not found"
}

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

รายละเอียดผู้ติดต่อ

URL

https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/members/{member_id}

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

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

GET

GET

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

Content-Type

application/x-www-form-urlencoded;charset=utf-8

              
              application/x-www-form-urlencoded;charset=utf-8

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

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

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

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

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2

              
              curl -X GET -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/members/62974a5e490f33c5eee647a2

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

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

พารามิเตอร์	ประเภท	คำอธิบาย
member_id	string	รหัสผู้ติดต่อ
list_id	integer	รหัสรายการ
email	string	ที่อยู่อีเมล
phone	string	หมายเลขโทรศัพท์
name	string	ชื่อ
create_time	string	เวลาสร้าง (UTC+8)
update_time	string	เวลาการอัปเดตการสมัครสมาชิก (UTC+8)
unsubscribe_time	string	เวลายกเลิกการสมัครสมาชิก (UTC+8)
fields	object	คุณสมบัติของผู้ติดต่อ
tag_ids	string[]	คอลเลกชันรหัสแท็ก
tag_names	string[]	คอลเลกชันชื่อแท็ก

Response-Success

HttpStatus: 200

{ "result": { "member_id": "6565c12a3b4e0d83d3f58ea0", "list_id": 95964, "email": "xjmfc@126.com", "phone": null, "name": null, "fields": { "Birthday": "03/30", "Age": "12" }, "tag_ids": [], "tag_names": [], "create_time": "2023-11-28T18:30:02+0800", "update_time": "2023-11-30T16:44:44+0800", "unsubscribe_time": null } }

              
              {
    "result": {
        "member_id": "6565c12a3b4e0d83d3f58ea0",
        "list_id": 95964,
        "email": "xjmfc@126.com",
        "phone": null,
        "name": null,
        "fields": {
            "Birthday": "03/30",
            "Age": "12"
        },
        "tag_ids": [],
        "tag_names": [],
        "create_time": "2023-11-28T18:30:02+0800",
        "update_time": "2023-11-30T16:44:44+0800",
        "unsubscribe_time": null
    }
}

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

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

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

รายการผู้ติดต่อ

URL

https://email.api.engagelab.cc/v1/marketing/lists/list_members

              
              https://email.api.engagelab.cc/v1/marketing/lists/list_members

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

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

POST

              
              POST

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

Request-Headers

Header	Type	Required	Description
Authorization	string	true	Basic base64(api_user:api_key)

Query-Parameters

Parameter	Type	Required	Description
limit	integer	false	จำนวนรายการที่จะดึงข้อมูล ช่วง [1-100] ค่าเริ่มต้นคือ 10
offset	integer	false	ตำแหน่งเริ่มต้นของการดึงข้อมูล ช่วง [0-] ค่าเริ่มต้นคือ 0

Body-Parameters

Parameter	Type	Required	Description
condition	object	false	เงื่อนไขการดึงข้อมูล
relation	string	true	ความสัมพันธ์ของเงื่อนไข (and หรือ or)
items	object[]	true	เงื่อนไขการกรองข้อมูล รองรับสูงสุด 10 เงื่อนไขการกรอง โดยเงื่อนไขทั้งหมดจะต้องเป็น "and" หรือ "or" ตามความสัมพันธ์ที่ระบุ
field_name	string	true	field_name แทนชื่อฟิลด์ และ value แทนค่าของฟิลด์ เมื่อ field_name เป็น tag value=ชื่อแท็ก
op	string	true	ตัวดำเนินการ (==, !=, >, >=, <, <=, exist, contain, does not contain)
value	string	true	เมื่อ field_name เป็น tag value=ชื่อแท็ก เมื่อ field_name เป็นชื่อฟิลด์ โปรดอ้างอิงรูปแบบของ value filter-conditions

หมายเหตุ:

โปรดอ้างอิงความสัมพันธ์ระหว่าง field_name และ op filter-conditions

Request-Example

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/listMembers?offset=0&limit=10 --data '{ "condition": { "relation": "and", "items": [ { "field_name": "Email", "op": "contain", "value": "qq.com" } ] } }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/listMembers?offset=0&limit=10 --data '{
    "condition": {
        "relation": "and",
        "items": [
            { 
              "field_name": "Email",
              "op": "contain",
              "value": "qq.com"
            }
        ]
    }
}'

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

พารามิเตอร์การตอบสนอง

พารามิเตอร์	ประเภท	คำอธิบาย
list	array	อาร์เรย์รายการ
member_id	string	รหัสสมาชิก
list_id	integer	รหัสรายการ
email	string	ที่อยู่อีเมล
phone	string	หมายเลขโทรศัพท์
name	string	ชื่อ
create_time	string	เวลาสร้าง (UTC+8)
update_time	string	เวลาการอัปเดตการสมัคร (UTC+8)
unsubscribe_time	string	เวลายกเลิกการสมัคร (UTC+8)
fields	object	คุณสมบัติสมาชิก
tag_ids	string[]	ชุดรหัสแท็ก
tag_names	string[]	ชุดชื่อแท็ก
total	integer	จำนวนบันทึกรวม

ตัวอย่างการตอบสนอง

Response-Success

HttpStatus: 200

{ "result": [ { "member_id": "6565c12a3b4e0d83d3f58ea0", "list_id": 95964, "email": "xjmfc@126.com", "phone": null, "name": null, "fields": { "Birthday": "03/30", "Age": "12" }, "tag_ids": [], "tag_names": [], "create_time": "2023-11-28T18:30:02+0800", "update_time": "2023-11-30T17:00:19+0800", "unsubscribe_time": null } ], "total": 3, "count": 1 }

              
              {
    "result": [
        {
            "member_id": "6565c12a3b4e0d83d3f58ea0",
            "list_id": 95964,
            "email": "xjmfc@126.com",
            "phone": null,
            "name": null,
            "fields": {
                "Birthday": "03/30",
                "Age": "12"
            },
            "tag_ids": [],
            "tag_names": [],
            "create_time": "2023-11-28T18:30:02+0800",
            "update_time": "2023-11-30T17:00:19+0800",
            "unsubscribe_time": null
        }
    ],
    "total": 3,
    "count": 1
}

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

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }

              
              {
    "code": 30000,
    "message": "Authentication failed"
}

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