WebHook

Callback de estado de correo electrónico

URL

Definida por el usuario en la página

              
              Definida por el usuario en la página

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

Content-Type:

application/json; charset=utf-8

              
              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

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
X-WebHook-Timestamp	String	true	marca de tiempo
X-WebHook-AppKey	String	true	valor fijo: "email"
X-WebHook-Signature	String	true	firma digital

Cuerpo de la solicitud

Parámetro	Tipo	Descripción
message_id	string	ID del mensaje
from	string	remitente (vacío en el mensaje de destino)
subject	string	asunto (vacío en el mensaje de destino)
to	string	destinatario (vacío en el mensaje de destino)
server	string	email
itime	long	marca de tiempo de generación del mensaje
custom_args	json	campos definidos por el cliente
status	json	callback de estado del mensaje

Sugerencias:

Algoritmo de firma: usar la clave de la aplicación del usuario como clave de cifrado para realizar la operación HmacSHA256 sobre la marca de tiempo y obtener caracteres hexadecimales.

Mensaje de estado de destino del correo electrónico

Condición de activación: solicitud de correo electrónico correcta.

status

Parámetro	Tipo	Descripción
message_status	string	target
status_data	json object	datos de estado
message	string	solicitud correcta
task_id	int	ID de tarea
api_user	string	usuario de API
from	string	remitente
subject	string	asunto
tos	array	array de destinatarios
email_ids	array	array de ID de correo electrónico de destinatarios
label_id	int	ID de etiqueta

{ "server": "email", "message_id": "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound", "itime": 1676615711325, "status": { "message_status": "target", "status_data": { "email_ids": [ "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound0$12345@hotmail.com" ], "task_id": "-1", "api_user": "scgp_email_system_trigger", "from": "newsletter@mail.engagelab.com", "subject": "Template interface sending-dynamic_vars-Unicast sending", "tos": [ "12345@hotmail.com" ], "message": "successfully request", "label_id": 0 } }, "custom_args": {} }

              
              {
    "server": "email", 
    "message_id": "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound", 
    "itime": 1676615711325, 
    "status": {
        "message_status": "target", 
        "status_data": {
            "email_ids": [
                "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound0$12345@hotmail.com"
            ], 
            "task_id": "-1", 
            "api_user": "scgp_email_system_trigger", 
            "from": "newsletter@mail.engagelab.com",
            "subject": "Template interface sending-dynamic_vars-Unicast sending", 
            "tos": [
                "12345@hotmail.com"
            ], 
            "message": "successfully request", 
            "label_id": 0
        }
    },
    "custom_args": {}
}

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

Mensaje de estado de correo electrónico enviado

Condición de activación: correo electrónico enviado correctamente desde EngageLab.

status

Parámetro	Tipo	Descripción
message_status	string	sent
status_data	json object	datos de estado
message	string	enviado correctamente
task_id	int	ID de tarea
api_user	string	usuario de API
email_id	string	ID de correo electrónico
label_id	int	ID de etiqueta

{ "server": "email", "message_id": "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound0$12345@hotmail.com", "from": "newsletter@mail.engagelab.com", "subject": "Template interface sending-dynamic_vars-Unicast sending", "to": "12345@hotmail.com", "itime": 1676615714397, "status": { "message_status": "sent", "status_data": { "email_id": "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound0$12345@hotmail.com", "task_id": "-1", "api_user": "scgp_email_system_trigger", "message": "successfully sent", "label_id": 0 } }, "custom_args": {} }

              
              {
    "server": "email", 
    "message_id": "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound0$12345@hotmail.com", 
    "from": "newsletter@mail.engagelab.com",
    "subject": "Template interface sending-dynamic_vars-Unicast sending", 
    "to": "12345@hotmail.com", 
    "itime": 1676615714397, 
    "status": {
        "message_status": "sent", 
        "status_data": {
            "email_id": "1676615711309_104117_18546_8821.sc-10_43_7_16-inbound0$12345@hotmail.com", 
            "task_id": "-1", 
            "api_user": "scgp_email_system_trigger", 
            "message": "successfully sent", 
            "label_id": 0
        }
    },
    "custom_args": {}
}

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

Mensaje de estado de correo electrónico entregado

Condición de activación: entrega de correo electrónico correcta.

status

Parámetro	Tipo	Descripción
message_status	string	delivered
status_data	json object	datos de estado
message	string	entregado correctamente
task_id	int	ID de tarea
api_user	string	usuario de API
email_id	string	ID de correo electrónico
label_id	int	ID de etiqueta

