Règles
Centre de données et URL de base
| 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/mail/<module>
Format de requête API
https://email.api.engagelab.cc/v1/<module>/<action>
Module : nom du module fonctionnel, par exemple module mail, module addresslist.
Action : action de chaque module, par exemple send, add.
Code de retour de l'API
L'API retourne des données au format JSON. Exemple ci-dessous :
# la requête a réussi
{
"result": {}
}
# Échec de l'authentification
{
"code": 30000,
"message": "Authentication failed",
}
# Acquisition des données réussie
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-10T15:47:05+0800",
"update_time": "2022-11-10T15:47:05+0800"
}
]
}
# la requête a réussi
{
"result": {}
}
# Échec de l'authentification
{
"code": 30000,
"message": "Authentication failed",
}
# Acquisition des données réussie
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-10T15:47:05+0800",
"update_time": "2022-11-10T15:47:05+0800"
}
]
}
Afficher ce bloc de code dans la fenêtre flottante
- httpStatus : 200
- result : Informations sur les données
Code de statut HTTP
| Statut | Description | Signification |
|---|---|---|
| 200 | Succès | La requête a réussi. |
| 400 | Mauvaise requête | La requête n'a pas pu être comprise par le serveur en raison d'une syntaxe incorrecte. |
| 401 | Non autorisé | La requête nécessite une authentification utilisateur. |
| 404 | Introuvable | Le serveur n'a rien trouvé correspondant à l'URI de la requête |
| 500 | Erreur interne du serveur | Le serveur a rencontré une condition inattendue qui l'a empêché de satisfaire la requête. |
Description du format d'adresse e-mail
Format de l'adresse e-mail : local_part@domain_part, composé de local_part, @ et domain_part. L'adresse e-mail valide doit respecter les règles suivantes :
- local_part@domain_part doit comporter au minimum 6 caractères et au maximum 128 caractères ;
- La longueur maximale de local_part est de 96 caractères et ne peut pas contenir le caractère @ ;
- domain_part ne peut contenir que a-zA-Z0-9 -. Il ne peut pas commencer ni se terminer par -. La longueur totale ne dépasse pas 255 caractères, et chaque segment ne dépasse pas 63 caractères. Le domaine de premier niveau ne peut contenir que 2 à 20 lettres anglaises majuscules ou minuscules ;
Dictionnaire des fuseaux horaires
| Zone | Description |
|---|---|
| -12 | Ligne de changement de date internationale Ouest |
| -11 | Temps universel coordonné-11 |
| -10 | Îles Aléoutiennes (Hawaï) |
| -9 | Alaska (Temps universel coordonné-09) |
| -8 | Basse-Californie (Temps universel coordonné-08, Heure du Pacifique [États-Unis & Canada]) |
| -7 | Arizona (Chihuahua, La Paz, Mazatlan, Heure des Rocheuses [États-Unis & Canada], Yukon) |
| -6 | Amérique centrale (Heure centrale [États-Unis & Canada], Île de Pâques, Guadalajara, Mexico, Monterrey, Saskatchewan) |
| -5 | Bogota, Lima, Quito, Rio Branco (Chetumal, Heure de l'Est [États-Unis & Canada], Haïti, La Havane, Indiana [Est], Turks et Caicos) |
| -4 | Asuncion (Heure de l'Atlantique [Canada], Caracas, Cuiaba, Georgetown, La Paz, Manaus, San Juan, Santiago) |
| -3 | Araguaina (Brasilia, Cayenne, Fortaleza, Buenos Aires, Groenland, Montevideo, Punta Arenas, Saint-Pierre-et-Miquelon, Salvador) |
| -2 | Temps universel coordonné-02 |
| -1 | Açores (Îles du Cap-Vert) |
| 0 | Dublin, Édimbourg, Lisbonne, Londres (Monrovia, Reykjavik, Sao Tomé) |
| 1 | Casablanca (Amsterdam, Berlin, Berne, Rome, Stockholm, Vienne, Belgrade, Bratislava, Budapest, Ljubljana, Prague, Bruxelles, Copenhague, Madrid, Paris, Sarajevo, Skopje, Varsovie, Zagreb, Afrique centrale occidentale) |
| 2 | Amman (Athènes, Bucarest, Beyrouth, Le Caire, Chisinau, Damas, Gaza, Hébron, Harare, Pretoria, Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius, Jérusalem, Kaliningrad, Khartoum, Tripoli, Windhoek) |
| 3 | Bagdad (Istanbul, Koweït, Riyad, Minsk, Moscou, Saint-Pétersbourg, Nairobi) |
| 4 | Abou Dhabi, Mascate (Astrakhan, Oulianovsk, Bakou, Ijevsk, Samara, Port-Louis, Saratov, Tbilissi, Volgograd, Erevan) |
| 5 | Achgabat, Tachkent (Ekaterinbourg, Islamabad, Karachi, Qyzylorda) |
| 6 | Astana (Dacca, Omsk) |
| 7 | Bangkok, Hanoï, Jakarta (Barnaoul, Gorno-Altaïsk, Hovd, Krasnoïarsk, Novossibirsk, Tomsk) |
| 8 | Pékin, Chongqing, Hong Kong, Urumqi (Irkoutsk, Kuala Lumpur, Singapour, Perth, Taipei, Oulan-Bator) |
| 9 | Chita (Osaka, Sapporo, Tokyo, Pyongyang, Séoul, Iakoutsk) |
| 10 | Brisbane (Canberra, Melbourne, Sydney, Guam, Port Moresby, Hobart, Vladivostok) |
| 11 | Île Bougainville (Chokurdakh, Magadan, Île Norfolk, Sakhaline, Îles Salomon, Nouvelle-Calédonie) |
| 12 | Anadyr, Petropavlovsk-Kamtchatski (Auckland, Wellington, Temps universel coordonné+12, Fidji) |
Dictionnaire des fuseaux horaires du calendrier
| time_zone_id | fuseau horaire |
|---|---|
| Africa/Abidjan | +0000 |
| Africa/Algiers | +0100 |
| Africa/Bissau | +0000 |
| Africa/Cairo | +0200 |
| Africa/Casablanca | +0000 |
| Africa/Ceuta | +0100 |
| Africa/El_Aaiun | +0000 |
| Africa/Johannesburg | +0200 |
| Africa/Juba | +0200 |
| Africa/Khartoum | +0200 |
| Africa/Lagos | +0100 |
| Africa/Maputo | +0200 |
| Africa/Monrovia | +0000 |
| Africa/Nairobi | +0300 |
| Africa/Ndjamena | +0100 |
| Africa/Sao_Tome | +0000 |
| Africa/Tripoli | +0200 |
| Africa/Tunis | +0100 |
| Africa/Windhoek | +0200 |
| America/Adak | -1000,-0900 |
| America/Anchorage | -0900,-0800 |
| America/Araguaina | -0300 |
| America/Asuncion | -0400,-0300 |
| America/Bahia | -0300 |
| America/Bahia_Banderas | -0600 |
| America/Barbados | -0400 |
| America/Belem | -0300 |
| America/Belize | -0600 |
| America/Boa_Vista | -0400 |
| America/Bogota | -0500 |
| America/Boise | -0700,-0600 |
| America/Cambridge_Bay | -0700,-0600 |
| America/Campo_Grande | -0400 |
| America/Cancun | -0500 |
| America/Caracas | -0400 |
| America/Cayenne | -0300 |
| America/Chicago | -0600,-0500 |
| America/Chihuahua | -0600 |
| America/Costa_Rica | -0600 |
| America/Cuiaba | -0400 |
| America/Danmarkshavn | +0000 |
| America/Dawson | -0700 |
| America/Dawson_Creek | -0700 |
| America/Denver | -0700,-0600 |
| America/Detroit | -0500,-0400 |
| America/Edmonton | -0700,-0600 |
| America/Eirunepe | -0500 |
| America/El_Salvador | -0600 |
| America/Fort_Nelson | -0700 |
| America/Fortaleza | -0300 |
| America/Glace_Bay | -0400,-0300 |
| America/Goose_Bay | -0300,-0400 |
| America/Grand_Turk | -0400,-0500 |
| America/Guatemala | -0600 |
| America/Guayaquil | -0500 |
| America/Guyana | -0400 |
| America/Halifax | -0400 |
| America/Havana | -0400,-0500 |
| America/Hermosillo | -0700,-0700 |
| America/Inuvik | -0700,-0600 |
| America/Iqaluit | -0500,-0400 |
| America/Jamaica | -0500 |
| America/Juneau | -0900,-0800 |
| America/La_Paz | -0400 |
| America/Lima | -0500 |
| America/Los_Angeles | -0800,-0700 |
| America/Maceio | -0300 |
| America/Managua | -0600 |
| America/Manaus | -0400 |
| America/Martinique | -0400 |
| America/Matamoros | -0600,-0500 |
| America/Mazatlan | -0700 |
| America/Menominee | -0600 |
| America/Merida | -0600 |
| America/Metlakatla | -0900,-0800 |
| America/Mexico_City | -0600 |
| America/Miquelon | -0300,-0200 |
| America/Moncton | -0400,-0300 |
| America/Monterrey | -0600 |
| America/Montevideo | -0300 |
| America/New_York | -0500,-0400 |
| America/Nome | -0900,-0800 |
| America/Noronha | -0200 |
| America/Nuuk | -0300,-0200 |
| America/Ojinaga | -0600 |
| America/Panama | -0500 |
| America/Pangnirtung | -0500,-0400 |
| America/Paramaribo | -0300 |
| America/Phoenix | -0700 |
| America/Port-au-Prince | -0500,-0400 |
| America/Porto_Velho | -0400 |
| America/Puerto_Rico | -0400 |
| America/Punta_Arenas | -0300 |
| America/Rankin_Inlet | -0600,-0500 |
| America/Recife | -0300 |
| America/Regina | -0600 |
| America/Resolute | -0500,-0600 |
| America/Rio_Branco | -0500 |
| America/Santarem | -0300 |
| America/Santiago | -0300,-0400 |
| America/Santo_Domingo | -0400 |
| America/Sao_Paulo | -0300 |
| America/Scoresbysund | -0100,+0000 |
| America/Sitka | -0900,-0800 |
| America/St_Johns | -0230,-0330 |
| America/Swift_Current | -0600 |
| America/Tegucigalpa | -0600 |
| America/Thule | -0400,-0300 |
| America/Tijuana | -0800,-0700 |
| America/Toronto | -0500,-0400 |
| America/Vancouver | -0800,-0700 |
| America/Whitehorse | -0700 |
| America/Winnipeg | -0600,-0500 |
| America/Yakutat | -0900,-0800 |
| America/Yellowknife | -0700,-0600 |
| America/Argentina/Buenos_Aires | -0300 |
| America/Argentina/Catamarca | -0300 |
| America/Argentina/Cordoba | -0300 |
| America/Argentina/Jujuy | -0300 |
| America/Argentina/La_Rioja | -0300 |
| America/Argentina/Mendoza | -0300 |
| America/Argentina/Rio_Gallegos | -0300 |
| America/Argentina/Salta | -0300 |
| America/Argentina/San_Juan | -0300 |
| America/Argentina/San_Luis | -0300 |
| America/Argentina/Tucuman | -0300 |
| America/Argentina/Ushuaia | -0300 |
| America/Indiana/Indianapolis | -0500,-0400 |
| America/Indiana/Knox | -0600,-0500 |
| America/Indiana/Marengo | -0500,-0400 |
| America/Indiana/Petersburg | -0500,-0400 |
| America/Indiana/Tell_City | -0600,-0500 |
| America/Indiana/Vevay | -0500,-0400 |
| America/Indiana/Vincennes | -0500,-0400 |
| America/Indiana/Winamac | -0400,-0500 |
| America/Kentucky/Louisville | -0500,-0400 |
| America/Kentucky/Monticello | -0500,-0400 |
| America/North_Dakota/Beulah | -0600,-0500 |
| America/North_Dakota/Center | -0600,-0500 |
| America/North_Dakota/New_Salem | -0600,-0500 |
| Antarctica/Casey | +1100 |
| Antarctica/Davis | +0700 |
| Antarctica/Macquarie | +1100 |
| Antarctica/Mawson | +0500 |
| Antarctica/Palmer | -0300 |
| Antarctica/Rothera | -0300 |
| Antarctica/Troll | +0000,+0200 |
| Asia/Almaty | +0600 |
| Asia/Amman | +0300 |
| Asia/Anadyr | +1200 |
| Asia/Aqtau | +0500 |
| Asia/Aqtobe | +0500 |
| Asia/Ashgabat | +0500 |
| Asia/Atyrau | +0500 |
| Asia/Baghdad | +0300 |
| Asia/Baku | +0400 |
| Asia/Bangkok | +0700 |
| Asia/Barnaul | +0700 |
| Asia/Beirut | +0200,+0300 |
| Asia/Bishkek | +0600 |
| Asia/Chita | +0900 |
| Asia/Choibalsan | +0800 |
| Asia/Colombo | +0530 |
| Asia/Damascus | +0300 |
| Asia/Dhaka | +0600 |
| Asia/Dili | +0900 |
| Asia/Dubai | +0400 |
| Asia/Dushanbe | +0500 |
| Asia/Famagusta | +0200,+0300 |
| Asia/Gaza | +0300,+0200 |
| Asia/Hebron | +0300,+0200 |
| Asia/Ho_Chi_Minh | +0700 |
| Asia/Hong_Kong | +0800 |
| Asia/Hovd | +0700 |
| Asia/Irkutsk | +0800 |
| Asia/Jakarta | +0700 |
| Asia/Jayapura | +0900 |
| Asia/Jerusalem | +0200,+0300 |
| Asia/Kabul | +0430 |
| Asia/Kamchatka | +1200 |
| Asia/Karachi | +0500 |
| Asia/Kathmandu | +0545 |
| Asia/Khandyga | +0900 |
| Asia/Kolkata | +0530 |
| Asia/Krasnoyarsk | +0700 |
| Asia/Kuching | +0800 |
| Asia/Macau | +0800 |
| Asia/Magadan | +1100 |
| Asia/Makassar | +0800 |
| Asia/Manila | +0800 |
| Asia/Nicosia | +0300,+0200 |
| Asia/Novokuznetsk | +0700 |
| Asia/Novosibirsk | +0700 |
| Asia/Omsk | +0600 |
| Asia/Oral | +0500 |
| Asia/Pontianak | +0700 |
| Asia/Pyongyang | +0900 |
| Asia/Qatar | +0300 |
| Asia/Qostanay | +0600 |
| Asia/Qyzylorda | +0500 |
| Asia/Riyadh | +0300 |
| Asia/Sakhalin | +1100 |
| Asia/Samarkand | +0500 |
| Asia/Seoul | +0900 |
| Asia/Shanghai | +0800 |
| Asia/Singapore | +0800 |
| Asia/Srednekolymsk | +1100 |
| Asia/Taipei | +0800 |
| Asia/Tashkent | +0500 |
| Asia/Tbilisi | +0400 |
| Asia/Tehran | +0330 |
| Asia/Thimphu | +0600 |
| Asia/Tokyo | +0900 |
| Asia/Tomsk | +0700 |
| Asia/Ulaanbaatar | +0800 |
| Asia/Urumqi | +0600 |
| Asia/Ust-Nera | +1000 |
| Asia/Vladivostok | +1000 |
| Asia/Yakutsk | +0900 |
| Asia/Yangon | +0630 |
| Asia/Yekaterinburg | +0500 |
| Asia/Yerevan | +0400 |
| Atlantic/Azores | -0100,+0000 |
| Atlantic/Bermuda | -0400,-0300 |
| Atlantic/Canary | +0000,+0100 |
| Atlantic/Cape_Verde | -0100,-0100 |
| Atlantic/Faroe | +0000,+0100 |
| Atlantic/Madeira | +0000,+0100 |
| Atlantic/South_Georgia | -0200 |
| Atlantic/Stanley | -0300 |
| Europe/Andorra | +0100,+0200 |
| Europe/Astrakhan | +0400 |
| Europe/Athens | +0200,+0300 |
| Europe/Belgrade | +0100,+0200 |
| Europe/Berlin | +0100,+0200 |
| Europe/Brussels | +0100,+0200 |
| Europe/Bucharest | +0200,+0300 |
| Europe/Budapest | +0100,+0200 |
| Europe/Chisinau | +0200,+0300 |
| Europe/Dublin | +0000,+0100 |
| Europe/Gibraltar | +0100,+0200 |
| Europe/Helsinki | +0200,+0300 |
| Europe/Istanbul | +0300,+0300 |
| Europe/Kaliningrad | +0200 |
| Europe/Kirov | +0300 |
| Europe/Kyiv | +0300,+0200 |
| Europe/Lisbon | +0100,+0000 |
| Europe/London | +0000,+0100 |
| Europe/Madrid | +0100,+0200 |
| Europe/Malta | +0100,+0200 |
| Europe/Minsk | +0300 |
| Europe/Moscou | +0300 |
| Europe/Paris | +0100,+0200 |
| Europe/Prague | +0100,+0200 |
| Europe/Riga | +0200,+0300 |
| Europe/Rome | +0100,+0200 |
| Europe/Samara | +0400 |
| Europe/Saratov | +0400 |
| Europe/Simferopol | +0300 |
| Europe/Sofia | +0200,+0300 |
| Europe/Tallinn | +0200,+0300 |
| Europe/Tirane | +0100,+0200 |
| Europe/Ulyanovsk | +0400 |
| Europe/Vienne | +0100,+0200 |
| Europe/Vilnius | +0200,+0300 |
| Europe/Volgograd | +0300 |
| Europe/Varsovie | +0100,+0200 |
| Europe/Zurich | +0100,+0200 |
| Indian/Chagos | +0600 |
| Indian/Maldives | +0500 |
| Indian/Mauritius | +0400 |
| Pacific/Auckland | +1200,+1300 |
| Pacific/Bougainville | +1100 |
| Pacific/Chatham | +1245,+1345 |
| Pacific/Easter | -0500,-0600 |
| Pacific/Efate | +1100 |
| Pacific/Fakaofo | +1300 |
| Pacific/Fiji | +1200 |
| Pacific/Galapagos | -0600 |
| Pacific/Gambier | -0900 |
| Pacific/Guadalcanal | +1100 |
| Pacific/Guam | +1000 |
| Pacific/Honolulu | -1000 |
| Pacific/Kanton | +1300 |
| Pacific/Kiritimati | +1400 |
| Pacific/Kosrae | +1100 |
| Pacific/Kwajalein | +1200 |
| Pacific/Marquesas | -0930 |
| Pacific/Nauru | +1200 |
| Pacific/Niue | -1100 |
| Pacific/Norfolk | +1100,+1200 |
| Pacific/Noumea | +1100 |
| Pacific/Pago_Pago | -1100 |
| Pacific/Palau | +0900 |
| Pacific/Pitcairn | -0800 |
| Pacific/Port_Moresby | +1000 |
| Pacific/Rarotonga | -1000 |
| Pacific/Tahiti | -1000 |
| Pacific/Tarawa | +1200 |
| Pacific/Tongatapu | +1300 |
Dictionnaire des paliers
| Palier | Description |
|---|---|
| -1 | Gratuit |
| 1 | 100 par heure, 1k par jour |
| 2 | 250 par heure, 2,5k par jour |
| 3 | 250 par heure, 5k par jour |
| 4 | 650 par heure, 6,5k par jour |
| 5 | 800 par heure, 8k par jour |
| 6 | 1k par heure, 10k par jour |
| 7 | 1,4k par heure, 14k par jour |
| 8 | 2k par heure, 20k par jour |
| 9 | 2,5k par heure, 25k par jour |
| 10 | 3,5k par heure, 35k par jour |
| 11 | 5k par heure, 50k par jour |
| 12 | 8k par heure, 80k par jour |
| 13 | 12k par heure, 120k par jour |
| 14 | 17,5k par heure, 175k par jour |
| 15 | 25k par heure, 250k par jour |
Conditions de filtrage
Structure de la condition de filtrage
{
"condition": {
"relation": "or",
"items": [
{
"field_name": "createTime",
"op": ">=",
"value": "2021-10-11"
},
{
"field_name": "Name",
"op": "contain",
"value": "left"
}
]
}
}
# Condition de filtrage : createTime >= '2021-10-11' ou Name contient 'left'
{
"condition": {
"relation": "or",
"items": [
{
"field_name": "createTime",
"op": ">=",
"value": "2021-10-11"
},
{
"field_name": "Name",
"op": "contain",
"value": "left"
}
]
}
}
# Condition de filtrage : createTime >= '2021-10-11' ou Name contient 'left'
Afficher ce bloc de code dans la fenêtre flottante
Explication des conditions de filtrage
| Paramètre | Description |
|---|---|
| condition | Groupe de conditions de filtrage |
| relation | Relation entre les conditions (and ou or) |
| items | Conditions de filtrage, voir le tableau ci-dessous |
| fieldName | fieldType | op | Description | ||
| Conditions de filtrage | Filtrer par Tag | tag | Aucun | ( == , != , contain , does not contain ) | Créer le tag avant de filtrer par tag |
| Filtrer par champ | Champ système (Email, Name, Phone) |
Texte | ( contain , does not contain ) | Représente respectivement l'e-mail, le nom, le numéro de téléphone | |
| Champ système (createTime, updateTime, unsubscribeTime) |
Date | ( == , != , < , > , <= , >= ) | Représente la date de création, de mise à jour, de désabonnement. Format : JJ/MM/AAAA, ex : 02/04/2022, ne peut pas être 2/4/2022 | ||
| Nom de champ personnalisé courant (ex : SendTime) |
Date | ( == , != , < , > , <= , >= ) | Format : MM/JJ/AAAA ou JJ/MM/AAAA | ||
| Nom de champ personnalisé courant (ex : Birthday) |
Anniversaire | ( == , != , < , > , <= , >= ) | Format : MM/JJ ou JJ/MM | ||
| Nom d'attribut personnalisé courant (ex : Age) |
Nombre | ( == , != , < , > , <= , >= ) | Format : 0 ou .0 ou .00 | ||
| Nom d'attribut personnalisé courant (ex : Genre) |
Liste déroulante | ( == , != ) | Lors de la création de cet attribut, le contenu des options doit être défini simultanément, avec un maximum de 10 options | ||
| Nom d'attribut personnalisé | Texte, Date, Anniversaire, Nombre ou Liste déroulante | Déterminé par fieldType | Valeurs pour d'autres attributs personnalisés | ||

