Expéditeur
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/marketing/senders
Créer
URL
https://email.api.engagelab.cc/v1/marketing/senders
https://email.api.engagelab.cc/v1/marketing/senders
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
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(api_user:api_key) |
Paramètres du corps
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| from_name | string | oui | Nom de l'expéditeur |
| string | oui | Adresse e-mail de l'expéditeur. Doit être au format e-mail et avoir un nom de domaine avec le suffixe domain_name. | |
| domain_name | string | oui | Nom de domaine (par configuration) |
| api_user | string | oui | Nom de l'api_user |
Remarque :
- Le domain_name et l'api_user doivent correspondre l'un à l'autre.
Exemple de requête
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders --data '{
"from_name": "Linghu",
"email": "xjmfc@126.com",
"domain_name": "126.com",
"api_user": "test_abc"
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders --data '{
"from_name": "Linghu",
"email": "xjmfc@126.com",
"domain_name": "126.com",
"api_user": "test_abc"
}'
Afficher ce bloc de code dans la fenêtre flottante
Exemple de réponse
Réponse-succès
HttpStatus: 200
{
"result": {
"sender_id": 449,
"name": "Qiaofeng2",
"email": "zhou@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin_new",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
}
{
"result": {
"sender_id": 449,
"name": "Qiaofeng2",
"email": "zhou@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin_new",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HttpStatus: 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
Supprimer
URL
https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}
https://email.api.engagelab.cc/v1/marketing/senders/{sender_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
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(api_user:api_key) |
Exemple de requête
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/857
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/857
Afficher ce bloc de code dans la fenêtre flottante
Exemple de réponse
Réponse-succès
HttpStatus: 200
{
"count":1
}
{
"count":1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HttpStatus: 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
Mettre à jour
URL
https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}
https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}
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
Content-Type
application/json; charset=utf-8
application/json; charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(api_user:api_key) |
Paramètres du corps
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| from_name | string | non | Nom de l'expéditeur |
| string | non | Adresse de l'expéditeur, doit être au format e-mail avec domain_name comme suffixe de domaine | |
| domain_name | string | non | Domaine (par configuration) |
| api_user | string | non | Nom de l'api_user |
Remarque :
- Les valeurs de from_name, email, domain_name et api_user ne peuvent pas être des chaînes vides ou des caractères nuls.
Exemple de requête
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/37 --data '{
"from_name": "Linghu",
"email": "xjmfc@126.com",
"domain_name": "test.com",
"api_user": "test_abc"
}'
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/37 --data '{
"from_name": "Linghu",
"email": "xjmfc@126.com",
"domain_name": "test.com",
"api_user": "test_abc"
}'
Afficher ce bloc de code dans la fenêtre flottante
Exemple de réponse
Réponse-succès
HttpStatus: 200
{
"count":1
}
{
"count":1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HttpStatus: 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
Détail de l'expéditeur
URL
https://email.api.engagelab.cc/v1/marketing/senders/{sender_id}
https://email.api.engagelab.cc/v1/marketing/senders/{sender_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
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(api_user:api_key) |
Exemple de requête
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/1
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders/1
Afficher ce bloc de code dans la fenêtre flottante
Exemple de réponse
Réponse-succès
HttpStatus: 200
{
"result": {
"sender_id": 449,
"name": "乔峰2",
"email": "zhou@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin_new",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
}
{
"result": {
"sender_id": 449,
"name": "乔峰2",
"email": "zhou@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin_new",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HttpStatus: 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
Liste des expéditeurs
URL
https://email.api.engagelab.cc/v1/marketing/senders
https://email.api.engagelab.cc/v1/marketing/senders
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
Content-Type
application/x-www-form-urlencoded;charset=utf-8
application/x-www-form-urlencoded;charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(api_user:api_key) |
Paramètres de requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| limit | integer | non | Nombre d'enregistrements à récupérer, plage : [1-100], défaut : 10 |
| offset | integer | non | Position de départ pour la requête, plage : [0-], défaut : 0 |
Exemple de requête
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders?offset=0&limit=10
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/senders?offset=0&limit=10
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de réponse
| Paramètre | Type | Description |
|---|---|---|
| result | array[object] | Liste des expéditeurs |
| sender_id | integer | ID de l'expéditeur |
| name | string | Nom de l'expéditeur |
| string | Adresse e-mail | |
| domain_id | integer | ID du domaine |
| domain_name | string | Nom de domaine |
| api_user | string | Nom de l'api_user |
| create_time | string | Date de création |
| update_time | string | Date de mise à jour |
| total | integer | Nombre total d'enregistrements |
Exemple de réponse
Réponse-succès
HttpStatus: 200
{
"result": [
{
"sender_id": 388,
"name": "xjmfc",
"email": "xjmfc@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
],
"total": 3,
"count": 1
}
{
"result": [
{
"sender_id": 388,
"name": "xjmfc",
"email": "xjmfc@aizl.net",
"domain_id": 147886,
"domain_name": "aizl.net",
"api_user": "xiaojinmin",
"create_time": "2022-05-24T14:04:19+0800",
"update_time": "2022-05-24T15:35:09+0800"
}
],
"total": 3,
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
{
"code": 30000,
"message": "Échec de l'authentification"
}
{
"code": 30000,
"message": "Échec de l'authentification"
}
Afficher ce bloc de code dans la fenêtre flottante