{ "server": "email", "message_id": "1675758375681_15_6393_8309.sc-10_2_226_96-test0$12345@gmail.com", "from": "newsletter@mail.engagelab.com", "subject": "Template interface sending-dynamic_vars-Unicast sending", "to": "12345@gmail.com", "itime": 1675758376586, "status": { "message_status": "delivered", "status_data": { "email_id": "1675758375681_15_6393_8309.sc-10_2_226_96-test0$12345@gmail.com", "task_id": "-1", "api_user": "1224_xjm", "message": "successfully delivered", "label_id": 0 } }, "custom_args": {} }

              
              {
    "server": "email", 
    "message_id": "1675758375681_15_6393_8309.sc-10_2_226_96-test0$12345@gmail.com", 
    "from": "newsletter@mail.engagelab.com",
    "subject": "Template interface sending-dynamic_vars-Unicast sending", 
    "to": "12345@gmail.com", 
    "itime": 1675758376586, 
    "status": {
        "message_status": "delivered", 
        "status_data": {
            "email_id": "1675758375681_15_6393_8309.sc-10_2_226_96-test0$12345@gmail.com", 
            "task_id": "-1", 
            "api_user": "1224_xjm", 
            "message": "successfully delivered", 
            "label_id": 0
        }
    },
    "custom_args": {}
}

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

Mensaje de estado invalid_email de correo electrónico

Condición de activación: error en la entrega del correo electrónico.

status

Parámetro	Tipo	Descripción
message_status	string	invalid_email
status_data	json object	datos de estado
task_id	int	ID de tarea
api_user	string	usuario de API
email_id	string	ID de correo electrónico
label_id	int	ID de etiqueta
error_code	int	código de error
error_detail	json	detalle del error
message	string	registro de respuesta del buzón
sub_stat	int	subcategoría de error. 4xx indica que la categoría es correo electrónico no válido
sub_stat_desc	string	descripción de la subcategoría de error

{ "server": "email", "message_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com", "from": "newsletter@mail.engagelab.com", "subject": "Template interface sending-dynamic_vars-Unicast sending", "to": "12345@gmail.com", "itime": 1676537132783, "status": { "message_status": "invalid_email", "error_code": 409, "error_detail": { "sub_stat": 409, "message": "Domain may not exist or DNS check failed [MF99jssew+U8hyLhCJdZwkffXOKzGzvvQq5UZaSZR1BIotz1+sUrL6gFET3lJu6KdQ== IP: 8.219.236.47].", "sub_stat_desc": "Other" }, "status_data": { "email_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com", "task_id": "-1", "api_user": "postmaster@sendcloud.io", "label_id": 0 } }, "custom_args": {} }

              
              {
    "server": "email", 
    "message_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com", 
    "from": "newsletter@mail.engagelab.com",
    "subject": "Template interface sending-dynamic_vars-Unicast sending", 
    "to": "12345@gmail.com", 
    "itime": 1676537132783, 
    "status": {
        "message_status": "invalid_email", 
        "error_code": 409, 
        "error_detail": {
            "sub_stat": 409, 
            "message": "Domain may not exist or DNS check failed [MF99jssew+U8hyLhCJdZwkffXOKzGzvvQq5UZaSZR1BIotz1+sUrL6gFET3lJu6KdQ== IP: 8.219.236.47].", 
            "sub_stat_desc": "Other"
        }, 
        "status_data": {
            "email_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com", 
            "task_id": "-1", 
            "api_user": "postmaster@sendcloud.io", 
            "label_id": 0
        }
    },
    "custom_args": {}
}

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

Mensaje de estado soft_bounce de correo electrónico

Condición de activación: el mensaje de correo electrónico llegó al servidor de correo del destinatario, pero posteriormente fue devuelto.

status

Parámetro	Tipo	Descripción
message_status	string	soft_bounce
status_data	json object	datos de estado
task_id	int	ID de tarea
api_user	string	usuario de API
email_id	string	ID de correo electrónico
label_id	int	ID de etiqueta
error_code	int	código de error
error_detail	json	detalle del error
message	string	registro de respuesta del buzón
sub_stat	int	subcategoría de error. 5XX indica que la categoría es soft bounce
sub_stat_desc	string	descripción de la subcategoría de error

{ "server": "email", "message_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com", "from": "newsletter@mail.engagelab.com", "subject": "Template interface sending-dynamic_vars-Unicast sending", "to": "12345@gmail.com", "itime": 1676537132783, "status": { "message_status": "soft_bounce", "error_code": 509, "error_detail": { "sub_stat": 509, "message": "Domain may not exist or DNS check failed [MF99jssew+U8hyLhCJdZwkffXOKzGzvvQq5UZaSZR1BIotz1+sUrL6gFET3lJu6KdQ== IP: 8.219.236.47].", "sub_stat_desc": "Other" }, "status_data": { "email_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com", "task_id": "-1", "api_user": "postmaster@sendcloud.io", "label_id": 0 } }, "custom_args": {} }

              
              {
    "server": "email", 
    "message_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com", 
    "from": "newsletter@mail.engagelab.com",
    "subject": "Template interface sending-dynamic_vars-Unicast sending", 
    "to": "12345@gmail.com", 
    "itime": 1676537132783, 
    "status": {
        "message_status": "soft_bounce", 
        "error_code": 509, 
        "error_detail": {
            "sub_stat": 509, 
            "message": "Domain may not exist or DNS check failed [MF99jssew+U8hyLhCJdZwkffXOKzGzvvQq5UZaSZR1BIotz1+sUrL6gFET3lJu6KdQ== IP: 8.219.236.47].", 
            "sub_stat_desc": "Other"
        }, 
        "status_data": {
            "email_id": "1676537131885_95_4921_8644.sc-10_2_226_96-test0$12345@gmail.com", 
            "task_id": "-1", 
            "api_user": "postmaster@sendcloud.io", 
            "label_id": 0
        }
    },
    "custom_args": {}
}

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

