Réponse de Livraison
Adresse d'appel
| 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/email_status
Requête
Liste des statuts d'e-mail.
Vous pouvez vérifier le statut de vos e-mails dans cette liste.
URL
https://email.api.engagelab.cc/v1/email_status
https://email.api.engagelab.cc/v1/email_status
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 | string | non | position de départ, [0-], valeur par défaut 0 |
| limit | int | non | quantité, [0-100], valeur par défaut 100 |
| send_date | string | oui | le format de la date d'envoi est yyyy-MM-dd |
| string | non | adresse du destinataire | |
| email_ids | string | non | emailId sera retourné après qu'un e-mail ait été envoyé avec succès via l'API ; les adresses sont séparées par des points-virgules, ex. email_ids=a;b;c |
| api_user | string | non | nom de l'api_user |
| domain_name | string | non | domaine de réception, par exemple : gmail.com |
| label_id | string | non | ID d'étiquette correspondant à l'étiquette créée |
| status | string | non | statut. La valeur du statut d'envoi est 18, la valeur du statut délivré est 1, la valeur du soft bounce est 5, la valeur du statut d'e-mail invalide est 4. |
| sub_status | string | non | plusieurs sub_status, séparés par des points-virgules, ex. sub_status=a;b;c. Lorsque ce paramètre est renseigné, le paramètre status est inactif. |
Astuces :
- 100 enregistrements sont affichés par défaut pour chaque recherche. Vous devez spécifier limit et offset si le nombre d'enregistrements dépasse 100.
- Chaque enregistrement de requête sera mis en cache pendant 10 minutes.
- Cette interface limite chaque compte utilisateur à 60 appels par minute. Si cela ne répond pas à vos besoins, veuillez utiliser WebHook.
- Si le paramètre email est renseigné, les détails de livraison de l'adresse correspondante dans les 30 jours suivant la send_date peuvent être consultés. Si le paramètre email n'est pas renseigné, seuls les détails des données à la send_date peuvent être consultés.
| sub_status | description du sub_status |
|---|---|
| 401 | E-mail invalide - Liste noire |
| 402 | E-mail invalide - Désabonnement |
| 403 | E-mail invalide - Erreur serveur |
| 404 | E-mail invalide - Erreur de format |
| 405 | E-mail invalide - Rejet IP |
| 406 | E-mail invalide - N'existe pas |
| 407 | E-mail invalide - Courrier indésirable |
| 408 | E-mail invalide - Rejeté |
| 409 | E-mail invalide - Autres |
| 503 | Soft bounce - Erreur serveur |
| 505 | Soft bounce - Rejet IP |
| 506 | Soft bounce - N'existe pas |
| 507 | Soft bounce - Rejeté pour spam |
| 508 | Soft bounce - Rejeté |
| 509 | Soft bounce - Autres |
Exemple de requête :
curl "https://email.api.engagelab.cc/v1/email_status?send_date=2022-11-21&email_ids=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl "https://email.api.engagelab.cc/v1/email_status?send_date=2022-11-21&email_ids=***;***" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Champ | Description |
|---|---|
| adresse du destinataire | |
| email_id | emailId retourné après l'envoi réussi d'un e-mail via l'API |
| api_user | nom de l'api_user |
| status | statut de l'e-mail |
| status_desc | description du statut |
| sub_status | code de statut invalide 401-509 |
| sub_status_desc | description de la sous-catégorie invalide ou soft bounce |
| request_time | heure de la requête |
| update_time | heure de mise à jour |
| response_message | réponse |
Exemple de valeur retournée
{
"result": [
{
"email_id": "1668065941982_15_2032_7460.sc-10_2_226_96-test0$1720f4a1d6af047181@hotmail.com",
"api_user": "zymtest4",
"email": "1720f4a1d6af047181@hotmail.com",
"request_time": "2022-11-10T15:39:01+0800",
"update_time": "2022-11-10T17:34:16+0800",
"status": 4,
"sub_status": 409,
"status_desc": "E-mail invalide",
"sub_status_desc": "Autre",
"response_message": "Autre(scheduler: deleted)"
}
],
"total": "48675",
"count": 1
}
{
"result": [
{
"email_id": "1668065941982_15_2032_7460.sc-10_2_226_96-test0$1720f4a1d6af047181@hotmail.com",
"api_user": "zymtest4",
"email": "1720f4a1d6af047181@hotmail.com",
"request_time": "2022-11-10T15:39:01+0800",
"update_time": "2022-11-10T17:34:16+0800",
"status": 4,
"sub_status": 409,
"status_desc": "E-mail invalide",
"sub_status_desc": "Autre",
"response_message": "Autre(scheduler: deleted)"
}
],
"total": "48675",
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
