แคมเปญ
ที่อยู่สำหรับเรียกใช้
| ศูนย์ข้อมูล | URL |
|---|---|
| สิงคโปร์ | https://email.api.engagelab.cc |
| ตุรกี | https://emailapi-tr.engagelab.com |
| สหรัฐอเมริกา | https://emailapi-us.engagelab.com |
เมื่อใช้ REST API โปรดตรวจสอบว่าศูนย์ข้อมูลที่เลือกสอดคล้องกับ URL ฐานที่เหมาะสม
POST/v1/marketing/campaigns
สร้าง
URL
https://email.api.engagelab.cc/v1/marketing/campaigns
วิธีการร้องขอ HTTP
POST
Content-Type
application/json; charset=utf-8
ส่วนหัวของคำขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
พารามิเตอร์เนื้อหา
| พารามิเตอร์ | Type | จำเป็น | คำอธิบาย |
|---|---|---|---|
| campaign_type | integer | true | ประเภทงาน: 1 สำหรับการทดสอบ A/B, 2 สำหรับแคมเปญปกติ |
| name | string | true | ชื่องาน (สูงสุด 64 ตัวอักษร) |
| to | object[] | true | ผู้รับ ปัจจุบันรองรับความยาวอาร์เรย์ 1 |
| reply_to | string | false | ที่อยู่สำหรับตอบกลับ |
| sender_id | string | * | ID ผู้ส่ง (รองรับเฉพาะแคมเปญปกติ) |
| template_invoke_name | string | * | ชื่อเรียกใช้เทมเพลต (รองรับเฉพาะแคมเปญปกติ) |
| subject | string | * | หัวข้ออีเมล มีลำดับความสำคัญเหนือหัวข้อที่ฝังไว้ในเทมเพลต จำเป็นหากการทดสอบ A/B เป็นการทดสอบเนื้อหา |
| send_time | string | * | เวลาส่ง (รองรับเฉพาะงานปกติ) รูปแบบ: "YYYY-MM-DD HH:mm:ss" |
| time_zone | string | * | เขตเวลาเริ่มต้น (+8 ตามค่าเริ่มต้น) ตัวอย่างเช่น +8 |
| attachments | object[] | false | ไฟล์แนบอีเมล (สูงสุด 10 ไฟล์แนบ) |
| file_name | string | false | ชื่อไฟล์แนบ เช่น example.pdf |
| content | string | false | เนื้อหาไฟล์แนบในการเข้ารหัส base64 |
| ab_test | object | * | พารามิเตอร์การตั้งค่าการทดสอบ A/B (รองรับเฉพาะการทดสอบ A/B) |
| google_track | object | false | พารามิเตอร์การตั้งค่า Google Track (รองรับเฉพาะแคมเปญปกติ) |
| warm_up | object[] | false | พารามิเตอร์การตั้งค่าการส่งแบบวอร์มอัพ (รองรับเฉพาะแคมเปญปกติ) |
หมายเหตุ:
ขนาดรวมของไฟล์แนบทั้งหมดต้องไม่เกิน 10MB โปรดทราบว่าขนาดไฟล์จะเพิ่มขึ้นเล็กน้อยหลังการเข้ารหัส base64 ขีดจำกัด 10MB หมายถึงขนาดก่อนการเข้ารหัส base64
template_invoke_nameต้องอ้างอิงถึงเทมเพลตแบบกลุ่ม (template_type=1) เทมเพลตแบบทริกเกอร์ (template_type=0) ไม่สามารถใช้สำหรับแคมเปญได้ สำหรับtoให้ใช้allสำหรับlistและใช้ ID ของเซกเมนต์หรือ ID ของแท็กสำหรับsegmentหรือtagตามลำดับ
รูปแบบ 5 แบบของพารามิเตอร์ "to" มีดังนี้:
[
{
"type": "list",
"value": ["all"]
}
]
[
{
"type": "tag",
"value": ["62386112014b7b2f912fddd1"]
}
]
[
{
"type": "not_tag",
"value": ["62386112014b7b2f912fddd3"]
}
]
[
{
"type": "segment",
"value": ["62386112014b7b2f912fddd2"]
}
]
[
{
"type": "not_segment",
"value": ["62386112014b7b2f912fddd4"]
}
]
[
{
"type": "tag",
"value": ["62386112014b7b2f912fddd1"]
},
{
"type": "not_tag",
"value": ["62386112014b7b2f912fddd3"]
}
]
> หมายเหตุ: `type` อาจเป็น `list` (รายชื่อติดต่อทั้งหมด ค่าคงที่เป็น `["all"]`), `tag` (แท็ก), `not_tag` (แท็กที่ไม่รวม), `segment` (เซกเมนต์) หรือ `not_segment` (เซกเมนต์ที่ไม่รวม); `value` เป็นอาร์เรย์ของ ID ที่เกี่ยวข้อง `not_tag` และ `not_segment` เป็นฟีเจอร์ที่เพิ่มเข้ามาใหม่
รูปแบบของพารามิเตอร์ "ab_test" มีดังนี้:
เมื่อแคมเปญเป็นการทดสอบ A/B พารามิเตอร์ "ab_test" เป็นสิ่งจำเป็น
| พารามิเตอร์ | Type | จำเป็น | คำอธิบาย |
|---|---|---|---|
| ab_test | object | true | ข้อมูลการตั้งค่าการทดสอบ A/B |
| percent | integer | true | การตั้งค่าเปอร์เซ็นต์ ช่วง [1, 100] ตัวอย่างเช่น 20 หมายความว่าผู้ติดต่อ 20% จะถูกเลือกเป็นผู้รับทดสอบ ส่วนที่เหลือจะถูกส่งตามเงื่อนไขผู้ชนะ |
| win_condition | object | true | กำหนดเงื่อนไขผู้ชนะของการทดสอบ A/B |
| time_unit | string | true | หน่วยเวลา: day, hour |
| after_time | integer | true | ระยะเวลารอก่อนคำนวณเงื่อนไขผู้ชนะ หากหน่วยเวลาเป็นชั่วโมง ช่วงคือ [0-23] หากหน่วยเวลาเป็นวัน ช่วงคือ [0-10] |
| compare | string | true | ฟิลด์เปรียบเทียบ ค่าที่เป็นไปได้: open_percent, click_percent, uni_open_percent, uni_click_percent, delivered_percent |
| template_invoke_names | string[] | * | การทดสอบเทมเพลต ค่า template_invoke_name จะถูกละเว้น และ subject เป็นสิ่งจำเป็น |
| sender_ids | string[] | * | การทดสอบ ID ผู้ส่ง ค่า sender_id จะถูกละเว้น |
| send_times | string[] | * | การทดสอบเวลาส่ง ค่า send_time จะถูกละเว้น |
| subjects | string[] | * | การทดสอบหัวข้ออีเมล ค่า subject จะถูกละเว้น |
ตัวอย่างมีดังนี้:
// A/B testing, different email subjects
"ab_test": {
"percent": 20,
"win_condition": {
"time_unit": "hour",
"after_time": 18,
"compare": "open_percent"
},
"subjects": []
}
// A/B testing, different email templates
"ab_test": {
"percent": 20,
"win_condition": {
"time_unit": "hour",
"after_time": 18,
"compare": "open_percent"
},
"template_invoke_names": []
}
// A/B testing, different senders
"ab_test": {
"percent": 20,
"win_condition": {
"time_unit": "hour",
"after_time": 18,
"compare": "open_percent"
},
"sender_ids": []
}
// A/B testing, different sending times.
"ab_test": {
"percent": 20,
"win_condition": {
"time_unit": "hour",
"after_time": 18,
"compare": "open_percent"
},
"send_times": []
}
หมายเหตุ:
- การตั้งค่า ab_test ปัจจุบันรองรับรายการทดสอบเดียวเท่านั้น
รูปแบบของพารามิเตอร์ google_track มีดังนี้:
เมื่อตั้งค่าพารามิเตอร์ google_track ระบบจะเพิ่มพารามิเตอร์เหล่านี้ไปยังลิงก์ในอีเมล ช่วยให้ติดตามการเข้าชมของลูกค้าจากแคมเปญไปยังเว็บไซต์ของคุณ และเปิดใช้งานการวิเคราะห์ใน Google Analytics
| พารามิเตอร์ | Type | จำเป็น | คำอธิบาย |
|---|---|---|---|
| google_track | object | false | พารามิเตอร์การตั้งค่า Google Track |
| campaign_name | string | false | ชื่อแคมเปญ (สูงสุด 64 ตัวอักษร) |
| campaign_source | string | false | แหล่งที่มา (สูงสุด 64 ตัวอักษร) |
| campaign_medium | string | false | สื่อ (สูงสุด 64 ตัวอักษร) |
| campaign_term | string | false | คำสำคัญ (สูงสุด 64 ตัวอักษร) |
| campaign_content | string | false | เนื้อหา (สูงสุด 64 ตัวอักษร) |
ตัวอย่างมีดังนี้:
"google_track": {
"campaign_name":"",
"campaign_source":"",
"campaign_medium":"",
"campaign_term":"",
"campaign_content":""
}
รูปแบบของพารามิเตอร์ "warm_up" มีดังนี้:
การส่งแบบวอร์มอัพช่วยให้ตั้งค่าจำนวนอีเมลต่อชั่วโมงหรือต่อวันสำหรับโดเมนผู้รับเฉพาะได้ ซึ่งสามารถปรับปรุงความสามารถในการส่งถึงได้ นอกจากนี้ อัตราการส่งยังสามารถปรับได้ตามความสามารถในการส่งถึงที่สังเกตได้
| พารามิเตอร์ | Type | จำเป็น | คำอธิบาย |
|---|---|---|---|
| warm_up | object[] | false | พารามิเตอร์การตั้งค่าการส่งแบบวอร์มอัพ ความยาวสูงสุด 20 |
| domain | string | true | โดเมนของผู้รับ |
| rate | integer | true | ระดับอัตราการส่ง |
| upgrade_value | float | true | เกณฑ์ความสามารถในการส่งถึงสำหรับการเพิ่มอัตรา เป็นค่าทศนิยมระหว่าง (0,1] |
| downgrade_value | float | true | เกณฑ์ความสามารถในการส่งถึงสำหรับการลดอัตรา เป็นค่าทศนิยมระหว่าง (0,1] |
ตัวอย่างมีดังนี้:
"warm_up": [{
"domain": "gmail.com",
"rate": 1,
"upgrade_value": "0.95",
"downgrade_value": "0.75"
}, {
"domain": "hotmail.com",
"rate": 3,
"upgrade_value": "0.95",
"downgrade_value": "0.75"
}]
ตัวอย่างคำขอ
สร้างแคมเปญปกติ
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns --data '{
"campaign_type": 2,
"name": "11.11_leon_api8",
"to":[{
"type": "tag",
"value": ["62386112014b7b2f912fddd1"]
}],
"sender_id": "53",
"reply_to": "",
"template_invoke_name": "leon2_shanshan",
"subject": "happy new year",
"send_time": "2022-10-26 17:10:20",
"time_zone":"8",
"attachments":[{
"content":"base64 content",
"file_name":"1.jpg"
},{
"content":"base64 content",
"file_name":"2.jpg"
}],
"warm_up": [{
"domain":"gmail.com",
"rate":1,
"upgrade_value":"0.95",
"downgrade_value":"0.75"
},{
"domain":"hotmail.com",
"rate":1,
"upgrade_value":"0.95",
"downgrade_value":"0.75"
}],
"google_track":{
"campaign_name":"",
"campaign_source":"",
"campaign_medium":"",
"campaign_term":"",
"campaign_content":""
}
}
'
สร้างแคมเปญ A/B
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns --data '{
"campaign_type": 1,
"name": "11.11_leon_api9",
"to":[{
"type": "list",
"value": ["all"]
}],
"sender_id": "53",
"reply_to": "reply@sendcloud.im",
"template_invoke_name": "leon2_shanshan",
"subject": "happy new year",
"send_time": "2022-10-26 17:10:20",
"time_zone":"8",
"attachments":[{
"content":"base64 content",
"file_name":"1.jpg"
}
],
"ab_test": {
"percent": 20,
"win_condition": {
"time_unit": "hour",
"after_time": 18,
"compare": "open_percent"
},
"template_invoke_names": []
},
"google_track":{
"campaign_name":"",
"campaign_source":"",
"campaign_medium":"",
"campaign_term":"",
"campaign_content":""
}
}'
ตัวอย่างการตอบกลับ
Response-Success
HttpStatus: 200
{
"result": {
"campaign_id": 36894,
"campaign_type": 2,
"name": "testddd",
"to": [{
"type": "tag",
"value": ["62386112014b7b2f912fddd1"]
}],
"subject": "happy new year",
"label_id": [617450],
"template_invoke_name": "leon2_shanshan",
"reply_to": null,
"status": 2,
"create_time": "2022-09-27T16:36:32+0800",
"update_time": "2022-10-12T00:00:00+0800",
"send_time": "2022-09-27T16:41:23+0800",
"complete_time": "2022-10-12T00:00:00+0800",
"time_zone": "+8",
"zone_id": "Beijing, Chongqing, Hong Kong, Urumqi",
"sender_id": 21,
"google_track": {
"campaign_name":"",
"campaign_source":"",
"campaign_medium":"",
"campaign_term":"",
"campaign_content":""
},
"warm_up": [{
"domain":"hotmail.com",
"rate":1,
"upgrade_value":"0.95",
"downgrade_value":"0.75"
},{
"domain":"hotmail.com",
"rate":1,
"upgrade_value":"0.95",
"downgrade_value":"0.75"
}],
}
}
ตัวอย่างการตอบกลับของแคมเปญทดสอบ a/b
{
"result": {
"campaign_id": 36895,
"campaign_type": 1,
"name": "testddd",
"to":[{
"type": "list",
"value": ["all"]
}],
"subject": null,
"label_id": null,
"template_invoke_name": "leon2_shanshan",
"reply_to": null,
"status": 0,
"create_time": "2022-09-27T16:36:32+0800",
"update_time": "2022-10-12T00:00:00+0800",
"send_time": "2022-09-27T16:41:23+0800",
"complete_time": "2022-10-12T00:00:00+0800",
"time_zone": "+8",
"zone_id": "Beijing, Chongqing, Hong Kong, Urumqi",
"sender_id": 21,
"ab_test": {
"percent": 20,
"win_condition": {
"time_unit": "hour",
"after_time": 18,
"compare": "open_percent"
},
"template_invoke_names": []
},
"google_track": {
"campaign_name":"",
"campaign_source":"",
"campaign_medium":"",
"campaign_term":"",
"campaign_content":""
}
}
}
Response-Error
HttpStatus: 401
{
"code": 32112,
"message": "name cannot be empty"
}
ลบ
URL
https://email.api.engagelab.cc/v1/marketing/campaigns/{campaign_id}
วิธีการร้องขอ HTTP
DELETE
Content-Type
application/x-www-form-urlencoded;charset=utf-8
ส่วนหัวของคำขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
ตัวอย่างคำขอ
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/{campaign_id}
ตัวอย่างการตอบกลับ
Response-Succes
HttpStatus: 200
{
"count": 1
}
Response-Error
HttpStatus: 401
{
"code": 30000,
"message": "Authentication failed"
}
อัปเดต
URL
https://email.api.engagelab.cc/v1/marketing/campaigns/{campaign_id}
วิธีการร้องขอ HTTP
PUT
Content-Type
application/json; charset=utf-8
ส่วนหัวของคำขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
พารามิเตอร์เนื้อหา
| พารามิเตอร์ | Type | จำเป็น | คำอธิบาย |
|---|---|---|---|
| campaign_type | integer | true | ประเภทแคมเปญ: 1 สำหรับการทดสอบ A/B, 2 สำหรับแคมเปญปกติ |
| name | string | false | ชื่อแคมเปญ (สูงสุด 64 ตัวอักษร) |
| to | object[] | false | ผู้รับ ปัจจุบันรองรับอาร์เรย์ขนาด 1 |
| reply_to | string | false | ที่อยู่สำหรับตอบกลับ |
| sender_id | string | * | ID ผู้ส่ง (รองรับเฉพาะแคมเปญปกติ) |
| template_invoke_name | string | * | ชื่อเทมเพลตอีเมลที่จะเรียกใช้ (รองรับเฉพาะแคมเปญปกติ) |
| subject | string | * | หัวข้ออีเมล (จำเป็นสำหรับการทดสอบ A/B) |
| send_time | string | * | เวลาส่ง (รองรับเฉพาะงานปกติ) รูปแบบ: YYYY-MM-DD HH:mm:ss |
| time_zone | string | * | เขตเวลาเริ่มต้น โดยปกติคือ +8 |
| attachments | object[] | false | ไฟล์แนบอีเมล (สูงสุด 10 ไฟล์แนบ) |
| file_name | string | false | ชื่อไฟล์แนบ เช่น example.pdf |
| content | string | false | เนื้อหาไฟล์แนบที่เข้ารหัส base64 |
| ab_test | object | * | พารามิเตอร์การตั้งค่าสำหรับการทดสอบ A/B (รองรับเฉพาะการทดสอบ A/B) |
| google_track | object | false | พารามิเตอร์การตั้งค่าสำหรับการติดตาม Google |
| warm_up | object[] | false | พารามิเตอร์การตั้งค่าสำหรับการส่งแบบวอร์มอัพ (รองรับเฉพาะแคมเปญปกติ) |
ตัวอย่างคำขอ:
curl -X PUT -H ' application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/{campaign_id} --data '{
"name":"11.11_leon_api8"
}'
ตัวอย่างการตอบกลับ
Response-Success
HttpStatus: 200
{
"result": {
"campaign_id": 36894,
"campaign_type": 2,
"name": "testddd",
"to": [{
"type": "tag",
"value": ["62386112014b7b2f912fddd1"]
}],
"subject": "happy new year",
"label_id": [617450],
"template_invoke_name": "leon2_shanshan",
"reply_to": null,
"status": 2,
"create_time": "2022-09-27T16:36:32+0800",
"update_time": "2022-10-12T00:00:00+0800",
"send_time": "2022-09-27T16:41:23+0800",
"complete_time": "2022-10-12T00:00:00+0800",
"time_zone": "+8",
"zone_id": "Beijing, Chongqing, Hong Kong, Urumqi",
"sender_id": 21,
"google_track": {
"campaign_name":"",
"campaign_source":"",
"campaign_medium":"",
"campaign_term":"",
"campaign_content":""
},
"warm_up": [{
"domain":"hotmail.com",
"rate":1,
"upgrade_value":"0.95",
"downgrade_value":"0.75"
},{
"domain":"hotmail.com",
"rate":1,
"upgrade_value":"0.95",
"downgrade_value":"0.75"
}],
}
}
}
Response-Error
{
"code": 32110,
"message": "The current campaign has been executed and cannot be modified"
}
รายการแคมเปญ
URL
https://email.api.engagelab.cc/v1/marketing/campaigns
วิธีการร้องขอ HTTP
GET
Content-Type
application/x-www-form-urlencoded;charset=utf-8
ส่วนหัวของคำขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
พารามิเตอร์การค้นหา
| พารามิเตอร์ | Type | จำเป็น | คำอธิบาย |
|---|---|---|---|
| campaign_type | integer | false | ประเภทแคมเปญ: 1. แคมเปญ A/B, 2. แคมเปญปกติ |
| status | integer | false | สถานะแคมเปญ: 0. รอดำเนินการ, 1. กำลังดำเนินการ, 2. เสร็จสมบูรณ์, -1. ล้มเหลว |
| name | string | false | ชื่อแคมเปญ |
| to_type | integer | false | ประเภทผู้รับ: 0 รายชื่อติดต่อทั้งหมด, 1 เซกเมนต์, 2 แท็ก |
| to_value | string | false | ID ขอบเขตผู้รับ ใช้ ID เซกเมนต์หรือ ID แท็กสำหรับประเภท 1 หรือ 2 |
| limit | integer | false | จำนวนผลลัพธ์ที่ต้องการดึงข้อมูล ช่วง [1-100] ค่าเริ่มต้นคือ 10 |
| offset | integer | false | ตำแหน่งเริ่มต้นของการค้นหา ช่วง [0-] ค่าเริ่มต้นคือ 0 |
ตัวอย่างคำขอ
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns?&status=2
ตัวอย่างการตอบกลับ
Response-Success
HttpStatus:200
{
"result": [
{
"campaign_id": 36894,
"campaign_type": 1,
"name": "testddd",
"to":[{
"type": "list",
"value": ["all"]
}],
"subject": null,
"label_id": null,
"template_invoke_name": "leon2_shanshan",
"reply_to": null,
"status": 2,
"google_track": null,
"create_time": "2022-09-27T16:36:32+0800",
"update_time": "2022-10-12T00:00:00+0800",
"send_time": "2022-09-27T16:41:23+0800",
"complete_time": "2022-10-12T00:00:00+0800",
"time_zone": "+8",
"zone_id": "Beijing, Chongqing, Hong Kong, Urumqi",
"warm_up": [],
"sender_id": 21,
"from_email": "xjmfc23@legendnovel.com",
"from_name": "aaaa",
"ab_test": {
"percent": 20,
"win_condition": {
"time_unit": "hour",
"after_time": 18,
"compare": "open_percent"
},
"template_invoke_names": []
},
"report_summary": {
"targets": 4,
"sent": 4,
"delivered": 2,
"invalid_email": 2,
"soft_bounce": 0,
"billing_count": 2,
"total_clicks": 1,
"total_opens": 2
}
}
],
"total": 2,
"count": 1
}
Response-Error
{
"code": 30000,
"message": "Authentication failed"
}
รายละเอียดแคมเปญ
URL
https://email.api.engagelab.cc/v1/marketing/campaigns/{campaign_id}
วิธีการร้องขอ HTTP
GET
Content-Type
application/x-www-form-urlencoded;charset=utf-8
ส่วนหัวของคำขอ
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
ตัวอย่างคำขอ
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/campaigns/{campaign_id}
พารามิเตอร์การตอบกลับ
| พารามิเตอร์ | Type | คำอธิบาย |
|---|---|---|
| name | string | ชื่อแคมเปญ |
| to | object[] | ผู้รับ ปัจจุบันรองรับอาร์เรย์ที่มีความยาว 1 |
| campaign_id | integer | ID แคมเปญ |
| campaign_type | integer | ประเภทแคมเปญ: 1 สำหรับการทดสอบ A/B, 2 สำหรับแคมเปญปกติ |
| template_invoke_name | string | ชื่อการเรียกใช้เทมเพลต |
| reply_to | string | ที่อยู่สำหรับตอบกลับ (Reply-to) |
| status | integer | สถานะแคมเปญ (0: รอดำเนินการ, 1: กำลังดำเนินการ, 2: เสร็จสมบูรณ์, -1: ล้มเหลว) |
| from_email | string | ที่อยู่อีเมลของผู้ส่ง |
| from_name | string | ชื่อเล่นของผู้ส่ง |
| sender_id | integer | ID ผู้ส่ง |
| create_time | string | เวลาสร้าง (UTC+8) |
| update_time | string | เวลาอัปเดต (UTC+8) |
| send_time | string | เวลาส่ง (UTC+8) |
| time_zone | string | เขตเวลา เช่น +8 |
| complete_time | string | เวลาเสร็จสมบูรณ์ (UTC+8) |
| google_track | object | พารามิเตอร์การตั้งค่า Google Track |
| warm_up | array[object] | พารามิเตอร์การตั้งค่าการส่งแบบวอร์มอัพ (รองรับเฉพาะแคมเปญปกติ) |
| ab_test | object | การตั้งค่าการทดสอบ A/B |
| subject | string | หัวข้ออีเมล (เป็น null สำหรับงานทดสอบ A/B) |
| label_id | array[integer] | อาร์เรย์ ID แท็กของแคมเปญ แยกวิเคราะห์จาก task_template.label_id; เป็น null หากไม่ได้ตั้งค่า |
| zone_id | string | ID เขตเวลา เช่น "Beijing, Chongqing, Hong Kong, Urumqi" |
ตัวอย่างการตอบกลับ
Response-Success
HttpStatus: 200
{
"result": {
"campaign_id": 36894,
"campaign_type": 1,
"name": "testddd",
"to":[{
"type": "list",
"value": ["all"]
}],
"subject": null,
"label_id": null,
"from_email": "xjmfc23@legendnovel.com",
"from_name": "aaaa",
"template_invoke_name": "leon2_shanshan",
"reply_to": null,
"status": 2,
"google_track": null,
"create_time": "2022-09-27T16:36:32+0800",
"update_time": "2022-10-12T00:00:00+0800",
"send_time": "2022-09-27T16:41:23+0800",
"complete_time": "2022-10-12T00:00:00+0800",
"time_zone": "+8",
"zone_id": "Beijing, Chongqing, Hong Kong, Urumqi",
"warm_up": null,
"sender_id": 21,
"ab_test": {
"percent": 20,
"win_condition": {
"time_unit": "hour",
"after_time": 18,
"compare": "open_percent"
},
"template_invoke_names": []
}
}
Response-Error
{
"code": 30000,
"message": "Authentication failed"
}










