Dela via


Azure Communication Services – Avancerade meddelandehändelser

Den här artikeln innehåller egenskaper och schema för Händelser med avancerad meddelandefunktion i Communication Services. En introduktion till händelsescheman finns i Händelseschema för Azure Event Grid.

Händelsetyper

Azure Communication Services genererar följande händelsetyper för Advanced Messaging:

Händelsetyp beskrivning
Microsoft.Communication.AdvancedMessageReceived Publicerad när Communication Services Advanced Messaging tar emot ett meddelande.
Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated Publicerad när Communication Services Advanced Messaging tar emot en statusuppdatering för ett meddelande som skickats tidigare.
Microsoft.Communication.AdvancedMessageAnalysisCompleted(förhandsversion) Publicerad när Kommunikationstjänsten slutför en AI-analys med ett kundmeddelande.

Händelsesvar

När en händelse utlöses skickar Event Grid-tjänsten data om händelsen till prenumererande slutpunkter.

Det här avsnittet innehåller ett exempel på hur dessa data ser ut för varje händelse.

Microsoft.Communication.AdvancedMessageReceived-händelse

Publicerad när Communication Services Advanced Messaging tar emot ett meddelande.

Exempelscenario: En WhatsApp-användare skickar ett WhatsApp-meddelande till ett WhatsApp Business Number som är anslutet till en aktiv avancerad meddelandekanal i en Communication Services-resurs. Därför publiceras en Microsoft.Communication.AdvancedMessageReceived med innehållet i användarens WhatsApp-meddelande.

Attributlista

Information om attribut som är specifika för Microsoft.Communication.AdvancedMessageReceived händelser.

Attribut Typ Kan ha värdet null beskrivning
channelType string Kanaltyp för kanalen som meddelandet skickades på. Exempel: "whatsapp".
messageId string Meddelande-ID för meddelandet tar emot händelsen som GUID.
messageType string Meddelandetyp för meddelandets mottagningshändelse. Till exempel: "interactive", "sticker", "reaction".
from string Avsändar-ID som skickade meddelandet.
to string Kanal-ID:t som tog emot meddelandet, formaterat som ett GUID.
receivedTimestamp DateTimeOffset Tidsstämpel när meddelandet tas emot.
innehåll string ✔️ Textinnehållet i meddelandet.
media MediaContent ✔️ Innehåller information om det mottagna mediet.
sammanhang MessageContext ✔️ Innehåller information om svarsmeddelandekontexten om användaren svarar på affärsmeddelandet igen.
knapp ButtonContent ✔️ Innehåller information om den innehållsanvändare för svarsknappen som valts för mallmeddelandet.
interaktiv InteractiveContent ✔️ Innehåller information om interaktivt meddelandesvar som buttonReply eller listReply
reaktion ReactionContent ✔️ Innehåller information om den mottagna reaktionen över företagets sändningsmeddelande.
MediaContent
Attribut Typ Kan ha värdet null beskrivning
mimeType string MIME-typ av media. Används för att fastställa rätt filtyp för medienedladdningar.
ID string Medie-ID. Används för att hämta media för nedladdning, formaterat som ett GUID.
fileName string ✔️ Filnamnet för den underliggande mediefilen som anges när den laddas upp.
bildtext string ✔️ Texttext för medieobjektet, om det stöds och tillhandahålls.
animerad string ✔️ Ställ in på sant om klistermärket är animerat; annars falskt.
MessageContext
Attribut Typ Kan ha värdet null beskrivning
från string ✔️ WhatsApp-ID:t för kunden som svarade på ett inkommande meddelande.
ID string ✔️ Meddelande-ID:t för det skickade meddelandet för ett inkommande svar.
ButtonContent
Attribut Typ Kan ha värdet null Beskrivning
text string ✔️ Knappens text.
payload string ✔️ Nyttolasten, som har konfigurerats av företaget, för knappen som användaren har valt.
InteractiveContent
Attribut Typ Kan ha värdet null beskrivning
type InteractiveReplyType ✔️ Typ av interaktivt innehåll.
buttonReply InteractiveButtonReplyContent ✔️ Skickas när en kund väljer en knapp.
listReply InteractiveListReplyContent ✔️ Skickas när en kund väljer ett objekt från en lista.
InteractiveReplyType
Värde beskrivning
buttonReply Det interaktiva innehållet är en knapp.
listReply Det interaktiva innehållet är en lista.
okänd Det interaktiva innehållet är okänt.
InteractiveButtonReplyContent
Attribut Typ Kan ha värdet null beskrivning
ID string ✔️ ID för knappen.
rubrik string ✔️ Knappens rubrik.
InteractiveListReplyContent
Attribut Typ Kan ha värdet null beskrivning
ID string ✔️ ID för det markerade listobjektet.
rubrik string ✔️ Rubrik för det markerade listobjektet.
description string ✔️ Beskrivning av den markerade raden.
ReactionContent
Attribut Typ Kan ha värdet null beskrivning
messageId string Meddelande-ID som användaren svarar på.
emoji string ✔️ Sträng som representerar unicode escape-sekvensen för emojin.

