Email Template

Le modèle d'e-mail permet aux développeurs d'envoyer des e-mails avec un contenu similaire à différents clients.

Vous pouvez interroger, ajouter, supprimer et modifier des modèles via l'API.

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/templates

Interroger (Lot)

Informations de base du modèle d'e-mail retournées

URL

https://email.api.engagelab.cc/v1/templates

              
              https://email.api.engagelab.cc/v1/templates

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
offset	int	non	position de l'offset, [0-], par défaut 0
limit	int	non	quantité, [0-100], par défaut 100
name	string	non	nom du modèle d'e-mail
template_invoke_name	string	non	nom d'appel du modèle d'e-mail

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/templates?offset=0&limit=3'

              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates?offset=0&limit=3'

Afficher ce bloc de code dans la fenêtre flottante

Description des valeurs retournées

Paramètre	Description
template_id	ID du modèle
name	nom du modèle
template_invoke_name	nom du modèle d'appel
html	contenu au format html
preview_text	texte d'aperçu du modèle
subject	sujet du modèle
create_time	date de création du modèle
update_time	date de modification du modèle

Exemple de valeur retournée

Réponse-succès

HTTP Status: 200

{ "result": [{ "template_id": 82522, "name": "dffddf", "template_invoke_name": "dffdfd", "html": null, "text": null, "subject": "fdfdfd😅🙂🙂🙂🙂", "preview_text": "", "create_time": "2022-11-10 15:47:05", "update_time": "2022-11-10 15:47:05" }] , "count":10, "total":20 }

              
              {
    "result":  [{
                "template_id": 82522,
                "name": "dffddf",
                "template_invoke_name": "dffdfd",
                "html": null,
                "text": null,
                "subject": "fdfdfd😅🙂🙂🙂🙂",
                "preview_text": "",
                "create_time": "2022-11-10 15:47:05",
                "update_time": "2022-11-10 15:47:05"
            }]
     ,
     "count":10,
     "total":20
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

              
              {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

Afficher ce bloc de code dans la fenêtre flottante

Interroger

Informations détaillées du modèle d'e-mail retournées

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

              
              https://email.api.engagelab.cc/v1/templates/{template_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

En-tête

En-tête	Type	Obligatoire	Description
Authorization	String	oui	Basic base64(api_user:api_key)

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/templates/11111111'

              
              curl -X GET -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates/11111111'

Afficher ce bloc de code dans la fenêtre flottante

Description des valeurs retournées

Paramètre	Description
template_id	ID du modèle
name	nom du modèle
template_invoke_name	nom du modèle d'appel
html	contenu du modèle
preview_text	texte d'aperçu du contenu de l'e-mail
subject	sujet du contenu de l'e-mail
create_time	date de création du modèle
update_time	date de modification du modèle

Exemple de valeur retournée

Réponse-succès

HTTP Status: 200

{ "result":{ "template_id": 76707, "name": "libo01s", "template_invoke_name": "libo01d", "html": "The is first email", "text": null, "subject": "happyaaa", "preview_text": "", "create_time": "2019-07-22T11:52:45+0800", "update_time": "2019-08-01T11:29:19+0800" } }

              
              {
     "result":{
            "template_id": 76707,
            "name": "libo01s",
            "template_invoke_name": "libo01d",
            "html": "The is first email",
            "text": null,
            "subject": "happyaaa",
            "preview_text": "",
            "create_time": "2019-07-22T11:52:45+0800",
            "update_time": "2019-08-01T11:29:19+0800"
        }
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

              
              {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

Afficher ce bloc de code dans la fenêtre flottante

Ajouter

URL

https://email.api.engagelab.cc/v1/templates

              
              https://email.api.engagelab.cc/v1/templates

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

Méthode de requête HTTP

POST

              
              POST

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
name	string	oui	nom du modèle. Longueur maximale de 32 caractères.
template_invoke_name	string	oui	nom du modèle d'appel. 4~64 caractères.
html	string	oui	contenu au format html
text	string	non	contenu au format texte
subject	string	oui	sujet du modèle. Longueur maximale de 255 caractères, emoji pris en charge.
preview_text	string	non	aperçu du modèle. Longueur maximale de 255 caractères.

Astuces :

Les variables sont autorisées dans le contenu html.

La taille totale d'un message e-mail ne doit pas dépasser 70 Mo lors de l'envoi.

Exemple de requête

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "html": "xxx", "subject": "sususubej"}' 'https://email.api.engagelab.cc/v1/templates'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"name": "template-name", "template_invoke_name": "myCustomTemplate", "html": "xxx", "subject": "sususubej"}'
     'https://email.api.engagelab.cc/v1/templates'

Afficher ce bloc de code dans la fenêtre flottante

Description des valeurs retournées

Paramètre	Description
template_id	ID du modèle
name	nom du modèle
template_invoke_name	nom du modèle d'appel
html	contenu du modèle
text	texte du modèle
subject	sujet du modèle
create_time	date de création du modèle
update_time	date de modification du modèle

Exemple de valeur retournée

Réponse-succès

HTTP Status: 200

{ "result": { "template_id": 82525, "name": "zhongg", "template_invoke_name": "gjtest122", "html": "This first template for apiv3", "subject": "xxxxxxx", "preview_text": "", "create_time": "2022-11-14T15:31:17+0800", "update_time": "" } }

              
              {
    "result": {
            "template_id": 82525,
            "name": "zhongg",
            "template_invoke_name": "gjtest122",
            "html": "This first template for apiv3",
            "subject": "xxxxxxx",
            "preview_text": "",
            "create_time": "2022-11-14T15:31:17+0800",
            "update_time": ""
    }
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse-erreur

HTTP Status :400

{ "code": 30202, "message": "Invalid template_invoke_name" }

              
              {
    "code": 30202,
    "message": "Invalid template_invoke_name"
}

Afficher ce bloc de code dans la fenêtre flottante

Supprimer

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

              
              https://email.api.engagelab.cc/v1/templates/{template_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

En-tête 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 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 'https://email.api.engagelab.cc/v1/templates/11111111'

              
              curl -X DELETE -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     'https://email.api.engagelab.cc/v1/templates/11111111'

Afficher ce bloc de code dans la fenêtre flottante

Description des valeurs retournées

Paramètre	Description
count	nombre de modèles supprimés

Exemple de valeur retournée

Réponse-succès

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": "Authentication failed." }

              
              { 
    "code": 30000,
    "message": "Authentication failed."
}

Afficher ce bloc de code dans la fenêtre flottante

Modification

Le nom, le contenu, le sujet et le type du modèle peuvent être modifiés.

URL

https://email.api.engagelab.cc/v1/templates/{template_id}

              
              https://email.api.engagelab.cc/v1/templates/{template_id}

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

Méthode de requête HTTP

PUT

PUT

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
name	string	non	nom du modèle. Longueur maximale de 32 caractères.
template_invoke_name	string	non	nom du modèle d'appel. 4~64 caractères.
html	string	non	contenu au format html
text	string	non	contenu au format texte
subject	string	non	sujet du modèle. Longueur maximale de 255 caractères, emoji pris en charge.
preview_text	string	non	aperçu du modèle. Longueur maximale de 255 caractères.

Astuces :

Les variables sont autorisées dans le contenu html.

Lors de l'envoi, la taille totale du message ne doit pas dépasser 70 Mo.

Exemple de requête

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' --data '{"template_invoke_name": "myCustomTemplate"}' 'https://email.api.engagelab.cc/v1/templates/11111111'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' 
     -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' 
     --data '{"template_invoke_name": "myCustomTemplate"}'
     'https://email.api.engagelab.cc/v1/templates/11111111'

Afficher ce bloc de code dans la fenêtre flottante

Exemple de valeur retournée

Paramètre	Description
count	nombre de modèles modifiés

Exemple de valeur retournée

Réponse-succès

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": "Authentication failed." }

              
              { 
    "code": 30000,
    "message": "Authentication failed."
}

Afficher ce bloc de code dans la fenêtre flottante

Modèle d'E-mail

Adresse d'appel

Interroger (Lot)

Interroger

Ajouter

Supprimer

Modification