Azure Communication Services – Advanced Messaging-Ereignisse

Artikel
03/03/2025

In diesem Artikel werden die Eigenschaften und das Schema für Advanced Messaging-Ereignisse von Communication Services beschrieben. Eine Einführung in Ereignisschemas finden Sie unter Azure Event Grid-Ereignisschema.

Ereignistypen

Von Azure Communication Services werden folgende Advanced Messaging-Ereignistypen ausgegeben:

Ereignistyp	Beschreibung
Microsoft.Communication.AdvancedMessageReceived	Veröffentlicht, wenn Communication Services Advanced Messaging eine Nachricht empfängt.
Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated	Veröffentlicht, wenn Communication Services Advanced Messaging ein Statusupdate für eine zuvor gesendete Nachrichtenbenachrichtigung empfängt.
Microsoft.Communication.AdvancedMessageAnalysisCompleted(Preview)	Wird veröffentlicht, wenn der Kommunikationsdienst eine KI-Analyse mit einer Kundennachricht abgeschlossen hat.

Ereignisantworten

Wenn ein Ereignis ausgelöst wird, sendet der Event Grid-Dienst Daten zum Ereignis an die Endpunkte, die über ein entsprechendes Abonnement verfügen.

In diesem Abschnitt wird anhand eines Beispiels gezeigt, wie diese Daten für jedes Ereignis aussehen.

Microsoft.Communication.AdvancedMessageReceived Ereignis

Veröffentlicht, wenn Communication Services Advanced Messaging eine Nachricht empfängt.

Beispielszenario: Ein WhatsApp-Benutzer sendet eine WhatsApp-Nachricht an eine WhatsApp Business Number, die mit einem aktiven Advanced Messaging-Kanal in einer Communication Services-Ressource verbunden ist. Daher wird eine Microsoft.Communication.AdvancedMessageReceived mit dem Inhalt der WhatsApp-Nachricht des Benutzers veröffentlicht.

Attributliste

Details zu den Attributen, die für Microsoft.Communication.AdvancedMessageReceived-Ereignisse spezifisch sind.

attribute	Typ	NULL-Werte zulässig	Beschreibung
channelType	`string`	❌	Kanaltyp des Kanals, an den die Nachricht gesendet wurde. Beispiel: `"whatsapp"`
messageId	`string`	❌	Nachrichten-ID des Nachrichtenempfängerereignisses als GUID.
messageType	`string`	❌	Nachrichtentyp des Nachrichtenempfängerereignisses. Beispiel: `"interactive"`, `"sticker"`, `"reaction"`.
Von	`string`	❌	Absender-ID des Absenders der Nachricht.
Bis	`string`	❌	Die Kanal-ID, die die Nachricht empfangen hat, formatiert als GUID.
receivedTimestamp	`DateTimeOffset`	❌	Zeitstempel, wann die Nachricht empfangen wird.
content	`string`	✔️	Der Textinhalt in der Nachricht.
Medien-	`MediaContent`	✔️	Enthält Details zu den empfangenen Medien.
context	`MessageContext`	✔️	Enthält Details zum Antwort-Nachrichtenkontext, falls der Benutzer auf geschäftliche Nachrichten antwortet.
Schaltfläche "+" ein	`ButtonContent`	✔️	Enthält Details zum Inhalt der Antwortschaltfläche, die der Benutzer für die Vorlagennachricht ausgewählt hat.
Interaktiv	`InteractiveContent`	✔️	Enthält Details zur interaktiven Nachrichtenantwort wie buttonReply oder listReply
Reaktion	`ReactionContent`	✔️	Enthält Details zu der empfangenen Reaktion über geschäftliche Sendenachricht.

MediaContent

attribute	Typ	NULL-Werte zulässig	Beschreibung
mimeType	`string`	❌	MIME-Typ des Mediums. Wird verwendet, um den richtigen Dateityp für Mediendownloads zu ermitteln.
ID	`string`	❌	Media ID. Wird verwendet, um Medien zum Herunterladen abzurufen, formatiert als GUID.
fileName	`string`	✔️	Der Dateiname der zugrunde liegenden Mediendatei, wie beim Hochladen angegeben.
Beschriftung	`string`	✔️	Beschriftungstext für das Medienobjekt, sofern unterstützt und bereitgestellt.
animiert	`string`	✔️	Auf „true“ festgelegt, wenn der Aufkleber animiert wird; andernfalls „false“.

MessageContext

attribute	Typ	NULL-Werte zulässig	Beschreibung
from	`string`	✔️	Die WhatsApp-ID für den Kunden, der auf eine eingehende Nachricht geantwortet hat.
ID	`string`	✔️	Die Nachrichten-ID für die gesendete Nachricht für eine eingehende Antwort.

