เส้นทางการรับ

คุณสามารถใช้ API เพื่อสอบถาม เพิ่ม แก้ไข และลบเส้นทางการรับได้; เส้นทางที่คุณกำหนดจำเป็นต้องผ่านการกำหนดค่าบันทึก MX ก่อน; เราสามารถส่งต่ออีเมลตอบกลับไปยังกล่องจดหมายที่คุณระบุหรือส่งอีเมลไปยัง URL ที่กำหนด

การสอบถาม (แบบชุด)

URL

https://email.api.engagelab.cc/v1/routes

              
              https://email.api.engagelab.cc/v1/routes

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

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

GET

GET

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

ส่วนหัว

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

คำอธิบายพารามิเตอร์การสอบถามแบบชุด

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
offset	int	No	ตำแหน่งเริ่มต้นในการสอบถาม, [0-], ค่าเริ่มต้นคือ 0
limit	int	No	จำนวนการสอบถาม, ช่วง [0-100], ค่าเริ่มต้นคือ 100

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

curl "https://email.api.engagelab.cc/v1/routes?offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl "https://email.api.engagelab.cc/v1/routes?offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

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

พารามิเตอร์	คำอธิบาย
route_id	รหัสเส้นทาง
expression	เส้นทางการรับ
action	URL/กล่องจดหมาย
api_user_route	พารามิเตอร์นี้จำเป็นเมื่อ action ถูกตั้งค่าเป็น "กล่องจดหมาย"

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

Response-success HTTP Status: 200

{ "result": [ { "route_id": 1, "expression":"xjmfc", "action":"test@engagelab.com" "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800"， "api_user_route":"test" } ], "total": 1, "count": 1 }

              
              {
       "result": [
            {    
                "route_id": 1,
                "expression":"xjmfc",
                "action":"test@engagelab.com"
                "create_time": "2022-11-14T14:27:48+0800",
                "update_time": "2022-11-14T14:27:48+0800"，
                "api_user_route":"test"
            }
        ],
        "total": 1,
        "count": 1
 }

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

การสอบถาม

URL

https://email.api.engagelab.cc/v1/routes/{route_id}

              
              https://email.api.engagelab.cc/v1/routes/{route_id}

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

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

GET

GET

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

ส่วนหัว

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

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

curl -X GET "https://email.api.engagelab.cc/v1/routes/112" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json"

              
              curl -X GET "https://email.api.engagelab.cc/v1/routes/112" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json"

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

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

พารามิเตอร์	คำอธิบาย
route_id	รหัสเส้นทาง
expression	เส้นทางการรับ
action	URL/กล่องจดหมาย
api_user_route	พารามิเตอร์นี้จำเป็นเมื่อ action ถูกตั้งค่าเป็น "กล่องจดหมาย"

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

Response-success

HTTP Status: 200

{ "result": { "route_id": 1, "expression":"xjmfc", "action":"test@engagelab.com", "api_user_route": "sctest", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }

              
              {
       "result": {    
                "route_id": 1,
                "expression":"xjmfc",
                "action":"test@engagelab.com",
                "api_user_route": "sctest",
                "create_time": "2022-11-14T14:27:48+0800",
                "update_time": "2022-11-14T14:27:48+0800"
          }
 }

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

การเพิ่ม

ผู้ใช้สามารถเพิ่มเส้นทางการรับได้สูงสุด 1000 เส้นทาง

URL

https://email.api.engagelab.cc/v1/routes

              
              https://email.api.engagelab.cc/v1/routes

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

ส่วนหัว

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

คำอธิบายพารามิเตอร์การเพิ่ม

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
expression	string	Yes	เส้นทางการรับ รูปแบบคือ "regex@domain"; นอกจากนี้ยังสามารถเป็นกล่องจดหมายเฉพาะได้ โดเมน/โดเมนกล่องจดหมายต้องเป็นโดเมนการส่งที่ได้รับการยืนยันหรือใช้งานได้
action	string	Yes	URL/กล่องจดหมาย
api_user_route	string	*	พารามิเตอร์นี้จำเป็นเมื่อ action ถูกตั้งค่าเป็น "กล่องจดหมาย"

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

curl -X POST "https://email.api.engagelab.cc/v1/routes" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "expression":"hongkong@aizl.net", "action":"test@engagelab.com" }'

              
              curl -X POST "https://email.api.engagelab.cc/v1/routes" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "expression":"hongkong@aizl.net",
  "action":"test@engagelab.com"
}'

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

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

พารามิเตอร์	คำอธิบาย
route_id	รหัสเส้นทาง
expression	เส้นทางการรับ
action	URL/กล่องจดหมาย
api_user_route	พารามิเตอร์นี้จำเป็นเมื่อ action ถูกตั้งค่าเป็น "กล่องจดหมาย" เมื่อส่งต่อไปยังกล่องจดหมาย API_USER นี้จะถูกใช้สำหรับการส่งต่อ

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

{ "result": { "route_id": 598802, "expression":".*@123.com", "action":"test@engagelab.com" "api_user_route":"test233" "create_time": "2022-11-14T14:27:34+0800", "update_time": "2022-11-14T14:27:34+0800" } }

              
              {
   "result": {
            "route_id": 598802,
            "expression":".*@123.com",
            "action":"test@engagelab.com"
            "api_user_route":"test233"
            "create_time": "2022-11-14T14:27:34+0800",
            "update_time": "2022-11-14T14:27:34+0800"
    }
}

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

การแก้ไข

URL

https://email.api.engagelab.cc/v1/routes/{route_id}

              
              https://email.api.engagelab.cc/v1/routes/{route_id}

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

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

PUT

PUT

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

ส่วนหัว

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

คำอธิบายพารามิเตอร์การแก้ไข

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
expression	string	*	เส้นทางการรับ
action	string	*	URL/กล่องจดหมาย
api_user_route	string	*	พารามิเตอร์นี้จำเป็นเมื่อ action ถูกตั้งค่าเป็น "กล่องจดหมาย"

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

curl -X PUT "https://email.api.engagelab.cc/v1/routes/12333" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "expression":"travel", "action":"test@engagelab.com" }'

              
              curl -X PUT "https://email.api.engagelab.cc/v1/routes/12333" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
  "expression":"travel",
  "action":"test@engagelab.com"
}'

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

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

พารามิเตอร์	คำอธิบาย
count	จำนวนเส้นทางการรับที่ถูกแก้ไข

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

Response-success

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

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

Response-error

HTTP Status :401

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

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

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

การลบ

URL

https://email.api.engagelab.cc/v1/routes/{route_id}

              
              https://email.api.engagelab.cc/v1/routes/{route_id}

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

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

DELETE

              
              DELETE

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

ส่วนหัว

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

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

curl -X DELETE "https://email.api.engagelab.cc/v1/routes/21122" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://email.api.engagelab.cc/v1/routes/21122" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

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

พารามิเตอร์	คำอธิบาย
count	จำนวนเส้นทางการรับที่ถูกลบ

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

{ "count": 1 }

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