Étiquette d'e-mail
L'étiquette offre un autre moyen d'obtenir des statistiques sur les e-mails.
Vous pouvez interroger, ajouter, supprimer et modifier des étiquettes via l'API.
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 à l'URL de base appropriée.
POST/v1/labels
Requête (lot)
Liste des étiquettes retournées
URL
https://email.api.engagelab.cc/v1/labels
https://email.api.engagelab.cc/v1/labels
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 de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Description des paramètres de requête
| 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 |
| label_name | string | non | requête floue |
Exemple de requête
curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&offset=0&limit=200" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/labels?label_name=edm&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 |
|---|---|
| label_id | ID de l'étiquette |
| label_name | nom de l'étiquette |
| create_time | date de création de l'étiquette |
| update_time | date de modification de l'étiquette |
Exemple de valeur retournée
Réponse-succès
Statut HTTP : 200
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-14T14:27:48+0800",
"update_time": "2022-11-14T14:27:48+0800"
}
]
}
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"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
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
Requête
URL
https://email.api.engagelab.cc/v1/labels/{label_id}
https://email.api.engagelab.cc/v1/labels/{label_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êtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Exemple de requête
curl "https://email.api.engagelab.cc/v1/labels/89" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/labels/89" --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 |
|---|---|
| label_id | ID de l'étiquette |
| label_name | nom de l'étiquette |
| create_time | date de création de l'étiquette |
| update_time | date de modification de l'étiquette |
Exemple de valeur retournée
Réponse-succès
Statut HTTP : 200
{
"result": {
"label_id": 598100,
"label_name": "xiaoxiao",
"create_time": "2022-08-09T13:49:46+0800",
"update_time": "2022-11-12T14:12:12+0800"
}
}
{
"result": {
"label_id": 598100,
"label_name": "xiaoxiao",
"create_time": "2022-08-09T13:49:46+0800",
"update_time": "2022-11-12T14:12:12+0800"
}
}
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
Ajouter
URL
https://email.api.engagelab.cc/v1/labels
https://email.api.engagelab.cc/v1/labels
Afficher ce bloc de code dans la fenêtre flottante
Content-Type :
application/json; charset=utf-8
application/json; charset=utf-8
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 de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Description des paramètres du corps
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| label_name | string | oui | nom de l'étiquette à ajouter. Maximum 64 caractères. |
Astuces : La limite supérieure de création d'étiquettes est de 100000
Exemple de requête
curl -X POST "https://email.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"hongkong"
}'
curl -X POST "https://email.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"hongkong"
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| label_id | ID de l'étiquette |
| label_name | nom de l'étiquette |
| create_time | date de création de l'étiquette |
| update_time | date de modification de l'étiquette |
Exemple de valeur retournée
Réponse-succès
Statut HTTP : 200
{
"result": {
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-14T14:27:34+0800",
"update_time": "2022-11-14T14:27:34+0800"
}
}
{
"result": {
"label_id": 598802,
"label_name": "xjm226",
"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
Réponse-erreur
Statut HTTP : 400
{
"code": 30105,
"message": "Le nom de l'étiquette doit comporter entre 1 et 255 caractères"
}
{
"code": 30105,
"message": "Le nom de l'étiquette doit comporter entre 1 et 255 caractères"
}
Afficher ce bloc de code dans la fenêtre flottante
Supprimer
URL
https://email.api.engagelab.cc/v1/labels/{label_id}
https://email.api.engagelab.cc/v1/labels/{label_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 de la requê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/labels/21122"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://email.api.engagelab.cc/v1/labels/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 d'étiquettes supprimé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
Modifier
URL
https://email.api.engagelab.cc/v1/labels/{label_id}
https://email.api.engagelab.cc/v1/labels/{label_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 de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | String | oui | Basic base64(api_user:api_key) |
Description des paramètres
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| label_name | string | oui | nouveau nom d'étiquette. Maximum 64 caractères. |
Exemple de requête
curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"travel"
}'
curl -X PUT "https://email.api.engagelab.cc/v1/labels/12333"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"label_name":"travel"
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| count | nombre d'étiquettes 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
