Azure Communication Services - Email イベント

[アーティクル]
07/26/2023

この記事では、コミュニケーションサービスメールイベントのプロパティとスキーマを取り上げます。イベントスキーマの概要については、「Azure Event Grid イベントスキーマ」を参照してください。

イベントの種類

Azure Communication Services から出力されるテレフォニーと SMS のイベントの種類は次のとおりです。

イベントの種類	説明
Microsoft.Communication.EmailDeliveryReportReceived	Communication Service によって送信された Email の配信レポートを受信したときに発行されます。
Microsoft.Communication.EmailEngagementTrackingReportReceived	送信されたメールが開かれたか、リンクがクリックされたとき (該当する場合) に発行されます。

イベント応答

イベントがトリガーされると、Event Grid サービスにより、そのイベントに関するデータがサブスクライブしているエンドポイントに送信されます。

このセクションには、各イベントでそのデータがどのように見えるかの例が含まれています。

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"
}]

Note

Status に指定できる値は次のとおりです。

Delivered: メッセージが目的の宛先 (受信者のメール転送エージェント) に正常に渡されました。
Suppressed: 受信者の電子メールが以前にハードバウンスされ、その結果、この受信者への以降のメールがすべて一時的に抑制されています。
Bounced: 電子メールがハードバウンスされました。原因として、電子メールアドレスが存在しないか、ドメインが無効であることが考えられます。
Quarantined: メッセージがスパム、一括メール、またはフィッシングとして検疫されました。
FilteredSpam: メッセージはスパムとして識別され、(検疫ではなく) 拒否またはブロックされました。
Expanded: グループの個々のメンバーに配信される前に、配布グループの受信者が展開されました。
Failed: メッセージは配信されませんでした。

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"
}]

注意

engagementType で有効な値は、View および Click です。 engagementType が Clickの場合、engagementContext は送信されたメール内のクリックされたリンクです。

チュートリアル

Web hook を使ってメールイベントをサブスクライブする方法を示すチュートリアルについては、「クイックスタート - Email イベントを処理する」をご覧ください。