Eventos do Direct Mail - : Central de Documentação do Alibaba Cloud

Regiões suportadas

O Direct Mail publica eventos no EventBridge nas seguintes regiões: China (Hangzhou), Alemanha (Frankfurt), Singapura e EUA (Virgínia).

Tipos de eventos

O Direct Mail publica os seguintes tipos de eventos no EventBridge.

Tipo de evento	Valor do parâmetro type
Falha na entrega de e-mail	dm:Deliver:Fail
Entrega de e-mail bem-sucedida	dm:Deliver:Succeed
Dados de relatório FBL de e-mail	dm:Feedback:FblReport
Dados de nova inscrição de e-mail	dm:Feedback:Subscribe
Dados de cancelamento de inscrição de e-mail	dm:Feedback:UnSubscribe
Evento de clique	dm:Trace:Click
Evento de abertura	dm:Trace:Open
Resultado assíncrono da validação de endereço em lista cinza	dm:Validator:GrayListResult

Para mais informações sobre os parâmetros definidos na especificação CloudEvents, consulte Visão geral de eventos.

Falha na entrega de e-mail

Se a entrega de um e-mail falhar, o EventBridge receberá um evento semelhante ao exemplo a seguir.

{
  "data": {
    "header": {
      "X-Notify-Message-ID": "test******@******"
    },
    "env_id": "60000******",
    "account": "batch******@top",
    "from": "batch******@top",
    "rcpt": "xxx******@aliyun.com",
    "msg_id": "1df******@******",
    "channel_name": "bg:vip_*",
    "outbound_ip": "8.*.*.7",
    "send_time": "2024-04-29T11:07:04",
    "deliver_time": "2024-04-29T11:07:12",
    "status": "2",
    "event": "dm:Deliver:Fail",
    "region": "cn-hangzhou",
    "err_code": "554",
    "err_msg": "554  RCPT xxx******@aliyun.com dosn't exist",
    "failed_type": "SmtpNxBox",
    "esp": "*mail.com",
    "ip_pool_id": "10306c37-****-****-a82f-1dafb56a9dd2",
    "is_dedicated_ip": true,
    "tag": "xxxxx"
  },
  "id": "8734hhidu983hi457",
  "source": "acs:dm",
  "specversion": "1.0",
  "subject": "acs:dm:cn-hangzhou:{AccountId}:*",
  "time": "2024-04-29T11:07:12+08:00",
  "type": "dm:Deliver:Fail",
  "aliyunaccountid": "123456789098****",
  "aliyunpublishtime": "2024-04-29T11:07:13.179PRC",
  "aliyuneventbusname": "default",
  "aliyunregionid": "cn-hangzhou",
  "aliyunpublishaddr": "172.25.XX.XX"
}

A tabela a seguir descreve os parâmetros do campo data.

Parâmetro	Tipo	Exemplo	Descrição
header	Object		Cabeçalhos relacionados ao e-mail.
X-Notify-Message-ID	String	test****@example.com	Cabeçalho personalizado X-Notify-Message-ID.
env_id	String	60000****	ID do e-mail retornado pelo sistema durante o envio.
account	String	batch****@top	Endereço de e-mail do remetente.
from	String	batch****@top	Endereço de e-mail do remetente.
rcpt	String	a****@aliyun.com	Endereço de e-mail do destinatário.
msg_id	String	1df****@example.com	Campo Message-ID do e-mail.
channel_name	String	bg:vip_*	Nome do canal ao qual pertence o IP de saída desta entrega.
outbound_ip	String	8...7	IP de saída usado nesta entrega.
send_time	String	2024-04-29T11:07:04	Momento em que o e-mail foi aceito.
deliver_time	String	2024-04-29T11:07:12	Horário de conclusão da entrega do e-mail.
status	String	2	Status da entrega. 0: Bem-sucedida. 2: Endereço inválido. 3: O destinatário marcou o e-mail como spam. 4: Outras falhas.
event	String	dm:Deliver:Fail	Tipo da mensagem de evento. Corresponde ao parâmetro type.
region	String	cn-hangzhou	Região onde o evento ocorreu.
err_code	String	554	Código retornado pelo provedor de serviços de e-mail (ESP) do destinatário após a conclusão da entrega.
err_msg	String	554 RCPT a****@aliyun.com dosn't exist	Mensagem retornada pelo ESP do destinatário após a conclusão da entrega.
failed_type	String	SmtpNxBox	Categorização do resultado da entrega.
esp	String	*mail.com	Categorização do provedor de e-mail do destinatário.
ip_pool_id	String	10306c37---a82f-1dafb56a9dd2	ID do pool de IPs usado para enviar o e-mail.
is_dedicated_ip	Boolean	true	Indica se foi usado um IP dedicado.
tag	String	xxxxx	Tag usada para enviar o e-mail.