ButtonContent

attribute	Typ	NULL-Werte zulässig	Beschreibung
Text	`string`	✔️	Der Text der Schaltfläche.
payload	`string`	✔️	Die Nutzlast, die vom Unternehmen eingerichtet wird, der Schaltfläche, die der Benutzer ausgewählt hat.

InteractiveContent

attribute	Typ	NULL-Werte zulässig	Beschreibung
Typ	`InteractiveReplyType`	✔️	Typ des interaktiven Inhalts.
buttonReply	`InteractiveButtonReplyContent`	✔️	Gesendet, wenn ein Kunde eine Schaltfläche auswählt.
listReply	`InteractiveListReplyContent`	✔️	Gesendet, wenn ein Kunde ein Element aus einer Liste auswählt.

InteractiveReplyType

Wert	Beschreibung
buttonReply	Der interaktive Inhalt ist eine Schaltfläche.
listReply	Der interaktive Inhalt ist eine Liste.
Unbekannt	Der interaktive Inhalt ist unbekannt.

InteractiveButtonReplyContent

attribute	Typ	NULL-Werte zulässig	Beschreibung
ID	`string`	✔️	ID der Schaltfläche.
title	`string`	✔️	Titel der Schaltfläche

InteractiveListReplyContent

attribute	Typ	NULL-Werte zulässig	Beschreibung
ID	`string`	✔️	ID des ausgewählten Listenelements.
title	`string`	✔️	Titel des ausgewählten Listenelements.
Beschreibung	`string`	✔️	Beschreibung der ausgewählten Zeile.

ReactionContent

Attribut	Typ	NULL-Werte zulässig	Beschreibung
messageId	`string`	❌	Nachrichten-ID, auf die der Benutzer antwortet.
Emoji	`string`	✔️	Zeichenfolge, die Unicode-Escapesequenz des Emojis darstellt.

Beispiele

Empfangene Nachricht

[{
  "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",
    "messageType": "text",
    "from": "{sender@id}",
    "to": "{channel-id}",
    "receivedTimestamp": "2023-07-06T18:30:19+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2023-07-06T18:30:22.1921716Z"
}]

Empfangene Bildmediennachricht

[{
  "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",
    "messageType": "image",
    "media": {
 "mimeType": "image/jpeg",
 "id": "00000000-0000-0000-0000-000000000000",
 "caption": "This is a media caption"
    },
    "from": "{sender@id}",
    "to": "{channel-id}",
    "receivedTimestamp": "2023-07-06T18:30:19+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2023-07-06T18:30:22.1921716Z"
}]

Empfangene Dokumentmediennachricht

