Sdílet prostřednictvím


Azure Communication Services – Rozšířené události zasílání zpráv

Tento článek obsahuje vlastnosti a schéma pro události rozšířeného zasílání zpráv komunikačních služeb. Úvod do schémat událostí najdete ve schématu událostí služby Azure Event Grid.

Typy událostí

Služba Azure Communication Services generuje následující typy událostí rozšířeného zasílání zpráv:

Typ události Popis
Microsoft.Communication.AdvancedMessageReceived Publikováno, když rozšířené zasílání zpráv komunikačních služeb obdrží zprávu.
Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated Publikováno, když rozšířené zasílání zpráv komunikačních služeb obdrží aktualizaci stavu pro dříve odeslané oznámení zprávy.
Microsoft.Communication.AdvancedMessageAnalysisCompleted(Preview) Publikuje se po dokončení analýzy umělé inteligence se zprávou zákazníka.

Odpovědi na události

Když se událost aktivuje, služba Event Grid odešle data o této události do odběru koncových bodů.

Tato část obsahuje příklad toho, jak tato data vypadají pro každou událost.

Událost Microsoft.Communication.AdvancedMessageReceived

Publikováno, když rozšířené zasílání zpráv komunikačních služeb obdrží zprávu.

Ukázkový scénář: Uživatel WhatsApp odešle zprávu WhatsAppu na číslo WhatsApp Business, které je připojené k aktivnímu kanálu rozšířeného zasílání zpráv v prostředku Komunikační služby. V důsledku toho Microsoft.Communication.AdvancedMessageReceived se publikuje obsah zprávy WhatsApp uživatele.

Seznam atributů

Podrobnosti o atributech specifických pro Microsoft.Communication.AdvancedMessageReceived události

Atribut Typ S možnou hodnotou Null Popis
channelType string Typ kanálu, na který byla zpráva odeslána. Například: "whatsapp".
messageId string ID zprávy přijímá událost jako IDENTIFIKÁTOR GUID.
messageType string Typ zprávy události přijetí zprávy. Například: "interactive", "sticker", "reaction".
from string ID odesílatele, které zprávu odeslalo.
na string ID kanálu, které zprávu obdrželo, je formátované jako identifikátor GUID.
receivedTimestamp DateTimeOffset Časové razítko při přijetí zprávy
content string ✔️ Textový obsah zprávy.
média MediaContent ✔️ Obsahuje podrobnosti o přijatém médiu.
kontext MessageContext ✔️ Obsahuje podrobnosti o kontextu zprávy odpovědi v případě, že uživatel odpoví zpět na obchodní zprávu.
knoflík ButtonContent ✔️ Obsahuje podrobnosti o obsahu tlačítka odpovědi vybraného pro zprávu šablony.
Interaktivní InteractiveContent ✔️ Obsahuje podrobnosti o interaktivní odpovědi na zprávu, jako je buttonReply nebo listReply.
reakce ReactionContent ✔️ Obsahuje podrobnosti o přijaté reakci na obchodní odeslání zprávy.
MediaContent
Atribut Typ S možnou hodnotou Null Popis
mimeType string Typ MIME média. Slouží k určení správného typu souboru pro stahování médií.
ID string ID média. Používá se k načtení média ke stažení ve formátu GUID.
fileName string ✔️ Název souboru podkladového mediálního souboru, jak je uvedeno při nahrání.
titulek string ✔️ Text titulku pro mediální objekt, pokud je podporovaný a zadaný.
animovaný string ✔️ Nastavit na hodnotu true, pokud je nálepka animovaný; jinak nepravda.
MessageContext
Atribut Typ S možnou hodnotou Null Popis
od string ✔️ WhatsApp ID zákazníka, který odpověděl na příchozí zprávu.
ID string ✔️ ID zprávy pro odeslanou zprávu pro příchozí odpověď
ButtonContent
Atribut Typ S možnou hodnotou Null Popis
text string ✔️ Text tlačítka.
payload string ✔️ Datová část, nastavená firmou, tlačítka, které uživatel vybral.
InteractiveContent
Atribut Typ S možnou hodnotou Null Popis
type InteractiveReplyType ✔️ Typ interaktivního obsahu
buttonReply InteractiveButtonReplyContent ✔️ Odesláno, když zákazník vybere tlačítko.
listReply InteractiveListReplyContent ✔️ Odesláno, když zákazník vybere položku ze seznamu.
InteractiveReplyType
Hodnota Popis
buttonReply Interaktivní obsah je tlačítko.
listReply Interaktivní obsah je seznam.
neznámé Interaktivní obsah je neznámý.
InteractiveButtonReplyContent
Atribut Typ S možnou hodnotou Null Popis
ID string ✔️ ID tlačítka.
title string ✔️ Název tlačítka
InteractiveListReplyContent
Atribut Typ S možnou hodnotou Null Popis
ID string ✔️ ID vybrané položky seznamu.
title string ✔️ Název vybrané položky seznamu
description string ✔️ Popis vybraného řádku
ReactionContent
Atribut Typ S možnou hodnotou Null Popis
messageId string ID zprávy, na které uživatel odpoví.
emoji string ✔️ Řetězec představující řídicí sekvenci unicode emoji