Exempel

Sms mottaget
[{
  "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"
}]
Mottaget bildmediemeddelande
[{
  "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"
}]
Mottaget dokumentmediemeddelande
{
  "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"
}
Lista svarsmeddelande som tagits emot med 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"
}]
Svarsknappmeddelande mottaget med 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"
}]
Svarsdekalmeddelande mottaget
[{
  "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"
}]
Svarssvarsmeddelande mottaget
[{
  "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-meddelande har tagits emot
[{
  "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-händelse

Publicerad när Communication Services Advanced Messaging tar emot en statusuppdatering för ett meddelande som skickats tidigare.

Exempelscenario: Contoso använder en aktiv advanced messaging-kanal som är ansluten till ett WhatsApp Business-konto för att skicka ett WhatsApp-meddelande till en WhatsApp-användare. WhatsApp svarar sedan på Contosos advanced messaging-kanal med statusen för det tidigare skickade meddelandet. Därför publiceras en Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated händelse som innehåller meddelandestatusen.

Attributlista

Information om attribut som är specifika för Microsoft.Communication.AdvancedMessageReceived händelser.

Attribut Typ Kan ha värdet null beskrivning
channelType string Kanaltyp för kanalen som meddelandet skickades på.
from string Kanal-ID:t som skickade meddelandet, formaterat som ett GUID.
to string Mottagar-ID som meddelandet skickades till.
receivedTimestamp DateTimeOffset Tidsstämpel för meddelandet.
messageId string ✔️ ID:t för meddelandet, formaterat som ett GUID.
status string ✔️ Status för meddelandet. Möjliga värden är Sent, Delivered, Readoch Failed. Mer information finns i Status.
fel ChannelEventError ✔️ Innehåller information om ett fel.
ChannelEventError
Attribut Typ Kan ha värdet null beskrivning
channelCode string ✔️ Felkoden som togs emot på den här kanalen.
channelMessage string ✔️ Felmeddelandet som togs emot på den här kanalen.
Status
Värde beskrivning
Har skickats till Meddelandetjänsten skickade meddelandet till mottagaren
Levererat Meddelandemottagaren tog emot meddelandet
Lästa Meddelandemottagaren läste meddelandet
Misslyckad Meddelandet kunde inte skickas korrekt

Exempel

Uppdatering för meddelandeleverans
[{
  "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"
}]
Uppdatering för meddelandeleverans med fel
[{
  "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"
}]

Händelsen Microsoft.Communication.AdvancedMessageAnalysisCompleted(preview)

Publicerad när Kommunikationstjänsten slutför en AI-analys med ett kundmeddelande.

Exempelscenario: En WhatsApp-användare skickar ett meddelande till ett WhatsApp Business Number som är anslutet till en aktiv advanced messaging-kanal i en Communication Services-resurs som valde funktionen Meddelandeanalys. Därför publicerar systemet en Microsoft.Communication.AdvancedMessageAnalysisCompleted med analysen av användarens WhatsApp-meddelande.

Attributlista

Information om attribut som är specifika för Microsoft.Communication.AdvancedMessageAnalysisCompleted händelser.

Attribut Typ Kan ha värdet null beskrivning
channelType string ✔️ Kanaltyp för kanalen som meddelandet skickades på.
from string ✔️ Kanal-ID:t som skickade meddelandet, formaterat som ett GUID.
to string ✔️ Mottagar-ID som meddelandet skickades till.
receivedTimestamp DateTimeOffset ✔️ Tidsstämpel för meddelandet.
originalMessage string ✔️ Det ursprungliga användarmeddelandet.
intentAnalysis string ✔️ Avsiktsanalysen av det mottagna användarmeddelandet.
languageDetection LanguageDetection ✔️ Innehåller språkidentifiering av det mottagna användarmeddelandet.
extractedKeyPhrases List<string> ✔️ Innehåller nyckelfraserna i det mottagna användarmeddelandet.
LanguageDetection
Attribut Typ Kan ha värdet null beskrivning
språk string ✔️ Språket har identifierats.
confidenceScore float ✔️ Konfidenspoängen för det språk som identifierats.
översättning string ✔️ Meddelandeöversättningen.

Exempel

Meddelandeanalysen har slutförts
[{
  "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"
}]

Snabbstart

En snabbstart som visar hur du prenumererar på avancerade meddelandehändelser med hjälp av webbkrokar finns i Snabbstart: Hantera avancerade meddelandehändelser.