Consultel - Documentación

Callbacks de Email

Introducción

Si utilizas la API para enviar emails, puedes definir una URL de retorno para cada tipo de callback en tus envíos simples o campañas, para que te enviemos a través de una petición POST a la dirección que elijas, la interacción que tienen tus contactos con los emails que les has enviado:

  • Aperturas: Recibirás un callback cada vez que un contacto realice una apertura del email que le hayas enviado.
  • Clics: Recibirás un callback cada vez que un contacto realice un clic en alguno de los enlaces del email que le hayas enviado.
  • Reportes SPAM: Recibirás un callback cada vez que recibamos una queja de SPAM del dominio del remitente del envío realizado.

Callback URL para notificar las aperturas de envíos de Email

Utiliza el parámetro callback_openings_url en tus envíos de email en la API para adjuntar una URL válida para recibir las peticiones POST.


{
     "header":{
        "channel":"email",
        "event":"open"
     },
     "data":{
        "email":"test@example.com",
        "application_id":10,
        "app_configuration_id":49,
        "open_date":"2022-01-05 09:26:04"
     }
}
                    

Callback URL para notificar los clicks en los enlaces de envíos de Email

Utiliza el parámetro callback_clicks_url en tus envíos de email en la API para adjuntar una URL válida para recibir las peticiones POST.


{
     "header":{
        "channel":"email",
        "event":"click"
     },
     "data":{
        "email":"test@example.com",
        "application_id":10,
        "app_configuration_id":49,
        "click_date":"2022-01-05 09:26:04",
        "url":"https://testdomain.com/test"
     }
}
                    

Callback URL para notificar los reportes de SPAM de los usuarios

Utiliza el parámetro callback_complains_url en tus envíos de email en la API para adjuntar una URL válida para recibir las peticiones POST.


{
     "header":{
        "channel":"email",
        "event":"complain"
     },
     "data":{
        "email":"test@example.com",
        "application_id":10,
        "app_configuration_id":49,
        "complain_date":"2022-01-05 09:26:04",
        "domain":"testdomain.com"
     }
}