logoDocumentation
Email
Accueil de la Documentation
Démarrage rapideInstructionsREST APISMTPUseMarketingWebHookResources
Rechercher
Français
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
Bahasa Indonesia
Deutsch
Français
Connexion
REST API / Address List

Liste d'adresses

Dernière Mise à jour：almost 3 years ago

La liste d'adresses est généralement utilisée lors de l'envoi d'e-mails marketing.

Vous pouvez interroger, ajouter, modifier et supprimer la liste d'adresses, ainsi que les membres de la liste.

Appeler l'adresse

Centre de données URL
Singapour https://email.api.engagelab.cc
Turquie https://emailapi-tr.engagelab.com

Lors de l'utilisation de l'API REST, assurez-vous que le centre de données sélectionné correspond à l'URL de base appropriée.

POST/v1/address_lists

Interroger la liste d'adresses (par lot)

URL

https://email.api.engagelab.cc/v1/address_lists
              
              https://email.api.engagelab.cc/v1/address_lists
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 true 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 l'offset, [0-], par défaut 0
limit int non quantité, [0-100], par défaut 100
name string non nom de la liste d'adresses
address string non adresse de la liste d'adresses

Exemple de requête

curl 'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='
              
              curl  'https://email.api.engagelab.cc/v1/address_lists' --header 'Authorization: Basic YXBpVXNlcjphcGlLZXk='
Afficher ce bloc de code dans la fenêtre flottante

Description de la valeur retournée

Paramètre Description
address_list_id id de la liste
name nom de la liste d'adresses
address liste des adresses alias, vous pouvez effectuer des opérations via l'adresse alias ; formaté comme xxx@maillist.email.engagelab.com
member_count nombre d'adresses dans la liste
desc description de la liste d'adresses
create_time date de création de la liste d'adresses
update_time date de modification de la liste d'adresses

Exemple de retour

Réponse-succès

Statut HTTP : 200