Příklady

Přijatá textová zpráva
[{
  "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"
}]
Přijatá zpráva o médiu obrázku
[{
  "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"
}]
Zpráva o přijatém médiu dokumentu
{
  "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"
}
Výpis přijaté zprávy odpovědi pomocí 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"
}]
Zpráva tlačítka Odpovědět přijatá pomocí 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"
}]
Přijatá zpráva s nálepkou odpovědi
[{
  "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"
}]
Přijatá zpráva reakce na odpověď
[{
  "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"
}]
Přijatá zpráva ButtonContent
[{
  "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"
}]

Událost Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated

Publikováno, když rozšířené zasílání zpráv komunikačních služeb obdrží aktualizaci stavu pro dříve odeslané oznámení zprávy.

Ukázkový scénář: Společnost Contoso používá aktivní kanál rozšířeného zasílání zpráv připojený k účtu WhatsApp Business k odeslání zprávy WhatsApp uživateli WhatsApp. WhatsApp pak odpoví na kanál Rozšířené zasílání zpráv společnosti Contoso se stavem dříve odeslané zprávy. V důsledku toho se publikuje událost obsahující Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated stav zprávy.

Seznam atributů

Podrobnosti o atributech specifických pro Microsoft.Communication.AdvancedMessageReceived události

Atribut Typ S možnou hodnotou Null Popis
channelType string Typ kanálu, na který byla zpráva odeslána.
from string ID kanálu, které zprávu odeslalo, je formátované jako identifikátor GUID.
na string ID příjemce, na které byla zpráva odeslána.
receivedTimestamp DateTimeOffset Časové razítko zprávy
messageId string ✔️ ID zprávy formátované jako identifikátor GUID.
stav string ✔️ Stav zprávy Možné hodnoty zahrnují Sent, Delivered, Reada Failed. Další informace naleznete v tématu Stav.
chyba ChannelEventError ✔️ Obsahuje podrobnosti o chybě.
ChannelEventError
Atribut Typ S možnou hodnotou Null Popis
channelCode string ✔️ Kód chyby přijatý v tomto kanálu.
channelMessage string ✔️ V tomto kanálu se zobrazila chybová zpráva.
Stav
Hodnota Popis
Odesláno Služba zasílání zpráv odeslala zprávu příjemci.
Doručení Příjemce zprávy zprávu obdržel.
Čteno Příjemce zprávy zprávu přečetl.
Neúspěšný Zpráva se nepovedla správně odeslat.

Příklady

Aktualizace pro doručování zpráv
[{
  "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"
}]
Aktualizace pro doručování zpráv s chybou
[{
  "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"
}]

Událost Microsoft.Communication.AdvancedMessageAnalysisCompleted(Preview)

Publikuje se po dokončení analýzy umělé inteligence se zprávou zákazníka.

Ukázkový scénář: Uživatel WhatsApp odešle zprávu na WhatsApp Business Number připojené k aktivnímu kanálu rozšířeného zasílání zpráv v prostředku služby Communication Services, který se přihlásil k funkci Analýza zpráv. V důsledku toho systém publikuje Microsoft.Communication.AdvancedMessageAnalysisCompleted s analýzou zprávy WhatsApp uživatele.

Seznam atributů

Podrobnosti o atributech specifických pro Microsoft.Communication.AdvancedMessageAnalysisCompleted události

Atribut Typ S možnou hodnotou Null Popis
channelType string ✔️ Typ kanálu, na který byla zpráva odeslána.
from string ✔️ ID kanálu, které zprávu odeslalo, je formátované jako identifikátor GUID.
na string ✔️ ID příjemce, na které byla zpráva odeslána.
receivedTimestamp DateTimeOffset ✔️ Časové razítko zprávy
originalMessage string ✔️ Původní zpráva uživatele.
intentAnalysis string ✔️ Analýza záměru přijaté zprávy uživatele
languageDetection LanguageDetection ✔️ Obsahuje rozpoznávání jazyka přijaté zprávy uživatele.
extractedKeyPhrases List<string> ✔️ Obsahuje klíčové fráze přijaté zprávy uživatele.
LanguageDetection
Atribut Typ S možnou hodnotou Null Popis
jazyk string ✔️ Zjistil se jazyk.
confidenceScore float ✔️ Zjistilo se skóre spolehlivosti jazyka.
Překlad string ✔️ Překlad zprávy.

Příklady

Analýza zpráv byla dokončena.
[{
  "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"
}]

Rychlé zprovoznění

Rychlý start, který ukazuje, jak se přihlásit k odběru událostí služby Advanced Messaging pomocí webhooků, najdete v tématu Rychlý start: Zpracování událostí rozšířeného zasílání zpráv.