Route
Sie können die API verwenden, um Empfangsrouten abzufragen, hinzuzufügen, zu bearbeiten und zu löschen.
Die von Ihnen konfigurierte Route muss zuerst in der MX-Konfiguration eingetragen werden.
Antwortnachrichten können an das von Ihnen angegebene Postfach weitergeleitet oder an eine definierte URL gesendet werden.
Aufrufadresse
| Rechenzentrum | URL |
|---|---|
| Singapur | https://email.api.engagelab.cc |
| Türkei | https://emailapi-tr.engagelab.com |
Achten Sie bei der Nutzung der REST API darauf, dass das gewählte Rechenzentrum zur jeweiligen Basis-URL passt.
POST/v1/routes
Abfrage (Stapelweise)
URL
https://email.api.engagelab.cc/v1/routes
https://email.api.engagelab.cc/v1/routes
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Parameterbeschreibung
| Parameter | Typ | erforderlich | Beschreibung |
|---|---|---|---|
| offset | int | nein | Startposition, [0-], Standardwert ist 0 |
| limit | int | nein | Anzahl, [0-100], Standardwert ist 100 |
Beispielanfrage
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>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| route_id | Routen-ID |
| expression | Empfangsroute |
| action | URL/E-Mail |
| api_user_route | Wenn action auf „Email“ gesetzt ist, ist dieser Parameter erforderlich. |
Beispiel für Rückgabewerte:
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
}
Diesen Codeblock im schwebenden Fenster anzeigen
Einzelabfrage
URL
https://email.api.engagelab.cc/v1/routes/{route_id}
https://email.api.engagelab.cc/v1/routes/{route_id}
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
GET
GET
Diesen Codeblock im schwebenden Fenster anzeigen
Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Beispielanfrage
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"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| route_id | Routen-ID |
| expression | Empfangsroute |
| action | URL/E-Mail |
| api_user_route | Wenn action auf „Email“ gesetzt ist, ist dieser Parameter erforderlich. |
Beispiel für Rückgabewerte:
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"
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Hinzufügen
Ein:e Nutzer:in kann bis zu 1.000 Empfangsrouten hinzufügen.
URL
https://email.api.engagelab.cc/v1/routes
https://email.api.engagelab.cc/v1/routes
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
POST
POST
Diesen Codeblock im schwebenden Fenster anzeigen
Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Parameterbeschreibung
| Parameter | Typ | erforderlich | Beschreibung |
|---|---|---|---|
| expression | string | ja | Empfangsroute. Format: 'regulärer Ausdruck@Domain'; es kann auch eine spezifische E-Mail-Adresse sein. Die Domain/E-Mail-Domain muss eine verifizierte oder nutzbare Absenderdomain sein. |
| action | string | ja | URL/E-Mail |
| api_user_route | string | * | Wenn action auf „Email“ gesetzt ist, ist dieser Parameter erforderlich. Beim Weiterleiten an eine E-Mail-Adresse wird dieser API-USER für das Weiterleiten und Versenden verwendet. |
Beispielanfrage
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"
}'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| route_id | Routen-ID |
| expression | Empfangsroute |
| action | URL/E-Mail |
| api_user_route | Wenn action auf „Email“ gesetzt ist, ist dieser Parameter erforderlich. |
Beispiel für Rückgabewerte:
{
"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"
}
}
Diesen Codeblock im schwebenden Fenster anzeigen
Bearbeiten
URL
https://email.api.engagelab.cc/v1/routes/{route_id}
https://email.api.engagelab.cc/v1/routes/{route_id}
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
PUT
PUT
Diesen Codeblock im schwebenden Fenster anzeigen
Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Parameterbeschreibung
| Parameter | Typ | erforderlich | Beschreibung |
|---|---|---|---|
| expression | string | * | Empfangsroute |
| action | string | * | URL/E-Mail |
| api_user_route | string | * | Wenn action auf „Email“ gesetzt ist, ist dieser Parameter erforderlich. |
Beispielanfrage
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"
}'
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| count | Anzahl der bearbeiteten Empfangsrouten |
Beispiel für Rückgabewerte:
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
Response-error
HTTP Status: 401
{
"code": 30000,
"message": "Authentication failed."
}
{
"code": 30000,
"message": "Authentication failed."
}
Diesen Codeblock im schwebenden Fenster anzeigen
Löschen
URL
https://email.api.engagelab.cc/v1/routes/{route_id}
https://email.api.engagelab.cc/v1/routes/{route_id}
Diesen Codeblock im schwebenden Fenster anzeigen
HTTP-Request-Methode
DELETE
DELETE
Diesen Codeblock im schwebenden Fenster anzeigen
Header
| Header | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| Authorization | String | ja | Basic base64(api_user:api_key) |
Beispielanfrage
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>>"
Diesen Codeblock im schwebenden Fenster anzeigen
Beschreibung der Rückgabewerte
| Parameter | Beschreibung |
|---|---|
| count | Anzahl der gelöschten Empfangsrouten |
Beispiel für Rückgabewerte:
{
"count": 1
}
{
"count": 1
}
Diesen Codeblock im schwebenden Fenster anzeigen
