การตอบกลับการจัดส่ง
รายการสถานะอีเมลที่ส่งโดยผู้ใช้
คุณสามารถดำเนินการค้นหาบนรายการนี้ได้
URL
https://email.api.engagelab.cc/v1/email_status
https://email.api.engagelab.cc/v1/email_status
โค้ดนี้โชว์เป็นหน้าต่างลอย
วิธีการร้องขอ HTTP
GET
GET
โค้ดนี้โชว์เป็นหน้าต่างลอย
ส่วนหัวของคำขอ
ส่วนหัว | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
Authorization | String | true | Basic base64(api_user:api_key) |
คำอธิบายพารามิเตอร์การค้นหา
พารามิเตอร์ | ประเภท | จำเป็น | คำอธิบาย |
---|---|---|---|
offset | string | No | ตำแหน่งเริ่มต้นการค้นหา ช่วง [0-] ค่าเริ่มต้นคือ 0 |
limit | int | No | จำนวนการค้นหา ช่วง [0-100] ค่าเริ่มต้นคือ 100 |
send_date | string | Yes | วันที่ส่ง รูปแบบ yyyy-MM-dd |
string | No | ที่อยู่ผู้รับ | |
email_ids | string | No | EmailId ที่ส่งคืนสำเร็จโดยการเรียก API เพื่อส่งอีเมล ที่อยู่หลายรายการคั่นด้วย ';' เช่น email_ids=a;b;c |
api_user | string | No | API_USER ที่เฉพาะเจาะจงของผู้ใช้ |
domain_name | string | No | โดเมนที่รับ เช่น gmail.com |
label_id | string | No | รหัสป้ายกำกับที่สอดคล้องกับป้ายกำกับที่ผู้ใช้สร้างขึ้น |
status | string | No | สถานะการตอบกลับการจัดส่ง ค่าคำขอคือ 18; ค่าจัดส่งคือ 1; Soft bounce คือ 5; อีเมลไม่ถูกต้องคือ 4. |
sub_status | string | No | ค้นหาประเภทอีเมลไม่ถูกต้องหรือ soft bounce ประเภทย่อยหลายประเภทคั่นด้วย ';' เช่น subStatus=a;b;c เมื่อพารามิเตอร์นี้ถูกส่งผ่าน พารามิเตอร์สถานะจะไม่ถูกต้อง |
หมายเหตุ:
- การค้นหาแต่ละครั้งจะเริ่มต้นด้วยการค้นหาเพียง 100 รายการ หากจำนวนรายการที่ตรงกับเงื่อนไขการค้นหาเกิน 100 รายการ จำเป็นต้องระบุพารามิเตอร์ offset และ limit ด้วยตนเอง
- บันทึกที่ได้รับในแต่ละการค้นหาจะถูกแคชเป็นเวลา 10 นาทีตามพารามิเตอร์ที่ผู้ใช้ส่งผ่าน
- อินเทอร์เฟซนี้จำกัดให้แต่ละบัญชีผู้ใช้เรียกใช้อินเทอร์เฟซ 60 ครั้งต่อนาที หากไม่ตรงกับความต้องการของคุณ โปรดใช้ WebHook
- โดยการส่งผ่านที่อยู่อีเมล คุณสามารถค้นหารายละเอียดการจัดส่งของที่อยู่ภายใน 30 วันหลังจาก send_date; หากไม่ได้ส่งผ่านที่อยู่อีเมล จะสามารถค้นหารายละเอียดข้อมูลของ send_date ได้เท่านั้น
sub_status | sub_stat_desc |
---|---|
401 | อีเมลไม่ถูกต้อง - อยู่ในบัญชีดำของแพลตฟอร์ม |
402 | อีเมลไม่ถูกต้อง - ยกเลิกการสมัคร |
403 | อีเมลไม่ถูกต้อง - ไม่สามารถเข้าถึงเซิร์ฟเวอร์ได้ |
404 | อีเมลไม่ถูกต้อง - รูปแบบที่อยู่ผิดพลาด |
405 | อีเมลไม่ถูกต้อง - IP หรือโดเมนถูกปฏิเสธ |
406 | อีเมลไม่ถูกต้อง - ที่อยู่ไม่มีอยู่จริง |
407 | อีเมลไม่ถูกต้อง - สแปม |
408 | อีเมลไม่ถูกต้อง - ผู้ส่ง/ผู้รับถูกปฏิเสธ |
409 | อีเมลไม่ถูกต้อง - อื่น ๆ |
503 | Soft Bounce - ไม่สามารถเข้าถึงบริการได้ |
505 | Soft Bounce - IP หรือโดเมนถูกปฏิเสธ |
506 | Soft Bounce - ที่อยู่อีเมลไม่มีอยู่จริง |
507 | Soft Bounce - ถูกปฏิเสธโดยระบบป้องกันสแปม |
508 | Soft Bounce - ผู้ส่ง/ผู้รับถูกปฏิเสธ |
509 | Soft Bounce - อื่น ๆ |
ตัวอย่างคำขอ
curl "https://email.api.engagelab.cc/v1/email_status?send_date=2022-11-21&email_ids=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/email_status?send_date=2022-11-21&email_ids=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
โค้ดนี้โชว์เป็นหน้าต่างลอย
คำอธิบายการตอบกลับ
พารามิเตอร์ | คำอธิบาย |
---|---|
ที่อยู่ผู้รับ | |
email_id | EmailId ที่ส่งคืนสำเร็จโดยการเรียก API เพื่อส่งอีเมล |
api_user | ชื่อ api_user |
status | สถานะการจัดส่ง |
status_desc | คำอธิบายสถานะการจัดส่ง |
sub_status | รหัสสถานะที่ไม่ถูกต้อง 401-509 |
sub_status_desc | คำอธิบายประเภทย่อยที่ไม่ถูกต้องหรือ soft bounce |
request_time | เวลาที่ร้องขอ |
update_time | เวลาการอัปเดตสถานะ |
response_message | ข้อความผลลัพธ์การส่ง |
ตัวอย่างการตอบกลับ
{
"result": [
{
"email_id": "1668065941982_15_2032_7460.sc-10_2_226_96-test0$1720f4a1d6af047181@hotmail.com",
"api_user": "zymtest4",
"email": "1720f4a1d6af047181@hotmail.com",
"request_time": "2022-11-10T15:39:01+0800",
"update_time": "2022-11-10T17:34:16+0800",
"status": 4,
"sub_status": 409,
"status_desc": "Invalid Email",
"sub_status_desc": "Other",
"response_message": "Other(scheduler: deleted)"
}
],
"total": "48675",
"count": 1
}
{
"result": [
{
"email_id": "1668065941982_15_2032_7460.sc-10_2_226_96-test0$1720f4a1d6af047181@hotmail.com",
"api_user": "zymtest4",
"email": "1720f4a1d6af047181@hotmail.com",
"request_time": "2022-11-10T15:39:01+0800",
"update_time": "2022-11-10T17:34:16+0800",
"status": 4,
"sub_status": 409,
"status_desc": "Invalid Email",
"sub_status_desc": "Other",
"response_message": "Other(scheduler: deleted)"
}
],
"total": "48675",
"count": 1
}
โค้ดนี้โชว์เป็นหน้าต่างลอย