Callback de respuesta de correo electrónico

URL

Definida por el usuario en la página

              
              Definida por el usuario en la página

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

Content-Type:

application/json; charset=utf-8

              
              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

Encabezados de la solicitud

Encabezado	Tipo	Obligatorio	Descripción
X-WebHook-Timestamp	String	true	marca de tiempo
X-WebHook-AppKey	String	true	valor fijo: "email"
X-WebHook-Signature	String	true	firma digital

Cuerpo de la solicitud

Parámetro	Tipo	Descripción
message_id	string	ID del mensaje
from	string	remitente (vacío en el mensaje de enrutamiento)
subject	string	asunto (vacío en el mensaje de enrutamiento)
to	string	destinatario
server	string	email
itime	long	marca de tiempo de generación del mensaje
custom_args	json	campos definidos por el cliente
response	json	callback de respuesta del mensaje

Sugerencias:

Algoritmo de firma: usar la clave de la aplicación del usuario como clave de cifrado para realizar la operación HmacSHA256 sobre la marca de tiempo y obtener caracteres hexadecimales.

Mensaje de respuesta de apertura de correo electrónico

Condición de activación: el destinatario abre el correo electrónico.

response

Parámetro	Tipo	Descripción
event	string	open
response_data	json object	datos de respuesta
message	string	apertura de correo electrónico
task_id	int	ID de tarea
api_user	string	usuario de API
email_id	string	ID de correo electrónico
label_id	int	ID de etiqueta
ip	string	IP de la operación
explorer_name	string	nombre del navegador
explorer_ver	string	versión del navegador
os_name	string	nombre del SO
os_ver	string	versión del SO

Mensaje de respuesta de clic de correo electrónico

Condición de activación: el destinatario hace clic en el enlace del correo electrónico.

response

Parámetro	Tipo	Descripción
event	string	click
response_data	json object	datos de respuesta
message	string	clic en el correo electrónico
task_id	int	ID de tarea
api_user	string	usuario de API
email_id	string	ID de correo electrónico
label_id	int	ID de etiqueta
url	string	URL del clic
ip	string	IP de la operación
explorer_name	string	nombre del navegador
explorer_ver	string	versión del navegador
os_name	string	nombre del SO
os_ver	string	versión del SO

Mensaje de respuesta de cancelación de suscripción de correo electrónico

Condición de activación: el destinatario hace clic para darse de baja.

response

Parámetro	Tipo	Descripción
event	string	unsubscribe
response_data	json object	datos de respuesta
message	string	cancelación de suscripción
task_id	int	ID de tarea
api_user	string	usuario de API
email_id	string	ID de correo electrónico
label_id	int	ID de etiqueta
ip	string	IP de la operación
explorer_name	string	nombre del navegador
explorer_ver	string	versión del navegador
os_name	string	nombre del SO
os_ver	string	versión del SO

Mensaje de respuesta report_spam de correo electrónico

Condición de activación: el destinatario marca el correo electrónico como spam.

response

Parámetro	Tipo	Descripción
event	string	report_spam
response_data	json object	datos de respuesta
api_user	string	usuario de API
email_id	string	ID de correo electrónico
label_id	int	ID de etiqueta

Mensaje de respuesta de enrutamiento de correo electrónico

Condición de activación: el destinatario responde o envía al enrutamiento de recepción.

response

Parámetro	Tipo	Descripción
event	string	route
response_data	json object	datos de respuesta
message	string	enrutamiento mx
html	string	HTML del correo electrónico
text	string	texto sin formato del correo electrónico
headers	string	encabezado del correo de enrutamiento
from_name	string	nombre del remitente
subject	string	asunto del correo electrónico
from	string	dirección del remitente
reference	string	referencia
email_id	string	ID de correo electrónico
raw_message	string	mensaje sin procesar
raw_message_url	string	URL de descarga del mensaje sin procesar
x_mx_mailfrom	string	x_mx_mailfrom
x_mx_rcptto	string	x_mx_rcptto
label_id	int	ID de etiqueta