收信路由
您可以使用API對收信路由進行査詢，添加，修改，删除； 您配寘的路由需要先通過MX配寘記錄； 我們可以將回復郵件轉發到您指定的郵箱，或將郵件推送到指定的URL。
査詢（批量）
URL
https://email.api.engagelab.cc/v1/routes
https://email.api.engagelab.cc/v1/routes
此代碼塊在浮窗中顯示
HTTP 請求方式
GET
GET
此代碼塊在浮窗中顯示
Header
| Header | 類型 | 是否必須 | 說明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
査詢（批量）參數說明
| 參數 | 類型 | 是否必須 | 說明 |
|---|---|---|---|
| offset | int | 否 | 査詢起始位置，[0-]，默認為0 |
| limit | int | 否 | 査詢個數，取值區間[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 | 路由 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
此代碼塊在浮窗中顯示
Header
| Header | 類型 | 是否必須 | 說明 |
|---|---|---|---|
| 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 | 路由 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
此代碼塊在浮窗中顯示
HTTP 請求方式
POST
POST
此代碼塊在浮窗中顯示
Header
| Header | 類型 | 是否必須 | 說明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(api_user:api_key) |
添加參數說明
| 參數 | 類型 | 是否必須 | 說明 |
|---|---|---|---|
| expression | string | 是 | 收信路由。 格式為“規則運算式@功能變數名稱”； 也可以為具體的郵箱。 功能變數名稱/郵箱功能變數名稱需是已驗證或可使用的發信功能變數名稱 |
| action | string | 是 | 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 | 路由 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
此代碼塊在浮窗中顯示
Header
| Header | 類型 | 是否必須 | 說明 |
|---|---|---|---|
| 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
此代碼塊在浮窗中顯示
Header
| Header | 類型 | 是否必須 | 說明 |
|---|---|---|---|
| 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
}
{
"count": 1
}
此代碼塊在浮窗中顯示
