การจัดการผู้ส่ง

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

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

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

POST/v1/marketing/senders

สร้างผู้ส่ง

URL

https://email.api.engagelab.cc/v1/marketing/senders

              
              https://email.api.engagelab.cc/v1/marketing/senders

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

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

POST

              
              POST

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

Content-Type

application/json; charset=utf-8

              
              application/json; charset=utf-8

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

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

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

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

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
from_name	string	true	ชื่อผู้ส่ง
email	string	true	ที่อยู่อีเมลของผู้ส่ง ต้องอยู่ในรูปแบบอีเมล และส่วนโดเมนต้องตรงกับ domain_name
domain_name	string	true	โดเมน (ที่กำหนดค่าและได้รับการอนุมัติ)
api_user	string	true	ชื่อ ApiUser

หมายเหตุ:

domain_name และ api_user ต้องสอดคล้องกัน

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

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders --data '{ "from_name": "Linghu", "email": "xjmfc@126.com", "domain_name": "126.com", "api_user": "test_abc" }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders --data '{
  "from_name": "Linghu",
  "email": "xjmfc@126.com",
  "domain_name": "126.com",
  "api_user": "test_abc"
}'

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

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

Response-Success

HttpStatus: 200

{ "result": { "sender_id": 449, "name": "Qiaofeng2", "email": "zhou@aizl.net", "domain_id": 147886, "domain_name": "aizl.net", "api_user": "xiaojinmin_new", "create_time": "2022-05-24T14:04:19+0800", "update_time": "2022-05-24T15:35:09+0800" } }

              
              {
     "result": {
        "sender_id": 449,
        "name": "Qiaofeng2",
        "email": "zhou@aizl.net",
        "domain_id": 147886,
        "domain_name": "aizl.net",
        "api_user": "xiaojinmin_new",
        "create_time": "2022-05-24T14:04:19+0800",
        "update_time": "2022-05-24T15:35:09+0800"
    }
}

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

Response-Error

HttpStatus: 401

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

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

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

ลบผู้ส่ง

URL

https://email.api.engagelab.cc/v1//marketing/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1//marketing/senders/{sender_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/senders/857

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

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

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

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/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1//marketing/senders/{sender_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)

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

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
from_name	string	false	ชื่อผู้ส่ง
email	string	false	ที่อยู่อีเมลของผู้ส่ง ต้องอยู่ในรูปแบบอีเมล และส่วนโดเมนต้องตรงกับ domain_name
domain_name	string	false	โดเมน (ที่กำหนดค่าและได้รับการอนุมัติ)
api_user	string	false	ชื่อ API_USER

หมายเหตุ:

ค่าของ from_name, email, domain_name และ api_user ไม่สามารถเป็นสตริงว่างหรืออักขระ null ได้

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

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/37 --data '{ "from_name": "Linghu", "email": "xjmfc@126.com", "domain_name": "test.com", "api_user": "test_abc" }'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/37 --data '{
  "from_name": "Linghu",
  "email": "xjmfc@126.com",
  "domain_name": "test.com",
  "api_user": "test_abc"
}'

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

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

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/senders/{sender_id}

              
              https://email.api.engagelab.cc/v1/marketing/senders/{sender_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/senders/1

              
              curl -X GET -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/1

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

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

Response-Success

HttpStatus: 200

{ "result": { "sender_id": 449, "name": "乔峰2", "email": "zhou@aizl.net", "domain_id": 147886, "domain_name": "aizl.net", "api_user": "xiaojinmin_new", "create_time": "2022-05-24T14:04:19+0800", "update_time": "2022-05-24T15:35:09+0800" } }

              
              {
    "result": {
        "sender_id": 449,
        "name": "乔峰2",
        "email": "zhou@aizl.net",
        "domain_id": 147886,
        "domain_name": "aizl.net",
        "api_user": "xiaojinmin_new",
        "create_time": "2022-05-24T14:04:19+0800",
        "update_time": "2022-05-24T15:35:09+0800"
    }
}

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

Response-Error

HttpStatus: 401

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

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

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

รายชื่อผู้ส่ง

URL

https://email.api.engagelab.cc/v1/marketing/senders

              
              https://email.api.engagelab.cc/v1/marketing/senders

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

วิธีการร้องขอ 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)

พารามิเตอร์การค้นหา

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
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/senders?offset=0&limit=10

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders?offset=0&limit=10

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

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

พารามิเตอร์	ประเภท	คำอธิบาย
list	array[object]	รายชื่อผู้ส่ง
sender_id	integer	รหัสผู้ส่ง
name	string	ชื่อผู้ส่ง
email	string	ที่อยู่อีเมลของผู้ส่ง
domain_id	integer	รหัสโดเมน
domain_name	string	ชื่อโดเมน
api_user	string	ชื่อ APIUSER
create_time	string	เวลาที่สร้าง
update_time	string	เวลาที่อัปเดต
total	integer	จำนวนระเบียนทั้งหมด

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

Response-Success

HttpStatus: 200

{ "result": [ { "sender_id": 388, "name": "xjmfc", "email": "xjmfc@aizl.net", "domain_id": 147886, "domain_name": "aizl.net", "api_user": "xiaojinmin", "create_time": "2022-05-24T14:04:19+0800", "update_time": "2022-05-24T15:35:09+0800" } ], "total": 3, "count": 1 }

              
              {
    "result": [
        {
            "sender_id": 388,
            "name": "xjmfc",
            "email": "xjmfc@aizl.net",
            "domain_id": 147886,
            "domain_name": "aizl.net",
            "api_user": "xiaojinmin",
            "create_time": "2022-05-24T14:04:19+0800",
            "update_time": "2022-05-24T15:35:09+0800"
        }
    ],
    "total": 3,
    "count": 1
}

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

Response-Error

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

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

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