{ "result": [ { "address_list_id": 65499, "address": "jg2@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 2, "desc": "desc222ss", "create_time": "2022-11-12T16:46:12+0800", "update_time": "2022-11-12T16:50:01+0800" } ], "total": 1, "count": 1 }
              
              {
  "result": [
            {
                "address_list_id": 65499,
                "address": "jg2@maillist.email.engagelab.com",
                "name": "1113-mailist",
                "member_count": 2,
                "desc": "desc222ss",
                "create_time": "2022-11-12T16:46:12+0800",
                "update_time": "2022-11-12T16:50:01+0800"
            }
        ],
        "total": 1,
        "count": 1
}
Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

Statut HTTP : 401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante

Interroger une liste d'adresses

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_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 de la requête

En-tête Type Obligatoire Description
Authorization String true Basic base64(api_user:api_key)

Exemple de requête

curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X GET "https://email.api.engagelab.cc/v1/address_lists/2112423" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante

Description de la valeur retournée

Paramètre Description
address_list_id id de la liste d'adresses
name nom de la liste
address adresse alias, utiliser cette adresse alias pour l'appel, format xxx@maillist.email.engagelab.com.
member_count nombre d'adresses dans la liste
desc description de la liste d'adresses
create_time date de création de la liste d'adresses
update_time date de modification de la liste d'adresses

Exemple de retour

Réponse-succès

Statut HTTP : 200

{ "result": { "address_list_id": 65499, "address": "jg2@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 2, "desc": "desc222ss", "create_time": "2022-11-12T16:46:12+0800", "update_time": "2022-11-12T16:50:01+0800" } }
              
              {
  "result":
            {
                "address_list_id": 65499,
                "address": "jg2@maillist.email.engagelab.com",
                "name": "1113-mailist",
                "member_count": 2,
                "desc": "desc222ss",
                "create_time": "2022-11-12T16:46:12+0800",
                "update_time": "2022-11-12T16:50:01+0800"
            }
}
Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

Statut HTTP : 401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante

Ajouter une liste d'adresses

URL

https://email.api.engagelab.cc/v1/address_lists
              
              https://email.api.engagelab.cc/v1/address_lists
Afficher ce bloc de code dans la fenêtre flottante

Content-Type:

Content-Type: application/json;charset=utf-8
              
              Content-Type: 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 true Basic base64(api_user:api_key)

Description des paramètres du corps

Paramètre Type Obligatoire ou non Description
name string oui nom de la liste. Maximum 48 caractères.
address string oui exemple : marketing@@maillist.email.engagelab.com
desc string non description de la liste

Exemple de requête

curl -X POST "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"scgd@email.engagelab.com", "name":"hongKong", "desc":"" }'
              
              curl -X POST "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"scgd@email.engagelab.com",
"name":"hongKong",
"desc":""
}'
Afficher ce bloc de code dans la fenêtre flottante

Description de la valeur retournée

Paramètre Description
address_list_id id de la liste
address adresse de la liste
member_count nombre de membres dans la liste
name nom de la liste
desc description de la liste d'adresses
create_time date de création de la liste d'adresses
update_time date de modification de la liste d'adresses

Exemple de valeur retournée

réponse succès { "result": { "address_list_id": 65504, "address": "jg3@maillist.email.engagelab.com", "name": "1113-mailist", "member_count": 0, "desc": "desc", "create_time": "2022-11-15T16:25:02+0800", "update_time": "2022-11-15T16:25:02+0800" } } réponse erreur { "code": 30000, "message": "Authentication failed." }
              
              réponse succès
{
     "result": {
            "address_list_id": 65504,
            "address": "jg3@maillist.email.engagelab.com",
            "name": "1113-mailist",
            "member_count": 0,
            "desc": "desc",
            "create_time": "2022-11-15T16:25:02+0800",
            "update_time": "2022-11-15T16:25:02+0800"
        }
}

réponse erreur
{ 
    "code": 30000,
    "message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante

Supprimer une liste d'adresses

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_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 true Basic base64(api_user:api_key)

Exemple de requête

curl -X DELETE "https://email.api.engagelab.cc/v1/address_list/2112423" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X DELETE "https://email.api.engagelab.cc/v1/address_list/2112423" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante

Description de la valeur retournée

Paramètre Description
count nombre de listes 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": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante

Modifier une liste d'adresses

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}
Afficher ce bloc de code dans la fenêtre flottante

Content-Type:

Content-Type: application/json;charset=utf-8
              
              Content-Type: application/json;charset=utf-8
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 true Basic base64(api_user:api_key)

Description des paramètres

Paramètre Type Obligatoire ou non Description
address string non exemple : marketing@@maillist.email.engagelab.com
name string non nom de la liste modifiée
desc string non description de la liste modifiée

Astuces :

【name】 ou 【desc】 peuvent être modifiés individuellement ou ensemble
              
              【name】 ou 【desc】 peuvent être modifiés individuellement ou ensemble
Afficher ce bloc de code dans la fenêtre flottante

Exemple de requête

curl -X PUT "https://email.api.engagelab.cc/v1/address_lists" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "address":"new@maillist.email.engagelab.com", "name":"GZ", "desc":"2" }'
              
              curl -X PUT "https://email.api.engagelab.cc/v1/address_lists" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
"address":"new@maillist.email.engagelab.com",
"name":"GZ",
"desc":"2"
}'
Afficher ce bloc de code dans la fenêtre flottante

Description de la valeur retournée

Réponse-succès

Statut HTTP : 200

Paramètre Description
count nombre de listes modifiées

Description de la 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": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante

Interroger les membres de la liste

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
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 true 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 l'offset, [0-], par défaut 0.
limit int non quantité, [0-100], par défaut 100.
email string non interroger l'adresse e-mail du membre. La recherche floue est prise en charge.
member_ids string non plusieurs IDs de membres séparés par ';'. Jusqu'à 100.

Exemple de requête

curl "https://email.api.engagelab.cc/v1/address_lists/123/members?offset=0&limit=20 --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl "https://email.api.engagelab.cc/v1/address_lists/123/members?offset=0&limit=20 --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante

Description de la valeur retournée

Paramètre Description
member_id ID du membre
email adresse e-mail du membre
name nom du membre
vars variables
create_time date de création de la liste d'adresses
update_time date de modification de la liste d'adresses

Exemple de valeur retournée

Réponse-succès

Statut HTTP : 200

{ "result": [ { "member_id": "11719293", "email": "example2@abc.com", "name": null, "vars": "{\"loc\":\"sss\"}", "create_time": "2022-11-13 11:23:44", "update_time": "2022-11-13 11:23:44" }, { "member_id": "11719294", "email": "example5@abc.com", "name": null, "vars": "{\"loc\":\"sss\"}", "create_time": "2022-11-15 16:34:47", "update_time": "2022-11-15 16:34:47" } ], "total": 2, "count": 2, "address_list_id": "65499" }
              
              {
    "result": [
        {
            "member_id": "11719293",
            "email": "example2@abc.com",
            "name": null,
            "vars": "{\"loc\":\"sss\"}",
            "create_time": "2022-11-13 11:23:44",
            "update_time": "2022-11-13 11:23:44"
        },
        {
            "member_id": "11719294",
            "email": "example5@abc.com",
            "name": null,
            "vars": "{\"loc\":\"sss\"}",
            "create_time": "2022-11-15 16:34:47",
            "update_time": "2022-11-15 16:34:47"
        }
    ],
    "total": 2,
    "count": 2,
    "address_list_id": "65499"
}
Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

Statut HTTP : 401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante

Ajouter un membre à la liste

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
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 true Basic base64(api_user:api_key)

Description des paramètres du corps

Paramètre Type Obligatoire ou non Description
members array[object] oui liste des membres. Jusqu'à 1000 membres.
email string oui adresse e-mail.
name string non nom du membre. Maximum 128 caractères.
vars string non variables. Maximum 1 Ko.

Astuces :

1. Lors de l'ajout de variables vars, notez que la clé n'a pas besoin d'être marquée avec '%', et la longueur de la clé ne peut pas dépasser 32 caractères. 2. Dans la variable vars, la variable dont la clé est name sera écrasée par le paramètre name. 3. Lors de l'envoi de la liste d'adresses, vous pouvez utiliser la variable globale recipient, dont la valeur est l'adresse e-mail du destinataire.
              
              1. Lors de l'ajout de variables vars, notez que la clé n'a pas besoin d'être marquée avec '%', et la longueur de la clé ne peut pas dépasser 32 caractères.
2. Dans la variable vars, la variable dont la clé est name sera écrasée par le paramètre name.
3. Lors de l'envoi de la liste d'adresses, vous pouvez utiliser la variable globale recipient, dont la valeur est l'adresse e-mail du destinataire.
Afficher ce bloc de code dans la fenêtre flottante

Exemple de requête

curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'
              
              curl -X POST "https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{"members":[{"email":"example6@abc.com","vars":{"loc":"sss"}}]}'
Afficher ce bloc de code dans la fenêtre flottante

Description de la valeur retournée

Champ Description
count nombre de membres ajoutés
invalid membre invalide
invalidCount nombre d'adresses e-mail qui n'ont pas pu être ajoutées
reasonList raison pour laquelle l'adresse e-mail n'a pas pu être ajoutée (correspond à l'adresse détaillée)

Exemple de valeur retournée

Réponse-succès

Statut HTTP : 200

{ "result": { "count": 2, "invalidCount": 1, "invalid": [ "wang.@yahoo.com" ], "reasonList": [ "Member email format erorr" ] } }
              
              {
    "result": {
        "count": 2,
        "invalidCount": 1,
        "invalid": [
            "wang.@yahoo.com"
        ],
        "reasonList": [
            "Member email format erorr"
        ]
    }
}
Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

Statut HTTP : 401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante

Modifier un membre de la liste

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members/{member_id}
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

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 true Basic base64(api_user:api_key)

Description des paramètres du corps

Paramètre Type Obligatoire ou non Description
email string oui adresse e-mail
name string non nom du membre. Maximum 128 caractères.
vars object non variables. Maximum 1 Ko. La longueur de la clé ne peut pas dépasser 32 caractères

Exemple de requête

curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{"email":"x@engagelab.com","name":"jim"}'
              
              curl -X PUT "https://email.api.engagelab.cc/v1/address_lists/123/members/1222002" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{"email":"x@engagelab.com","name":"jim"}'
Afficher ce bloc de code dans la fenêtre flottante

Description de la valeur retournée

Champ Description
count nombre d'adresses modifiées
reason raison pour laquelle l'adresse e-mail n'a pas pu être mise à jour

Exemple de valeur retournée

Réponse-succès

Statut HTTP : 200

{ "count": 0, "reason": "Member email format erorr" }
              
              {
    "count": 0,
    "reason": "Member email format erorr" 
}
Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

Statut HTTP : 401

{ "code": 30000, "message": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante

Supprimer un membre de la liste

URL

https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
              
              https://email.api.engagelab.cc/v1/address_lists/{address_list_id}/members
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 true Basic base64(api_user:api_key)

Description des paramètres de requête

Paramètre Type Obligatoire ou non Description
member_ids string oui Liste des IDs des membres séparés par un point-virgule ';', jusqu'à 100 membres.

Exemple de requête

curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
              
              curl -X DELETE "https://email.api.engagelab.cc/v1/address_lists/123/members?member_ids=12242;1224" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante

Description de la valeur retournée

Champ Description
count nombre d'adresses 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": "Authentication failed." }
              
              { 
    "code": 30000,
    "message": "Authentication failed."
}
Afficher ce bloc de code dans la fenêtre flottante
icon
Contactez-nous