{
  "id": "00000000-0000-0000-0000-000000000000",
  "topic": "/subscriptions/{subscription-id}/resourcegroups/acs-cpm-ppe-resources/providers/microsoft.communication/communicationservices/acscpm-whatsup-pperesource",
  "subject": "advancedMessage/sender/14254360097/recipient/75476a19-a68d-4e10-806c-3680f099e069",
  "data": {
    "channelType": "whatsapp",
    "messageType": "document",
    "media": {
 "mimeType": "application/pdf",
 "id": "00000000-0000-0000-0000-000000000000",
 "fileName": "UTSAV Mela 2024  India's Independence Day  Kids Out and About Seattle.pdf"
    },
    "from": "14254360097",
    "to": "{channel-id}",
    "receivedTimestamp": "2024-12-24T06:41:56+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2024-12-24T06:41:59.1218953Z"
}

Mit InteractiveListReplyContent empfangene Antwortnachricht auflisten

[{
  "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/00000000-0000-0000-0000-000000000000",
  "data": {
    "channelType": "whatsapp",
    "messageType": "interactive",
    "context": {
 "from": "{receiverphonenumber@id}",
 "id": "{reply-message-id}"
    },
    "interactive": {
 "type": "listReply",
 "listReply": {
   "id": "priority_mail",
   "title": "Priority Mail",
   "description": "1–3 Days"
 }
    },
    "from": "{sender@id}",
    "to": "{channel-id}",
    "receivedTimestamp": "2024-12-04T23:53:28+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2024-12-04T23:53:29.3079089Z"
}]

Mit InteractiveButtonReplyContent empfangene Antwortschaltfläche

[{
  "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/00000000-0000-0000-0000-000000000000",
  "data": {
    "channelType": "whatsapp",
    "messageType": "interactive",
    "context": {
 "from": "{receiverphonenumber@id}",
 "id": "{reply-message-id}"
    },
    "interactive": {
 "type": "buttonReply",
 "buttonReply": {
   "id": "agree",
   "title": "Agree"
 }
    },
    "from": "{sender@id}",
    "to": "{channel-id}",
    "receivedTimestamp": "2024-12-04T23:57:04+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2024-12-04T23:57:04.9459858Z"
}]

Empfangene Antwortstickernachricht

[{
  "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/00000000-0000-0000-0000-000000000000",
  "data": {
    "channelType": "whatsapp",
    "messageType": "sticker",
    "media": {
 "mimeType": "image/webp",
 "id": "00000000-0000-0000-0000-000000000000",
 "animated": false
    },
    "from": "{sender@id}",
    "to": "{channel-id}",
    "receivedTimestamp": "2024-12-04T23:57:04+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2024-12-04T23:57:04.9459858Z"
}]

Empfangene Antwortreaktionsnachricht

[{
  "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/00000000-0000-0000-0000-000000000000",
  "data": {
    "channelType": "whatsapp",
    "messageType": "reaction",
    "reaction": {
 "messageId": "{reply-message-id}",
 "emoji": "👍"
    },
    "from": "{sender@id}",
    "to": "{channel-id}",
    "receivedTimestamp": "2024-12-04T23:57:04+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2024-12-04T23:57:04.9459858Z"
}]

Empfangene ButtonContent-Nachricht

[{
  "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/00000000-0000-0000-0000-000000000000",
  "data": {
    "channelType": "whatsapp",
    "messageType": "button",
    "context": {
 "from": "{receiverphonenumber@id}",
 "id": "{reply-message-id}"
    },
    "button": {
 "text": "Yes",
 "payload": "Kat said yes"
    },
    "from": "{sender@id}",
    "to": "{channel-id}",
    "receivedTimestamp": "2024-12-20T04:03:22+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageReceived",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2024-12-20T04:03:22.7978135Z"
}]

Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated Ereignis

Veröffentlicht, wenn Communication Services Advanced Messaging ein Statusupdate für eine zuvor gesendete Nachrichtenbenachrichtigung empfängt.

Beispielszenario: Contoso verwendet einen aktiven Advanced Messaging-Kanal, der mit einem WhatsApp Business-Konto verbunden ist, um eine WhatsApp-Nachricht an einen WhatsApp-Benutzer zu senden. WhatsApp antwortet dann auf den Advanced Messaging-Kanal von Contoso mit dem Status der zuvor gesendeten Nachricht. Als Ergebnis wird ein Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated-Ereignis, das den Nachrichtenstatus enthält, veröffentlicht.

Attributliste

Details zu den Attributen, die für Microsoft.Communication.AdvancedMessageReceived-Ereignisse spezifisch sind.

attribute	Typ	NULL-Werte zulässig	Beschreibung
channelType	`string`	❌	Kanaltyp des Kanals, an den die Nachricht gesendet wurde.
Von	`string`	❌	Die Kanal-ID, die die Nachricht gesendet hat, formatiert als GUID.
Bis	`string`	❌	Empfänger-ID, an die die Nachricht gesendet wurde.
receivedTimestamp	`DateTimeOffset`	❌	Zeitstempel der Nachricht.
messageId	`string`	✔️	Die ID der Nachricht, formatiert als GUID.
status	`string`	✔️	Status der Nachricht. Mögliche Werte: `Sent`, `Delivered`, `Read` und `Failed`. Weitere Informationen finden Sie unter Status.
error	`ChannelEventError`	✔️	Enthält die Details eines Fehlers.

ChannelEventError

attribute	Typ	NULL-Werte zulässig	Beschreibung
channelCode	`string`	✔️	Der in diesem Kanal empfangene Fehlercode.
channelMessage	`string`	✔️	Die Fehlermeldung, die in diesem Kanal empfangen wurde.

Status

Wert	Beschreibung
Gesendet	Der Nachrichtendienst hat die Nachricht an den Empfänger gesendet.
Übermittelt	Der Nachrichtenempfänger hat die Nachricht empfangen.
Lesen Sie	Der Nachrichtenempfänger liest die Nachricht
Fehler	Fehler beim Senden der Nachricht.

Beispiele

Update für die Nachrichtenübermittlung

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

Update für die Nachrichtenübermittlung mit Fehler

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

Microsoft.Communication.AdvancedMessageAnalysisCompleted(Preview)-Event

Wird veröffentlicht, wenn der Kommunikationsdienst eine KI-Analyse mit einer Kundennachricht abgeschlossen hat.

Beispielszenario: Ein WhatsApp-Benutzer sendet eine Nachricht an eine WhatsApp Business-Nummer, die mit einem aktiven Advanced Messaging-Kanal in einer Communication Services-Ressource verbunden ist, für die die Funktion Nachrichtenanalyse aktiviert wurde. Daher veröffentlicht das System eine Microsoft.Communication.AdvancedMessageAnalysisCompleted mit der Analyse der WhatsApp-Nachricht des Benutzers.

Attributliste

Details zu den Attributen, die für Microsoft.Communication.AdvancedMessageAnalysisCompleted-Ereignisse spezifisch sind.

attribute	Typ	NULL-Werte zulässig	Beschreibung
channelType	`string`	✔️	Kanaltyp des Kanals, an den die Nachricht gesendet wurde.
Von	`string`	✔️	Die Kanal-ID, die die Nachricht gesendet hat, formatiert als GUID.
Bis	`string`	✔️	Empfänger-ID, an die die Nachricht gesendet wurde.
receivedTimestamp	`DateTimeOffset`	✔️	Zeitstempel der Nachricht.
originalMessage	`string`	✔️	Die ursprüngliche Benutzernachricht.
intentAnalysis	`string`	✔️	Die Absichtsanalyse der empfangenen Benutzernachricht.
languageDetection	`LanguageDetection`	✔️	Enthält die Spracherkennung der empfangenen Benutzernachricht.
extractedKeyPhrases	`List<string>`	✔️	Enthält die Schlüsselphrasen der empfangenen Benutzernachricht.

LanguageDetection

attribute	Typ	NULL-Werte zulässig	Beschreibung
language	`string`	✔️	Die erkannte Sprache.
confidenceScore	`float`	✔️	Die Konfidenzbewertung der erkannten Sprache.
Verschiebung	`string`	✔️	Die Übersetzung der Nachricht.

Beispiele

Nachrichtenanalyse abgeschlossen

[{
  "id": "df1c2d92-6155-4ad7-a865-cb8497106c52",
  "topic": "/subscriptions/{subscription-id}/resourcegroups/{resourcegroup-name}/providers/microsoft.communication/communicationservices/acsxplatmsg-test",
  "subject": "advancedMessage/sender/{sender@id}/recipient/00000000-0000-0000-0000-000000000000",
  "data": {
    "originalMessage": "Hello, could u help me order some flowers for Mother’s Day?",
    "channelType": "whatsapp",
    "languageDetection": {
 "language": "English",
 "confidenceScore": 0.99
    },
    "intentAnalysis": "Order request: The customer is contacting customer service to request assistance with ordering flowers for Mother's Day.",
    "extractedKeyPhrases": [
 "order",
 "flowers",
 "Mother's Day"
    ],
    "from": "{sender@id}",
    "to": "00000000-0000-0000-0000-000000000000",
    "receivedTimestamp": "2024-07-05T19:10:35.28+00:00"
  },
  "eventType": "Microsoft.Communication.AdvancedMessageAnalysisCompleted",
  "dataVersion": "1.0",
  "metadataVersion": "1",
  "eventTime": "2024-07-05T19:10:35.2806524Z"
}]

Schnellstart

Ein Schnellstart, der zeigt, wie Sie Advanced Messaging-Ereignisse mithilfe von Webhooks abonnieren, finden Sie unter Schnellstart: Behandeln von Ereignissen für erweitertes Messaging.

Freigeben über

Azure Communication Services – Advanced Messaging-Ereignisse

Ereignistypen

Ereignisantworten

Microsoft.Communication.AdvancedMessageReceived Ereignis

Attributliste

MediaContent

MessageContext

ButtonContent

InteractiveContent

InteractiveReplyType

InteractiveButtonReplyContent

InteractiveListReplyContent

ReactionContent

Beispiele

Empfangene Nachricht

Empfangene Bildmediennachricht

Empfangene Dokumentmediennachricht

Mit InteractiveListReplyContent empfangene Antwortnachricht auflisten

Mit InteractiveButtonReplyContent empfangene Antwortschaltfläche

Empfangene Antwortstickernachricht

Empfangene Antwortreaktionsnachricht

Empfangene ButtonContent-Nachricht

Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated Ereignis

Attributliste

ChannelEventError

Status

Beispiele

Update für die Nachrichtenübermittlung

Update für die Nachrichtenübermittlung mit Fehler

Microsoft.Communication.AdvancedMessageAnalysisCompleted(Preview)-Event

Attributliste

LanguageDetection

Beispiele

Nachrichtenanalyse abgeschlossen

Schnellstart

Feedback

Zusätzliche Ressourcen