Azure Communication Services - Geavanceerde berichtengebeurtenissen
Artikel 02/25/2025
6 inzenders
Feedback
In dit artikel
Dit artikel bevat de eigenschappen en het schema voor Communication Services Advanced Messaging-gebeurtenissen. Zie het Gebeurtenisschema van Azure Event Grid voor een inleiding tot gebeurtenisschema's
Gebeurtenistypen
Azure Communication Services verzendt de volgende advanced messaging-gebeurtenistypen:
Reacties op gebeurtenissen
Wanneer een gebeurtenis wordt geactiveerd, verzendt de Event Grid-service gegevens over die gebeurtenis om eindpunten te abonneren.
Deze sectie bevat een voorbeeld van hoe die gegevens eruit zien voor elke gebeurtenis.
Microsoft.Communication.AdvancedMessageReceived-gebeurtenis
Gepubliceerd wanneer Communication Services Advanced Messaging een bericht ontvangt.
Voorbeeldscenario: Een WhatsApp-gebruiker verzendt een WhatsApp-bericht naar een WhatsApp Business Number dat is verbonden met een actief Advanced Messaging-kanaal in een Communication Services-resource. Als gevolg hiervan wordt een Microsoft.Communication.AdvancedMessageReceived met de inhoud van het WhatsApp-bericht van de gebruiker gepubliceerd.
Lijst met kenmerken
Details voor de kenmerken die specifiek zijn voor Microsoft.Communication.AdvancedMessageReceived gebeurtenissen.
Kenmerk
Type
Nullable
Beschrijving
channelType
string❌
Kanaaltype van het kanaal waarop het bericht is verzonden. Voorbeeld: "whatsapp".
messageId
string❌
Bericht-id van de gebeurtenis voor het ontvangen van het bericht als GUID.
messageType
string❌
Berichttype van de gebeurtenis voor het ontvangen van het bericht. Zoals: "interactive", "sticker", "reaction".
from
string❌
Afzender-id die het bericht heeft verzonden.
to
string❌
De kanaal-id die het bericht heeft ontvangen, opgemaakt als een GUID.
receivedTimestamp
DateTimeOffset❌
Tijdstempel wanneer het bericht wordt ontvangen.
content
string✔️
De tekstinhoud in het bericht.
media
MediaContent✔️
Bevat details over de ontvangen media .
context
MessageContext✔️
Bevat details over de context van het antwoordbericht als de gebruiker reageert op een zakelijk bericht.
knoop
ButtonContent✔️
Bevat details van de inhoud van de antwoordknop die is geselecteerd voor sjabloonbericht.
interactief
InteractiveContent✔️
Bevat details over interactief berichtantwoord, zoals buttonReply of listReply
reactie
ReactionContent✔️
Bevat details over de ontvangen reactie via het verzenden van een zakelijk bericht.
MediaContent
Kenmerk
Type
Nullable
Beschrijving
mimeType
string❌
MIME-type van de media. Wordt gebruikt om het juiste bestandstype voor mediadownloads te bepalen.
Id
string❌
Media-id. Wordt gebruikt voor het ophalen van media voor downloaden, opgemaakt als een GUID.
fileName
string✔️
De bestandsnaam van het onderliggende mediabestand zoals opgegeven bij het uploaden.
bijschrift
string✔️
Bijschrifttekst voor het mediaobject, indien ondersteund en opgegeven.
bezield
string✔️
Ingesteld op waar als de sticker is geanimeerd; anders onwaar.
MessageContext
Kenmerk
Type
Nullable
Beschrijving
van
string✔️
De WhatsApp-id voor de klant die heeft gereageerd op een binnenkomend bericht.
Id
string✔️
De bericht-id voor het verzonden bericht voor een binnenkomend antwoord.
ButtonContent
Kenmerk
Type
Nullable
Beschrijving
sms verzenden
string✔️
De tekst van de knop.
nettolading
string✔️
De nettolading, ingesteld door het bedrijf, van de knop die de gebruiker heeft geselecteerd.
InteractiveContent
InteractiveReplyType
Weergegeven als
Beschrijving
buttonReply
De interactieve inhoud is een knop.
listReply
De interactieve inhoud is een lijst.
onbekend
De interactieve inhoud is onbekend.
InteractiveButtonReplyContent
Kenmerk
Type
Nullable
Description
Id
string✔️
Id van de knop.
title
string✔️
Titel van de knop.
InteractiveListReplyContent
Kenmerk
Type
Nullable
Description
Id
string✔️
Id van het geselecteerde lijstitem.
title
string✔️
Titel van het geselecteerde lijstitem.
beschrijving
string✔️
Beschrijving van de geselecteerde rij.
ReactionContent
Kenmerk
Type
Nullable
Beschrijving
messageId
string❌
Bericht-id waarnaar de gebruiker antwoordt.
emoji
string✔️
Tekenreeks die unicode-escapereeks van de emoji vertegenwoordigt.
Voorbeelden
Ontvangen sms-bericht
[{
"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"
}]
[{
"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"
}]
{
"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"
}
Antwoordbericht weergeven dat is ontvangen met 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/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"
}]
Antwoordknopbericht ontvangen met InteractiveButtonReplyContent
[{
"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"
}]
Antwoordstickerbericht ontvangen
[{
"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"
}]
Antwoordreactiebericht ontvangen
[{
"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"
}]
ButtonContent-bericht ontvangen
[{
"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-gebeurtenis
Gepubliceerd wanneer Communication Services Advanced Messaging een statusupdate ontvangt voor een eerder verzonden berichtmelding.
Voorbeeldscenario: Contoso maakt gebruik van een actief Advanced Messaging-kanaal dat is verbonden met een WhatsApp Business-account om een WhatsApp-bericht te verzenden naar een WhatsApp-gebruiker. WhatsApp beantwoordt vervolgens het Advanced Messaging-kanaal van Contoso met de status van het eerder verzonden bericht. Als gevolg hiervan wordt een Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated gebeurtenis met de berichtstatus gepubliceerd.
Lijst met kenmerken
Details voor de kenmerken die specifiek zijn voor Microsoft.Communication.AdvancedMessageReceived gebeurtenissen.
Kenmerk
Type
Nullable
Beschrijving
channelType
string❌
Kanaaltype van het kanaal waarop het bericht is verzonden.
from
string❌
De kanaal-id die het bericht heeft verzonden, opgemaakt als een GUID.
to
string❌
Geadresseerde-id waarnaar het bericht is verzonden.
receivedTimestamp
DateTimeOffset❌
Tijdstempel van het bericht.
messageId
string✔️
De id van het bericht, opgemaakt als een GUID.
status
string✔️
Status van het bericht. Mogelijke waarden zijn onder andere Sent, Delivered, Readen Failed. Zie Status voor meer informatie.
error
ChannelEventError✔️
Bevat de details van een fout.
ChannelEventError
Kenmerk
Type
Nullable
Beschrijving
channelCode
string✔️
De foutcode die op dit kanaal is ontvangen.
channelMessage
string✔️
Het foutbericht dat op dit kanaal is ontvangen.
Status
Weergegeven als
Beschrijving
Verzonden
De berichtenservice heeft het bericht verzonden naar de geadresseerde
Afgeleverd
De ontvanger van het bericht heeft het bericht ontvangen
Read
De geadresseerde van het bericht leest het bericht
Mislukt
Het bericht kan niet correct worden verzonden
Voorbeelden
Update voor berichtbezorging
[{
"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 voor berichtbezorging met fout
[{
"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) gebeurtenis
Gepubliceerd wanneer Communication Service een AI-analyse met een klantbericht voltooit.
Voorbeeldscenario: Een WhatsApp-gebruiker verzendt een bericht naar een WhatsApp-bedrijfsnummer dat is verbonden met een actief Advanced Messaging-kanaal in een Communication Services-resource die is gekozen voor de functie Berichtanalyse. Als gevolg hiervan publiceert het systeem een Microsoft.Communication.AdvancedMessageAnalysisCompleted met de analyse van het WhatsApp-bericht van de gebruiker.
Lijst met kenmerken
Details voor de kenmerken die specifiek zijn voor Microsoft.Communication.AdvancedMessageAnalysisCompleted gebeurtenissen.
Kenmerk
Type
Nullable
Beschrijving
channelType
string✔️
Kanaaltype van het kanaal waarop het bericht is verzonden.
from
string✔️
De kanaal-id die het bericht heeft verzonden, opgemaakt als een GUID.
to
string✔️
Geadresseerde-id waarnaar het bericht is verzonden.
receivedTimestamp
DateTimeOffset✔️
Tijdstempel van het bericht.
originalMessage
string✔️
Het oorspronkelijke gebruikersbericht.
intentAnalysis
string✔️
De intentieanalyse van het ontvangen gebruikersbericht.
languageDetection
LanguageDetection✔️
Bevat de taaldetectie van het ontvangen gebruikersbericht.
extractKeyPhrases
List<string>✔️
Bevat de sleuteltermen van het ontvangen gebruikersbericht.
LanguageDetection
Kenmerk
Type
Nullable
Beschrijving
language
string✔️
De gedetecteerde taal.
confidenceScore
float✔️
De betrouwbaarheidsscore van de gedetecteerde taal.
vertaling
string✔️
De berichtomzetting.
Voorbeelden
Berichtanalyse voltooid
[{
"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"
}]
Snelstart
Voor een quickstart die laat zien hoe u zich kunt abonneren op Advanced Messaging-gebeurtenissen met webhook, raadpleegt u Quickstart: Geavanceerde berichten-gebeurtenissen verwerken .