Entrega de e-mail bem-sucedida

Se a entrega de um e-mail for bem-sucedida, o EventBridge receberá um evento semelhante ao exemplo a seguir.

{
  "data": {
    "header": {
      "X-Notify-Message-ID": "test******@******"
    },
    "env_id": "60000******",
    "account": "batch******@top",
    "from": "batch******@top",
    "rcpt": "xxx******@aliyun.com",
    "msg_id": "1df******@******",
    "channel_name": "bg:vip_*",
    "outbound_ip": "8.*.*.7",
    "send_time": "2024-04-29T11:07:04",
    "deliver_time": "2024-04-29T11:07:12",
    "status": "0",
    "event": "dm:Deliver:Succeed",
    "region": "cn-hangzhou",
    "err_code": "250",
    "err_msg": "250 Send Mail OK",
    "failed_type": "SendOk",
    "esp": "*mail.com",
    "ip_pool_id": "10306c37-****-****-a82f-1dafb56a9dd2",
    "is_dedicated_ip": true,
    "tag": "xxxxx"
  },
  "id": "8734hhidu983hi457",
  "source": "acs:dm",
  "specversion": "1.0",
  "subject": "acs:dm:cn-hangzhou:{AccountId}:*",
  "time": "2024-04-29T11:07:12+08:00",
  "type": "dm:Deliver:Succeed",
  "aliyunaccountid": "123456789098****",
  "aliyunpublishtime": "2024-04-29T11:07:13.179PRC",
  "aliyuneventbusname": "default",
  "aliyunregionid": "cn-hangzhou",
  "aliyunpublishaddr": "172.25.XX.XX"
}

Para obter uma descrição dos parâmetros no campo data, consulte Descrições dos parâmetros.

Dados de relatório FBL de e-mail

Quando um e-mail é reportado por meio de um loop de feedback (FBL), o EventBridge recebe um evento semelhante ao exemplo a seguir.

{
    "id": "45ef4dewdwe1-7c35-447a-bd93-fab****",
    "source": "acs.dm",
    "specversion": "1.0",
    "subject": "acs.dm:cn-hangzhou:123456789098****:215672",
    "time": "2020-11-19T21:04:41+08:00",
    "type": "dm:Feedback:FblReport",
    "aliyunaccountid": "123456789098****",
    "aliyunpublishtime": "2020-11-19T21:04:42Z",
    "aliyuneventbusname": "default",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "172.25.XX.XX",
    "data": {
        "send_time": "1726821644",
        "send_email": "from@xxx.com",
        "block_email": "to@yyy.com",
        "subject": "Hello Mr.xxx",
        "message_id": "<msgid***@xxx.com>",
        "block_time": "1726821667",
        "fbl_isp": "outlook**",
        "fingerprint": "SMTPD_abc****"
    }
}

A tabela a seguir descreve os parâmetros do campo data.

Parâmetro	Tipo	Exemplo	Descrição
send_time	String	1726821644	Horário de envio do e-mail.
send_email	String	from@xxx.com	Endereço de e-mail do remetente.
block_email	String	to@yyy.com	Endereço de e-mail do destinatário bloqueado.
subject	String	Hello Mr.xxx	Assunto do e-mail.
message_id	String	<msgid***@xxx.com>	Identificador exclusivo do e-mail.
block_time	String	1726821667	Momento em que o e-mail foi bloqueado.
fbl_isp	String	outlook**	Provedor de Serviços de Internet (ISP) do remetente.
fingerprint	String	SMTPD_abc****	Impressão digital do e-mail.

Dados de nova inscrição de e-mail

Quando um destinatário se inscreve novamente, o EventBridge recebe um evento semelhante ao exemplo a seguir.

{
    "id": "45ef4dewdwe1-7c35-447a-bd93-fab****",
    "source": "acs.dm",
    "specversion": "1.0",
    "subject": "acs.dm:cn-hangzhou:123456789098****:215672",
    "time": "2020-11-19T21:04:41+08:00",
    "type": "dm:Feedback:Subscribe",
    "aliyunaccountid": "123456789098****",
    "aliyunpublishtime": "2020-11-19T21:04:42Z",
    "aliyuneventbusname": "default",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "172.25.XX.XX",
    "data": {
        "operate_time": "2024-04-29T11:25:48",
        "envid": "6000*********",
        "from": "from@xxx.com",
        "rcpt": "to@yyy.com",
        "client_ip": "102.**.**.1"
    }
}

A tabela a seguir descreve os parâmetros do campo data.

