受信ルート
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 | ルート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 | ルート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
このコードブロックはフローティングウィンドウ内に表示されます
ヘッダー
ヘッダー | タイプ | 必須 | 説明 |
---|---|---|---|
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 | ルート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
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます