Azure Communication Services - eventos de Email

Artigo
07/21/2023

Este artigo fornece as propriedades e o esquema para eventos de e-mail dos serviços de comunicação. Para obter uma introdução aos esquemas de eventos, veja Azure Event Grid esquema de eventos.

Tipos de eventos

Azure Communication Services emite os seguintes tipos de eventos de telefonia e SMS:

Tipo de evento	Descrição
Microsoft.Communication.EmailDeliveryReportReceived	Publicado quando um relatório de entrega é recebido para um Email enviado pelo Serviço de Comunicação.
Microsoft.Communication.EmailEngagementTrackingReportReceived	Publicado quando o Email enviado é aberto ou a ligação, se aplicável for clicada.

Respostas de eventos

Quando um evento é acionado, o serviço Event Grid envia dados sobre esse evento para subscrever pontos finais.

Esta secção contém um exemplo do aspeto 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 :

Delivered: A mensagem foi entregue com êxito ao destino pretendido (agente de transferência de correio do destinatário).
Suppressed: O e-mail do destinatário tinha sido enviado de forma difícil anteriormente e todos os e-mails subsequentes para este destinatário estão a ser temporariamente suprimidos.
Bounced: o e-mail foi enviado de forma difícil, o que pode ter acontecido 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

Os valores possíveis para engagementType são View e Click. Quando o engagementType é Click, engagementContext é a ligação na Email enviada que foi clicada.

Tutorial

Para obter um tutorial que mostra como subscrever eventos de e-mail com web hooks, consulte Início Rápido: Processar eventos de e-mail.

Partilhar via