Parâmetro	Tipo	Exemplo	Descrição
operate_time	String	2024-04-29T11:25:48	Horário em que a operação ocorreu. O horário está em UTC.
env_id	String	6000*****	ID do e-mail retornado pelo sistema durante o envio.
from	String	from@xxx.com	Endereço do remetente.
rcpt	String	to@yyy.com	Endereço do destinatário.
client_ip	String	102...1	IP do cliente para o evento de abertura.

Dados de cancelamento de inscrição de e-mail

Quando um destinatário cancela a inscrição, o EventBridge recebe um evento semelhante ao exemplo a seguir.

{
    "id": "45ef4dewdwe1-7c35-447a-bd93-fab****",
    "source": "acs.dm",
    "specversion": "1.0",
    "subject": "acs.dm:cn-hangzhou:123456789098****:215672",
    "time": "2020-11-19T21:04:41+08:00",
    "type": "dm:Feedback:UnSubscribe",
    "aliyunaccountid": "123456789098****",
    "aliyunpublishtime": "2020-11-19T21:04:42Z",
    "aliyuneventbusname": "default",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "172.25.XX.XX",
    "data": {
        "operate_time": "2024-04-29T11:25:48",
        "envid": "6000*********",
        "from": "from@xxx.com",
        "rcpt": "to@yyy.com",
        "client_ip": "102.**.**.1"
    }
}

A tabela a seguir descreve os parâmetros do campo data.

Parâmetro	Tipo	Exemplo	Descrição
operate_time	String	2024-04-29T11:25:48	Horário em que a operação ocorreu. O horário está em UTC.
env_id	String	6000*****	ID do e-mail retornado pelo sistema durante o envio.
from	String	from@xxx.com	Endereço do remetente.
rcpt	String	to@yyy.com	Endereço do destinatário.
client_ip	String	102...1	IP do cliente de origem do evento.

Evento de clique

Quando um destinatário clica em um link dentro de um e-mail, o EventBridge recebe um evento semelhante ao exemplo a seguir.

{
    "id": "45ef4dewdwe1-7c35-447a-bd93-fab****",
    "source": "acs.dm",
    "specversion": "1.0",
    "subject": "acs.dm:cn-hangzhou:123456789098****:215672",
    "time": "2020-11-19T21:04:41+08:00",
    "type": "dm:Trace:Click",
    "aliyunaccountid": "123456789098****",
    "aliyunpublishtime": "2020-11-19T21:04:42Z",
    "aliyuneventbusname": "default",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "172.25.XX.XX",
    "data": {
        "operate_time": "2024-04-29T11:25:48",
        "client_ip": "202.**.**.1",
        "env_id": "60000******",
        "from": "batch******@top",
        "rcpt": "xxx******@aliyun.com",
        "msg_id": "1df******@******",
        "event": "dm:Trace:Click",
        "region": "cn-hangzhou",
        "url": "https://www.aliyun.com",
        "outbound_ip": "102.**.**.1",
        "esp": "*mail.com",
        "ip_pool_id": "10306c37-****-****-a82f-1dafb56a9dd2",
        "is_dedicated_ip": true,
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X ****) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4.1",
        "tag": "xxxxx"
    }
}

A tabela a seguir descreve os parâmetros do campo data.

Parâmetro	Tipo	Exemplo	Descrição
operate_time	String	2024-04-29T11:25:48	Horário em que a operação ocorreu.
client_ip	String	202...1	IP do cliente que clicou no link.
env_id	String	60000	ID do e-mail retornado pelo sistema durante o envio.
from	String	batch****@top	Endereço do remetente.
rcpt	String	xxx@aliyun.com	Endereço do destinatário.
msg_id	String	1df@	Campo Message-ID presente no e-mail.
event	String	dm:Trace:Click	Tipo do evento.
region	String	cn-hangzhou	Região onde o evento ocorreu.
url	String	https://www.aliyun.com	URL clicada.
outbound_ip	String	102...1	IP de saída usado para enviar o e-mail.
esp	String	*mail.com	Categorização do provedor de e-mail do destinatário.
ip_pool_id	String	10306c37---a82f-1dafb56a9dd2	ID do pool de IPs usado para enviar o e-mail.
is_dedicated_ip	Boolean	true	Indica se foi usado um IP dedicado.
user_agent	String	Mozilla/5.0 (Macintosh; Intel Mac OS X ****) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4.1	Agente de usuário associado ao evento de clique.
tag	String	xxxxx	Tag usada para enviar o e-mail.

Evento de abertura

Quando o evento ocorre, o EventBridge recebe o seguinte evento de exemplo.

