Partilhar via


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

Este artigo fornece as propriedades e o esquema para eventos de email de serviços de comunicação. Para obter uma introdução aos esquemas de eventos, consulte Esquema de eventos da Grade de Eventos do Azure.

Tipos de eventos

Os Serviços de Comunicação do Azure emitem os seguintes tipos de eventos de telefonia e SMS (Serviço de Mensagens Curtas):

Tipo de evento Description
Microsoft.Communication.EmailDeliveryReportReceived Publicado quando um relatório de entrega é recebido para um e-mail enviado pelo Serviço de Comunicação.
Microsoft.Communication.EmailEngagementTrackingReportReceived Publicado quando o e-mail enviado é aberto ou o link, se aplicável, é clicado.

Respostas a eventos

Quando um evento é acionado, o serviço Grade de Eventos envia dados sobre esse evento para os pontos de extremidade de assinatura.

Esta seção contém um exemplo da aparência desses dados 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"
}]

Nota

Os valores possíveis para Status são:

  • Delivered: A mensagem foi entregue com êxito para o destino pretendido (destinatário Mail Transfer Agent).
  • Suppressed: O e-mail do destinatário tinha sido devolvido anteriormente, e todos os e-mails subsequentes para esse destinatário estão sendo temporariamente suprimidos como resultado.
  • Bounced: O e-mail foi devolvido, o que pode acontecer porque o endereço de e-mail não existe ou o domínio é inválido.
  • Quarantined: A mensagem foi colocada em quarentena (como spam, correio em massa ou phishing).
  • FilteredSpam: A mensagem foi identificada como spam e foi rejeitada ou bloqueada (não colocada em quarentena).
  • Expanded: Um destinatário do 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"
}]

Nota

Valores possíveis para engagementType are View e Click. Quando o engagementType é Click, engagementContext é o link no e-mail enviado que foi clicado.

Tutorial

Para obter um tutorial que mostra como se inscrever para eventos de email usando ganchos da Web, consulte Guia de início rápido: manipular eventos de email.