API des réclamations
Lorsque les utilisateurs signalent des e-mails indésirables, leurs adresses e-mail seront ajoutées à la liste des réclamations pour spam.
Dans cette liste, les adresses e-mail seront interceptées par le système, et le statut de distribution sera classé comme « E-mail invalide - Dans la liste noire SendCloud : Rebondi (worker : adresse dans la liste de réclamations) ».
Vous pouvez interroger et supprimer des adresses e-mail de cette liste.
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 à la base URL appropriée.
POST/v1/complaints
Requête
URL
https://email.api.engagelab.cc/v1/complaints
Méthode de requête HTTP
GET
Description des paramètres de requête
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| start_date | string | * | Date de début (format : yyyy-MM-dd) |
| end_date | string | * | Date de fin (format : yyyy-MM-dd) |
| string | * | Adresse e-mail, ex : 22@gmail.com |
|
| offset | int | non | Position de départ [0-], valeur par défaut 0 |
| limit | int | non | Quantité [0-100], valeur par défaut 100 |
Exemple de requête :
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/complaints?offset=0&limit=90'
Description de la valeur retournée
| Paramètre | Description |
|---|---|
| Adresse e-mail signalée | |
| reason | Motif de la réclamation |
| complaint_time | Horodatage de la réclamation |
| expire_time | Date d'expiration de l'interception |
Exemple de valeur retournée
{
"result": [
{
"email": "9978977@qq.com",
"reason": "from softbounce",
"complaint_time": "2016-02-01T14:53:20+0800",
"expire_time": "2017-02-01T14:53:20+0800"
}
],
"count": 1,
"total": 1
}
Suppression
URL
https://email.api.engagelab.cc/v1/complaints
Méthode de requête HTTP
DELETE
Description des paramètres du corps de requête
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| start_date | string | * | Date de début (format : yyyy-MM-dd) |
| end_date | string | * | Date de fin (format : yyyy-MM-dd) |
| string | * | Adresse e-mail à supprimer |
Exemple de requête
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"email": "x@example.com"}'
'https://email.api.engagelab.cc/v1/complaints'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"start_date": "2023-04-01 08:00:00", "end_date": "2023-07-01 08:00:00"}'
'https://email.api.engagelab.cc/v1/complaints'
Description de la valeur retournée Aucune
Exemple de valeur retournée
{
"count": 2
}