{
    "id": "45ef4dewdwe1-7c35-447a-bd93-fab****",
    "source": "acs.dm",
    "specversion": "1.0",
    "subject": "acs.dm:cn-hangzhou:123456789098****:215672",
    "time": "2020-11-19T21:04:41+08:00",
    "type": "dm:Trace:Open",
    "aliyunaccountid": "123456789098****",
    "aliyunpublishtime": "2020-11-19T21:04:42Z",
    "aliyuneventbusname": "default",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "172.25.XX.XX",
    "data": {
        "operate_time": "2024-04-29T11:25:48",
        "client_ip": "202.**.**.1",
        "env_id": "60000******",
        "from": "batch******@top",
        "rcpt": "xxx******@aliyun.com",
        "msg_id": "1df******@******",
        "event": "dm:Trace:Open",
        "region": "cn-hangzhou",
        "outbound_ip": "102.**.**.1",
        "esp": "*mail.com",
        "ip_pool_id": "10306c37-****-****-a82f-1dafb56a9dd2",
        "is_dedicated_ip": true,
        "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X ****) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4.1",
        "tag": "xxxxx"
    }
}

A tabela a seguir descreve os parâmetros do campo data.

Parâmetro	Tipo	Exemplo	Descrição
operate_time	String	2024-04-29T11:25:48	Horário em que a operação ocorreu.
client_ip	String	192.168.XX.XX	IP do cliente que abriu o e-mail.
env_id	String	60000	ID do e-mail retornado pelo sistema durante o envio.
from	String	batch****@top	Endereço do remetente.
rcpt	String	a****@aliyun.com	Endereço do destinatário.
msg_id	String	1df****@example.com	Campo Message-ID presente no e-mail.
event	String	dm:Trace:Click	Tipo do evento.
region	String	cn-hangzhou	Região onde o evento ocorreu.
outbound_ip	String	102...1	IP de saída usado para enviar o e-mail.
esp	String	*mail.com	Categorização do provedor de e-mail do destinatário.
ip_pool_id	String	10306c37---a82f-1dafb56a9dd2	ID do pool de IPs usado para enviar o e-mail.
is_dedicated_ip	Boolean	true	Indica se foi usado um IP dedicado.
user_agent	String	Mozilla/5.0 (Macintosh; Intel Mac OS X ****) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.4.1	Agente de usuário associado ao evento de abertura.
tag	String	xxxxx	Tag usada para enviar o e-mail.

Resultado assíncrono da validação de endereço em lista cinza

Quando um resultado assíncrono para validação de endereço em lista cinza fica disponível, o EventBridge recebe um evento semelhante ao exemplo a seguir.

{
    "id": "45ef4dewdwe1-7c35-447a-bd93-fab****",
    "source": "acs.dm",
    "specversion": "1.0",
    "subject": "acs.dm:cn-hangzhou:123456789098****:215672",
    "time": "2020-11-19T21:04:41+08:00",
    "type": "dm:Validator:GrayListResult",
    "aliyunaccountid": "123456789098****",
    "aliyunpublishtime": "2020-11-19T21:04:42Z",
    "aliyuneventbusname": "default",
    "aliyunregionid": "cn-hangzhou",
    "aliyunpublishaddr": "172.25.XX.XX",
    "data": {
        "request_id": "45ef4dewdwe1-7c35-447a-bd93-fab****",
        "submission_time": "1763541726",
        "completion_time": "1763541793",
        "email": "xxxxxx@yyy.com",
        "status": "INVALID",
        "sub_status": "MAILBOX_NOT_EXISTS",
        "provider": "XXXX",
        "is_free_mail": false,
        "local_part": "xxxxxx",
        "domain_part": "yyy.com"
    }
}

A tabela a seguir descreve os parâmetros do campo data.

Parâmetro	Tipo	Exemplo	Descrição
request_id	String	45ef4dewdwe1-7c35-447a-bd93-fab****	ID da solicitação retornado pela OpenAPI (Open Application Programming Interface) quando a requisição foi enviada.
submission_time	String	1763541726	Horário de envio da solicitação de validação. O horário está em UTC.
completion_time	String	1763541793	Horário de conclusão da validação. O horário está em UTC.
email	String	xxxxxx@yyy.com	Endereço de e-mail validado.
status	String	INVALID	Status do endereço de e-mail após a validação.
sub_status	String	MAILBOX_NOT_EXISTS	Substatus do endereço de e-mail após a validação. Fornece mais detalhes sobre o status.
provider	String	XXXX	Categorização do provedor de e-mail do endereço.
is_free_mail	Boolean	false	Indica se o endereço pertence a um provedor de e-mail gratuito.
local_part	String	xxxxxx	Parte local do endereço de e-mail obtida pela análise sintática. O valor é convertido para minúsculas e a tag de sub-endereçamento (parte após o sinal de mais) é removida.
domain_part	String	yyy.com	Parte do domínio do endereço de e-mail obtida pela análise sintática. O valor é convertido para minúsculas.