Azure Communication Services - Advanced Messaging イベント

この記事では、Communication Services の Advanced Messaging イベントのプロパティとスキーマを取り上げます。 イベント スキーマの概要については、「Azure Event Grid イベント スキーマ」を参照してください。

イベントの種類

Azure Communication Services から出力される Advanced Messaging イベントの種類は次のとおりです。

イベント応答

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

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

Microsoft.Communication.AdvancedMessageReceived event

Communication Services Advanced Messaging がメッセージを受信したときに発行されます。

シナリオ例: WhatsApp ユーザーが、Communication Services リソースのアクティブな Advanced Messaging チャネルに接続されている WhatsApp ビジネス番号に WhatsApp メッセージを送信します。 その結果、ユーザーの WhatsApp メッセージの内容を含む Microsoft.Communication.AdvancedMessageReceived が発行されます。

属性の一覧

Microsoft.Communication.AdvancedMessageReceived イベントに固有の属性の詳細。

MediaContent

MessageContext

ButtonContent

InteractiveContent

InteractiveReplyType

InteractiveButtonReplyContent

InteractiveListReplyContent

例

受信したテキスト メッセージ

[{
  "id": "00000000-0000-0000-0000-000000000000",
  "topic": "/subscriptions/{subscription-id}/resourcegroups/{resourcegroup-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
  "subject": "advancedMessage/sender/{sender@id}/recipient/11111111-1111-1111-1111-111111111111",
  "data": {
    "content": "Hello",
    "channelType": "whatsapp",
    "from": "{sender@id}",
    "to": "11111111-1111-1111-1111-111111111111",
    "receivedTimestamp": "2023-07-06T18:30:19+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2023-07-06T18:30:22.1921716Z"
}]

受信したメディア メッセージ

[{
  "id": "00000000-0000-0000-0000-000000000000",
  "topic": "/subscriptions/{subscription-id}/resourcegroups/{resourcegroup-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
  "subject": "advancedMessage/sender/{sender@id}/recipient/11111111-1111-1111-1111-111111111111",
  "data": {
    "channelType": "whatsapp",
    "media": {
      "mimeType": "image/jpeg",
      "id": "22222222-2222-2222-2222-222222222222",
      "caption": "This is a media caption"
    },
    "from": "{sender@id}",
    "to": "11111111-1111-1111-1111-111111111111",
    "receivedTimestamp": "2023-07-06T18:30:19+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2023-07-06T18:30:22.1921716Z"
}]

Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated event

Communication Services Advanced Messaging が、以前に送信されたメッセージ通知のステータスの更新を受信したときに発行されます。

シナリオ例: Contoso は、WhatsApp ビジネス アカウントに接続されているアクティブな Advanced Messaging チャネルを使用して、WhatsApp ユーザーに WhatsApp メッセージを送信します。 その後、WhatsApp は、以前に送信されたメッセージのステータスを Contoso の Advanced Messaging チャネルに応答します。 その結果、メッセージのステータスを含む Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated イベントが発行されます。

属性の一覧

Microsoft.Communication.AdvancedMessageReceived イベントに固有の属性の詳細。

ChannelEventError

状態

例

メッセージ配信の更新

[{
  "id": "00000000-0000-0000-0000-000000000000",
  "topic": "/subscriptions/{subscription-id}/resourcegroups/{resourcegroup-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
  "subject": "advancedMessage/22222222-2222-2222-2222-222222222222/status/Sent",
  "data": {
    "messageId": "22222222-2222-2222-2222-222222222222",
    "status": "Sent",
    "channelType": "whatsapp",
    "from": "{sender@id}",
    "to": "{receiver@id}",
    "receivedTimestamp": "2023-07-06T18:42:28+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2023-07-06T18:42:28.8454662Z"
}]

失敗したメッセージ配信の更新

[{
  "id": "00000000-0000-0000-0000-000000000000",
  "topic": "/subscriptions/{subscription-id}/resourcegroups/{resourcegroup-name}/providers/microsoft.communication/communicationservices/acsxplatmsg-test",
  "subject": "advancedMessage/22222222-2222-2222-2222-222222222222/status/Failed",
  "data": {
    "messageId": "22222222-2222-2222-2222-222222222222",
    "status": "Failed",
    "channelType": "whatsapp",
    "from": "{sender@id}",
    "to": "{receiver@id}",
    "receivedTimestamp": "2023-07-06T18:42:28+00:00",
    "error": {
      "channelCode": "131026",
      "channelMessage": "Message Undeliverable."
    }
  },
  "eventType": "Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2023-07-06T18:42:28.8454662Z"
}]

クイックスタート

Web hook を使用して Advanced Messaging イベントをサブスクライブする方法を示すクイック スタートについては、「クイック スタート: Advanced Messaging イベントを処理する」を参照してください。