Serviços de Comunicação do Azure – Eventos de email

Artigo
07/24/2023

Este artigo fornece as propriedades e o esquema dos eventos de email dos serviços de comunicação. Para obter uma introdução a esquemas de evento, consulte esquema de grade de eventos do Azure.

Tipos de evento

Os Serviços de Comunicação do Azure emitem os seguintes tipos de evento de SMS e telefonia:

Tipo de evento	Descrição
Microsoft.Communication.EmailDeliveryReportReceived	Publicado quando um relatório de entrega de email enviado pelo Serviço de Comunicação é recebido.
Microsoft.Communication.EmailEngagementTrackingReportReceived	Publicado quando o email enviado é aberto ou o link, se houver, é clicado.

Respostas do evento

Quando um evento é disparado, o serviço de Grade de Eventos envia dados sobre esse evento para o ponto de extremidade de assinatura.

Esta seção mostra um exemplo de como os dados seriam para cada evento.

Evento Microsoft.Communication.EmailDeliveryReportReceived

[{
  "id": "00000000-0000-0000-0000-000000000000",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
  "subject": "sender/senderid@azure.com/message/00000000-0000-0000-0000-000000000000",
  "data": {
    "sender": "senderid@azure.com", 
    "recipient": "receiver@azure.com",
    "messageId": "00000000-0000-0000-0000-000000000000",
    "status": "Delivered",
    "deliveryStatusDetails": {
      "statusMessage": "Status Message"
    },
    "deliveryAttemptTimeStamp": "2020-09-18T00:22:20.2855749+00:00",
  },
  "eventType": "Microsoft.Communication.EmailDeliveryReportReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2020-09-18T00:22:20.822Z"
}]

Observação

Os valores possíveis para Status são:

Delivered: a mensagem foi entregue com êxito ao destino pretendido (Agente de Transferência de Email do destinatário).
Suppressed: o email do destinatário havia sofrido uma devolução definitiva anteriormente e, como resultado, todos os emails subsequentes para esse destinatário estão sendo temporariamente suprimidos.
Bounced: o email sofreu uma devolução definitiva, o que pode ter acontecido porque o endereço de email não existe ou o domínio é inválido.
Quarantined: a mensagem foi colocada em quarentena (como spam, email em massa ou phishing).
FilteredSpam: a mensagem foi identificada como spam e foi rejeitada ou bloqueada (não colocada em quarentena).
Expanded: o destinatário de um grupo de distribuição foi expandido antes da entrega aos membros individuais do grupo.
Failed: a mensagem não foi entregue.

Evento Microsoft.Communication.EmailEngagementTrackingReportReceived

[{
  "id": "00000000-0000-0000-0000-000000000000",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
  "subject": "sender/senderid@azure.com/message/00000000-0000-0000-0000-000000000000",
  "data": {
    "sender": "senderid@azure.com", 
    "messageId": "00000000-0000-0000-0000-000000000000",
    "userActionTimeStamp": "2022-09-06T22:34:52.1303595+00:00",
    "engagementContext": "",
    "userAgent": "",
    "engagementType": "view"
  },
  "eventType": "Microsoft.Communication.EmailEngagementTrackingReportReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2022-09-06T22:34:52.688Z"
}]

Observação

Os valores possíveis para engagementType são View e Click. Quando engagementType é Click, engagementContext é o link no email enviado que foi clicado.

Tutorial

Para obter um tutorial que mostra como assinar eventos de email usando web hooks, confira Início Rápido: lidar com eventos de email.

Compartilhar via