Email Template

La plantilla de correo electrónico permite a los desarrolladores enviar correos electrónicos con contenido similar a distintos clientes.

Se pueden consultar, añadir, eliminar y modificar plantillas mediante la API.

Dirección de la solicitud

Centro de datos	URL
Singapur	https://email.api.engagelab.cc
Turquía	https://emailapi-tr.engagelab.com

Al utilizar la API REST, se debe verificar que el centro de datos seleccionado corresponda a la URL base adecuada.

POST/v1/templates

Consulta (por lotes)

Información básica de la plantilla de correo electrónico devuelta.

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

GET

GET

Este bloque de código se muestra en una ventana flotante

Encabezado

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	sí	Basic base64(api_user:api_key)

Descripción de parámetros de consulta

Parámetro	Tipo	Obligatorio o no	Descripción
offset	int	no	Posición de offset, [0-], valor predeterminado: 0
limit	int	no	Cantidad, [0-100], valor predeterminado: 100
name	string	no	Nombre de la plantilla de correo electrónico
template_invoke_name	string	no	Nombre para invocar la plantilla de correo electrónico

Ejemplo de solicitud

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'

Este bloque de código se muestra en una ventana flotante

Descripción del valor devuelto

Parámetro	Descripción
template_id	ID de la plantilla
name	Nombre de la plantilla
template_invoke_name	Nombre de invocación de la plantilla
html	Contenido en formato HTML
preview_text	preview_text de la plantilla
subject	Asunto de la plantilla
create_time	Hora de creación de la plantilla
update_time	Hora de modificación de la plantilla

Ejemplo de valor devuelto

Response-success

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
}

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status :400

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

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

Este bloque de código se muestra en una ventana flotante

Consulta

Información detallada de la plantilla de correo electrónico devuelta.

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

GET

GET

Este bloque de código se muestra en una ventana flotante

Encabezado

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	sí	Basic base64(api_user:api_key)

Ejemplo de solicitud

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'

Este bloque de código se muestra en una ventana flotante

Descripción del valor devuelto

Parámetro	Descripción
template_id	ID de la plantilla
name	Nombre de la plantilla
template_invoke_name	Nombre de invocación de la plantilla
html	Contenido de la plantilla
preview_text	preview_text del contenido del correo electrónico
subject	Asunto del contenido del correo electrónico
create_time	Hora de creación de la plantilla
update_time	Hora de modificación de la plantilla

Ejemplo de valor devuelto

Response-success

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"
        }
}

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status :400

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

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

Este bloque de código se muestra en una ventana flotante

Añadir

URL

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

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

Este bloque de código se muestra en una ventana flotante

Content-Type:

Content-Type: application/json;charset=utf-8

              
              Content-Type: application/json;charset=utf-8

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

POST

              
              POST

Este bloque de código se muestra en una ventana flotante

Encabezado de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	sí	Basic base64(api_user:api_key)

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio o no	Descripción
name	string	sí	Nombre de la plantilla. Longitud máxima: 32 caracteres.
template_invoke_name	string	sí	Nombre de invocación de la plantilla. 4~64 caracteres.
html	string	sí	Contenido en formato HTML
text	string	no	Contenido en formato texto
subject	string	sí	Asunto de la plantilla. La longitud máxima es de 255 caracteres y se admiten emojis.
preview_text	string	no	Vista previa de la plantilla. La longitud máxima es de 255 caracteres.

Consejos:

Se permiten variables en el contenido HTML.

Al enviar, el tamaño total del mensaje de correo electrónico no debe superar los 70 MB.

Ejemplo de solicitud

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'

Este bloque de código se muestra en una ventana flotante

Descripción del valor devuelto

Parámetro	Descripción
template_id	ID de la plantilla
name	Nombre de la plantilla
template_invoke_name	Nombre de invocación de la plantilla
html	Contenido de la plantilla
text	Texto de la plantilla
subject	Asunto de la plantilla
create_time	Hora de creación de la plantilla
update_time	Hora de modificación de la plantilla

Ejemplo de valor devuelto

Response-success

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": ""
    }
}

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status :400

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

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

Este bloque de código se muestra en una ventana flotante

Eliminar

URL

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

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

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

DELETE

              
              DELETE

Este bloque de código se muestra en una ventana flotante

Encabezado de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	sí	Basic base64(api_user:api_key)

Ejemplo de solicitud

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'

Este bloque de código se muestra en una ventana flotante

Descripción del valor devuelto

Parámetro	Descripción
count	Número de plantillas eliminadas

Ejemplo de valor devuelto

Response-success

HTTP Status: 200

{ "count": 1 }

              
              { "count": 1 }

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status :401

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

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

Este bloque de código se muestra en una ventana flotante

Modificación

Se pueden modificar el nombre, el contenido, el asunto y el tipo de la plantilla.

URL

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

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

Este bloque de código se muestra en una ventana flotante

Content-Type:

Content-Type: application/json;charset=utf-8

              
              Content-Type: application/json;charset=utf-8

Este bloque de código se muestra en una ventana flotante

Método de solicitud HTTP

PUT

PUT

Este bloque de código se muestra en una ventana flotante

Encabezado de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
Authorization	String	sí	Basic base64(api_user:api_key)

Descripción de parámetros del cuerpo

Parámetro	Tipo	Obligatorio o no	Descripción
name	string	no	Nombre de la plantilla. Longitud máxima: 32 caracteres.
template_invoke_name	string	no	Nombre de invocación de la plantilla. 4~64 caracteres.
html	string	no	Contenido en formato HTML
text	string	no	Contenido en formato texto
subject	string	no	Asunto de la plantilla. La longitud máxima es de 255 caracteres y se admiten emojis.
preview_text	string	no	Vista previa de la plantilla. La longitud máxima es de 255 caracteres.

Consejos:

Se permiten variables en el contenido HTML.

Al enviar, el tamaño total del mensaje no debe superar los 70 MB.

Ejemplo de solicitud

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'

Este bloque de código se muestra en una ventana flotante

Descripción del valor devuelto

Parámetro	Descripción
count	Número de plantillas modificadas

Ejemplo de valor devuelto

Response-success

HTTP Status: 200

{ "count": 1 }

              
              { 
 "count": 1 
}

Este bloque de código se muestra en una ventana flotante

Response-error

HTTP Status :401

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

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

Este bloque de código se muestra en una ventana flotante

Plantilla de correo electrónico

Dirección de la solicitud

Consulta (por lotes)

Consulta

Añadir

Eliminar

Modificación