Entregas
Dirección de llamada
| 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/mail/send
Entrega normal
URL
https://email.api.engagelab.cc/v1/mail/send
https://email.api.engagelab.cc/v1/mail/send
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) |
Parámetros de la solicitud
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| from | string | sí | From. Ejemplo:support@mail.engagelab.com,EngageLab Team<support@mail.engagelab.com>. Si se debe mostrar el nombre de marca del producto o de la empresa, se debe utilizar EngageLab Team< support@mail.engagelab.com >; EngageLab Team es el nombre del remitente (from name) y puede transmitir el nombre de marca del producto o de la empresa; < support@mail.engagelab.com > es la dirección del remitente |
| to | array[string] | sí | Destinatario. Se admite un máximo de 100 direcciones. Ejemplo: ["xjm@hotmail.com","xjm2@gmail.com"] |
| body | object | sí | Configuración del correo |
| custom_args | object | no | Campos opcionales personalizados por el cliente. El tamaño máximo es 1KB. El valor de clave de custom_args no puede contener el símbolo ".". |
| request_id | string | no | ID de esta solicitud de envío; máximo de 128 caracteres. |
Body
| Parámetro | Tipo | Obligatorio o no | Descripción |
|---|---|---|---|
| cc | array[string] | no | Cc. Se admite un máximo de 100 direcciones. Solo cuando send_mode=1 este parámetro es válido. |
| bcc | array[string] | no | Bcc. Se admite un máximo de 100 direcciones. Solo cuando send_mode=1 este parámetro es válido. |
| reply_to | array[string] | no | Reply to. Se admite un máximo de 3 direcciones; si no se envía ningún valor, la dirección de reply_to es from. |
| subject | string | sí | Asunto. Máximo 256 caracteres; admite variables y emoji. |
| content | object | sí | Contenido |
| html | string | * | Contenido en html. El formato es text/html. |
| text | string | * | Contenido en texto. El formato es text/plain. |
| preview_text | string | no | Vista previa del contenido |
| vars | object | no | Variable. Hasta 1MB; cuando send_mode=0 o send_mode=1, este parámetro es válido. |
| dynamic_vars | array[object] | no | Variables de plantilla dinámica. El tamaño máximo admitido es 1MB; este parámetro es válido cuando send_mode = 0 o send_mode = 1. |
| label_id | string | no | ID de etiqueta utilizada para este envío |
| label_name | string | no | Nombre de etiqueta utilizado para este envío |
| headers | object | no | Encabezados. Hasta 1KB. |
| attachments | array[object] | no | Adjuntos. El tamaño total no debe superar los 10MB. |
| content | string | sí | Contenido de los adjuntos. Codificación Base64. |
| filename | string | sí | Nombre de archivo del adjunto. Ejemplo:news.pdf |
| disposition | string | sí | El valor puede ser attachment o inline. |
| content_id | string | no | Si el valor de disposition es inline y el tipo de archivo es imagen, se debe configurar este valor |
| settings | object | no | Configuración de envío |
| send_mode | int | no | Método de envío. 0 significa envío por separado; 1 significa envío de difusión (broadcast) y todos los destinatarios se mostrarán al mismo tiempo; 2 indica que se envía la lista de direcciones. El valor de to es la dirección de la lista de direcciones. El valor predeterminado es 0 |
| return_email_id | boolean | no | Indica si se debe devolver el ID de correo electrónico; el valor predeterminado es true. |
| sandbox | boolean | no | Indica si se debe utilizar el modo sandbox; el valor predeterminado es false. Si es true, el correo no se entregará y solo se validarán los parámetros de la solicitud. |
| notification | boolean | no | Indica si se debe utilizar el acuse de lectura; el valor predeterminado es false. El destinatario predeterminado del acuse es from y se debe utilizar junto con la ruta de recepción. |
| open_tracking | boolean | no | Indica si se debe habilitar el seguimiento de aperturas; valor predeterminado de la configuración del sistema. Cuando send_mode=0 o send_mode=1, este parámetro es válido. |
| click_tracking | boolean | no | Indica si se debe habilitar el seguimiento de clics; configuración predeterminada del sistema. Cuando send_mode=0 o send_mode=1, este parámetro es válido. |
| unsubscribe_tracking | boolean | no | Indica si se debe habilitar la cancelación de suscripción. Configuración predeterminada del sistema. Cuando send_mode=0 o send_mode=1, este parámetro es válido. |
| unsubscribe_page_id | array[int] | no | Página de cancelación de suscripción personalizada; valor predeterminado de la configuración del sistema. Cuando send_mode=0 o send_mode=1, este parámetro es válido. |
Consejos:
- Cuando send_mode=2, el valor de to es un alias de lista de direcciones y el número no puede superar los 5. En este caso, los parámetros cc y bcc no son válidos.
- Html y plain no pueden estar vacíos al mismo tiempo.
- Preview_text solo se puede utilizar con html. Si no se envía ningún valor de html, preview_text no surtirá efecto.
- Vars se utiliza para la sustitución de variables del contenido del correo. El formato es un objeto JSON:
{"varname": ["value1","value2"]}, donde varname es la variable del contenido del correo. dynamic_varsse utiliza para reemplazar variables en plantillas dinámicas.- Los usuarios pueden enviar
label_idolabel_namepara esta transmisión. - Headers se utiliza para personalizar el campo de encabezado del mensaje.
- Cuando disposition se establece en inline, el contenido del adjunto es una imagen y se mostrará directamente en el cuerpo del mensaje.
- Como custom_args los define el usuario, se insertarán en el encabezado y se devolverán en los datos posteriores del WebHook.
- request_id se utiliza para evitar envíos repetidos.
- El tamaño total del correo electrónico no puede superar los 70MB.
Entrega con plantilla
(Se aplican los mismos cambios: “sí/no” en columnas, encabezado Obligatorio o no, uso de custom_args y redacción impersonal “los define el usuario” en Consejos – ítem 7.)
Enviar calendario de reunión
(Se corrige “Contenido de los adjuntos”, uso de custom_args, “sí/no” en columnas y redacción impersonal en Consejos – ítem 8.)
Entrega MIME
(Se corrige custom_args, cambio de “No” a no en la fila subject de Obligatorio o no, y se mantiene coherencia de “sí/no” en todas las tablas. En Nota – ítem 4 se usa redacción impersonal.)
