Route
Vous pouvez utiliser l'API pour interroger, ajouter, modifier et supprimer des routes de réception. La route que vous configurez doit d'abord être enregistrée via la configuration MX. Nous pouvons transférer le message de réponse vers la boîte mail que vous spécifiez ou pousser le message vers l'URL indiquée.
Adresse d'appel
| Centre de données | URL |
|---|---|
| Singapour | https://email.api.engagelab.cc |
| Turquie | https://emailapi-tr.engagelab.com |
Lorsque vous utilisez l'API REST, assurez-vous que le centre de données sélectionné correspond à la base URL appropriée.
POST/v1/routes
Requête (par lot)
URL
https://email.api.engagelab.cc/v1/routes
https://email.api.engagelab.cc/v1/routes
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-tête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Description des paramètres
| paramètre | type | obligatoire ou non | description |
|---|---|---|---|
| offset | int | non | position de décalage, [0-], par défaut 0 |
| limit | int | non | quantité, [0-100], par défaut 100 |
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| paramètre | description |
|---|---|
| route_id | ID de la route |
| expression | route de réception |
| action | URL/E-mail |
| api_user_route | Lorsque l'action est définie sur "E-mail", ce paramètre est requis. |
Exemple de valeur retournée :
Réponse-succès
Statut HTTP : 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
}
Afficher ce bloc de code dans la fenêtre flottante
Requête
URL
https://email.api.engagelab.cc/v1/routes/{route_id}
https://email.api.engagelab.cc/v1/routes/{route_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
GET
GET
Afficher ce bloc de code dans la fenêtre flottante
En-tête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Exemple de requête
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"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| paramètre | description |
|---|---|
| route_id | ID de la route |
| expression | route de réception |
| action | URL/E-mail |
| api_user_route | Lorsque l'action est définie sur "E-mail", ce paramètre est requis. |
Exemple de valeur retournée :
Réponse-succès
Statut HTTP : 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"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Ajouter
Un utilisateur peut ajouter jusqu'à 1000 routes de réception.
URL
https://email.api.engagelab.cc/v1/routes
https://email.api.engagelab.cc/v1/routes
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
POST
POST
Afficher ce bloc de code dans la fenêtre flottante
En-tête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Description des paramètres
| paramètre | type | obligatoire ou non | description |
|---|---|---|---|
| expression | string | oui | route de réception. Le format est 'expression régulière@domaine' ; il peut aussi s'agir d'une adresse e-mail spécifique. Le domaine de l'e-mail doit être un domaine d'envoi vérifié ou utilisable. |
| action | string | oui | URL/E-mail |
| api_user_route | string | * | Lorsque l'action est définie sur "E-mail", ce paramètre est requis. Lors du transfert vers un e-mail, cet API-USER sera utilisé pour le transfert et l'envoi. |
Exemple de requête
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"
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| paramètre | description |
|---|---|
| route_id | ID de la route |
| expression | route de réception |
| action | URL /E-mail |
| api_user_route | Lorsque l'action est définie sur "E-mail", ce paramètre est requis. |
Exemple de valeur retournée :
{
"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"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Modifier
URL
https://email.api.engagelab.cc/v1/routes/{route_id}
https://email.api.engagelab.cc/v1/routes/{route_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
PUT
PUT
Afficher ce bloc de code dans la fenêtre flottante
En-tête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Description des paramètres
| paramètre | type | obligatoire ou non | description |
|---|---|---|---|
| expression | string | * | route de réception |
| action | string | * | URL/E-mail |
| api_user_route | string | * | Lorsque l'action est définie sur "E-mail", ce paramètre est requis. |
Exemple de requête
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"
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| paramètre | description |
|---|---|
| count | nombre de routes de réception modifiées |
Exemple de valeur retournée :
Réponse-succès
Statut HTTP : 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
Statut HTTP : 401
{
"code": 30000,
"message": "Échec de l'authentification."
}
{
"code": 30000,
"message": "Échec de l'authentification."
}
Afficher ce bloc de code dans la fenêtre flottante
Supprimer
URL
https://email.api.engagelab.cc/v1/routes/{route_id}
https://email.api.engagelab.cc/v1/routes/{route_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
DELETE
DELETE
Afficher ce bloc de code dans la fenêtre flottante
En-tête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Exemple de requête
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>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| paramètre | description |
|---|---|
| count | nombre de routes de réception supprimées |
Exemple de valeur retournée :
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
