Azure Communication Services - テレフォニーと SMS のイベント

[アーティクル]
03/25/2023

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

イベントの種類

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

イベントの種類	説明
Microsoft.Communication.SMSReceived	Communication Service に関連付けられた電話番号によって SMS が受信されたときに発行されます。
Microsoft.Communication.SMSDeliveryReportReceived	Communication Service によって送信された SMS の配信レポートを受信したときに発行されます。

イベント応答

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

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

Microsoft.Communication.SMSDeliveryReportReceived イベント

[{
  "id": "Outgoing_202009180022138813a09b-0cbf-4304-9b03-1546683bb910",
  "topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
  "subject": "/phonenumber/15555555555",
  "data": {
    "MessageId": "Outgoing_202009180022138813a09b-0cbf-4304-9b03-1546683bb910",
    "From": "15555555555",
    "To": "+15555555555",
    "DeliveryStatus": "Delivered",
    "DeliveryStatusDetails": "No error.",
    "ReceivedTimestamp": "2020-09-18T00:22:20.2855749Z",
    "DeliveryAttempts": [
      {
        "Timestamp": "2020-09-18T00:22:14.9315918Z",
        "SegmentsSucceeded": 1,
        "SegmentsFailed": 0
      }
    ],
    "Tag": "Optional customer-tag set in the original message"
  },
  "eventType": "Microsoft.Communication.SMSDeliveryReportReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2020-09-18T00:22:20Z"
}]

注意

DeliveryStatus で有効な値は、Delivered および Failed です。

Microsoft.Communication.SMSReceived イベント

[{
  "id": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e",
  "topic": "/subscriptions/50ad1522-5c2c-4d9a-a6c8-67c11ecb75b8/resourcegroups/acse2e/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
  "subject": "/phonenumber/15555555555",
  "data": {
    "MessageId": "Incoming_20200918002745d29ebbea-3341-4466-9690-0a03af35228e",
    "From": "15555555555",
    "To": "15555555555",
    "Message": "Great to connect with Azure Communication Services events",
    "ReceivedTimestamp": "2020-09-18T00:27:45.32Z"
  },
  "eventType": "Microsoft.Communication.SMSReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2020-09-18T00:27:47Z"
}]

次のステップ

「クイックスタート: SMS と配信レポートのイベントを処理する」のチュートリアルを参照してください。