API de désabonnement
Lorsqu'un destinataire se désabonne d'un e-mail, son adresse sera ajoutée à la liste de désabonnement. Aucun e-mail ne sera plus envoyé à l'adresse désabonnée. Vous pouvez consulter, supprimer et ajouter des adresses dans la 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 bonne URL de base.
POST/v1/unsubscribes
Consultation
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
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
| 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 |
|---|---|---|---|
| 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, par ex. 22@gmail.com |
|
| api_user | string | non | API_USER spécifié, par défaut all |
| offset | int | non | Position de départ [0-], par défaut 0 |
| limit | int | non | Quantité [0-100], par défaut 100 |
Astuces :
- La période ne peut pas dépasser 3 mois.
- Lors d'une recherche avec une adresse e-mail donnée, la période est ignorée.
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/unsubscribes?offset=0&limit=30'
curl -X GET -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
'https://email.api.engagelab.cc/v1/unsubscribes?offset=0&limit=30'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| Adresse e-mail | |
| api_user | API_USER |
| type | Type de désabonnement (0, 1, 2, 3) |
| unsubscribe_time | Horodatage du désabonnement |
| expire_time | Date d'expiration de l'interception du désabonnement |
| Type | Description |
|---|---|
| 0 | Je ne souhaite plus recevoir ce type d'e-mail |
| 1 | Je ne m'y suis pas abonné |
| 2 | Ceci est un e-mail indésirable |
| 3 | Ceci est un e-mail frauduleux, je souhaite le signaler |
Exemple de valeur retournée :
{
"result": [
{
"email": "524244185@qq.com",
"unsubscribe_time": "2021-01-12T17:03:23+08:00",
"expire_time": "2023-01-12T17:03:23+08:00",
"api_user": "delong_test",
"type": 0
}
],
"count": 1,
"total": 1
}
{
"result": [
{
"email": "524244185@qq.com",
"unsubscribe_time": "2021-01-12T17:03:23+08:00",
"expire_time": "2023-01-12T17:03:23+08:00",
"api_user": "delong_test",
"type": 0
}
],
"count": 1,
"total": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Ajout
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
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
| 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 |
|---|---|---|---|
| string | oui | Adresse e-mail à ajouter | |
| expire_time | string | oui | Date d'expiration de l'interception (yyyy-MM-dd) |
Exemple de requête :
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
curl -X POST -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"email": "xjmfc23@126.com","expire_time":"2023-12-31"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| Adresse e-mail | |
| api_user | API_USER |
| unsubscribe_time | Date de désabonnement |
| expire_time | Date d'expiration |
Exemple de valeur retournée :
{
"result": {
"email": "abc@qq.com",
"api_user": "api_user",
"unsubscribe_time": "2014-11-19 10:57:24",
"expire_time": "2014-11-19 10:57:24"
}
}
{
"result": {
"email": "abc@qq.com",
"api_user": "api_user",
"unsubscribe_time": "2014-11-19 10:57:24",
"expire_time": "2014-11-19 10:57:24"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Suppression
URL
https://email.api.engagelab.cc/v1/unsubscribes
https://email.api.engagelab.cc/v1/unsubscribes
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) |
Description des paramètres du corps
| Paramètre | Type | Obligatoire ou non | Description |
|---|---|---|---|
| string | * | Adresses e-mail à supprimer | |
| start_date | string | * | Date de début (format : yyyy-MM-dd) |
| end_date | string | * | Date de fin (format : yyyy-MM-dd) |
Exemple de requête
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
curl -X DELETE -H 'Content-Type: application/json; charset=utf-8'
-H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ=='
--data '{"start_date": "2023-04-06","end_date":"2023-07-06", "email": "example1@example.com"}'
'https://email.api.engagelab.cc/v1/unsubscribes'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs retournées
| Paramètre | Description |
|---|---|
| count | Nombre d'adresses supprimées |
Exemple de valeur retournée :
Réponse-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status: 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
