Azure Communication Services - Peristiwa Olahpesan Tingkat Lanjut
Artikel ini menyediakan properti dan skema untuk peristiwa Olahpesan Tingkat Lanjut Communication Services. Untuk pengantar skema peristiwa, lihat Skema peristiwa Azure Event Grid.
Tipe peristiwa
Azure Communication Services memancarkan jenis peristiwa Pesan Tingkat Lanjut berikut:
| Jenis peristiwa | Deskripsi |
|---|---|
| Microsoft.Communication.AdvancedMessageReceived | Diterbitkan saat Pesan Tingkat Lanjut Communication Services menerima pesan. |
| Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated | Diterbitkan saat Pesan Tingkat Lanjut Communication Services menerima pembaruan status untuk pemberitahuan pesan yang dikirim sebelumnya. |
| Microsoft.Communication.AdvancedMessageAnalysisCompleted(Pratinjau) | Diterbitkan saat Communication Service menyelesaikan Analisis AI dengan pesan pelanggan. |
Tanggapan peristiwa
Ketika suatu peristiwa dipicu, layanan Event Grid akan mengirim data tentang peristiwa itu ke titik akhir.
Bagian ini berisi contoh tampilan data tersebut untuk setiap kejadian.
Peristiwa Microsoft.Communication.AdvancedMessageReceived
Diterbitkan saat Pesan Tingkat Lanjut Communication Services menerima pesan.
Contoh skenario: Pengguna WhatsApp mengirim pesan WhatsApp ke Nomor WhatsApp Business yang tersambung ke saluran Pesan Tingkat Lanjut aktif di sumber daya Communication Services. Akibatnya, Microsoft.Communication.AdvancedMessageReceived dengan konten pesan WhatsApp pengguna diterbitkan.
Daftar atribut
Detail untuk atribut khusus untuk Microsoft.Communication.AdvancedMessageReceived peristiwa.
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| channelType | string |
✔️ | Jenis saluran saluran tempat pesan dikirim. Mis. "whatsapp". |
| dari | string |
✔️ | ID pengirim yang mengirim pesan. |
| ke | string |
✔️ | ID saluran yang menerima pesan, diformat sebagai GUID. |
| receivedTimestamp | DateTimeOffset |
✔️ | Tanda waktu pesan. |
| konten | string |
✔️ | Konten teks dalam pesan. |
| media | MediaContent |
✔️ | Berisi detail tentang media yang diterima. |
| context | MessageContext |
✔️ | Berisi detail tentang media yang diterima. |
| + | ButtonContent |
✔️ | Berisi detail tentang media yang diterima. |
| interactive | InteractiveContent |
✔️ | Berisi detail tentang media yang diterima. |
MediaContent
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| mimeType | string |
❌ | Jenis MIME media. Digunakan untuk menentukan tipe file yang benar untuk unduhan media. |
| id | string |
❌ | ID Media. Digunakan untuk mengambil media untuk diunduh, diformat sebagai GUID. |
| fileName | string |
✔️ | Nama file file media yang mendasar seperti yang ditentukan saat diunggah. |
| Caption | string |
✔️ | Teks keterangan untuk objek media, jika didukung dan disediakan. |
MessageContext
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| dari | string |
✔️ | ID WhatsApp untuk pelanggan yang membalas pesan masuk. |
| id | string |
✔️ | ID pesan untuk pesan terkirim untuk balasan masuk. |
ButtonContent
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| text | string |
✔️ | Teks tombol . |
| payload | string |
✔️ | Payload, disiapkan oleh bisnis, dari tombol yang dipilih pengguna. |
InteractiveContent
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| jenis | InteractiveReplyType |
✔️ | Jenis konten interaktif. |
| buttonReply | InteractiveButtonReplyContent |
✔️ | Dikirim saat pelanggan memilih tombol. |
| listReply | InteractiveListReplyContent |
✔️ | Dikirim saat pelanggan memilih item dari daftar. |
InteractiveReplyType
| Nilai | Deskripsi |
|---|---|
| buttonReply | Konten interaktif adalah tombol. |
| listReply | Konten interaktif adalah daftar. |
| unknown | Konten interaktif tidak diketahui. |
InteractiveButtonReplyContent
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| id | string |
✔️ | ID tombol. |
| title | string |
✔️ | Judul tombol. |
InteractiveListReplyContent
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| id | string |
✔️ | ID item daftar terpilih. |
| title | string |
✔️ | Judul item daftar terpilih. |
| description | string |
✔️ | Deskripsi baris yang dipilih. |
Contoh
Pesan teks diterima
[{
"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"
}]
Pesan media diterima
[{
"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"
}]
Peristiwa Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated
Diterbitkan saat Pesan Tingkat Lanjut Communication Services menerima pembaruan status untuk pemberitahuan pesan yang dikirim sebelumnya.
Contoh skenario: Contoso menggunakan saluran Pesan Tingkat Lanjut aktif yang terhubung ke Akun WhatsApp Business untuk mengirim pesan WhatsApp ke pengguna WhatsApp. WhatsApp kemudian membalas saluran Pesan Tingkat Lanjut Contoso dengan status pesan yang dikirim sebelumnya. Akibatnya, peristiwa yang Microsoft.Communication.AdvancedMessageDeliveryStatusUpdated berisi status pesan diterbitkan.
Daftar atribut
Detail untuk atribut khusus untuk Microsoft.Communication.AdvancedMessageReceived peristiwa.
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| channelType | string |
✔️ | Jenis saluran saluran tempat pesan dikirim. |
| dari | string |
✔️ | ID saluran yang mengirim pesan, diformat sebagai GUID. |
| ke | string |
✔️ | ID penerima tempat pesan dikirim. |
| receivedTimestamp | DateTimeOffset |
✔️ | Tanda waktu pesan. |
| messageId | string |
✔️ | ID pesan, diformat sebagai GUID. |
| status | string |
✔️ | Status pesan. Nilai yang mungkin antara lain Sent, Delivered, Read, dan Failed. Untuk informasi selengkapnya, lihat Status. |
| kesalahan | ChannelEventError |
✔️ | Berisi detail kesalahan. |
ChannelEventError
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| channelCode | string |
✔️ | Kode kesalahan yang diterima pada saluran ini. |
| channelMessage | string |
✔️ | Pesan kesalahan yang diterima pada saluran ini. |
Status
| Nilai | Deskripsi |
|---|---|
| Terkirim | Layanan olahpesan mengirim pesan ke penerima |
| Dikirim | Penerima pesan menerima pesan |
| Read | Penerima pesan membaca pesan |
| Gagal | Pesan gagal dikirim dengan benar |
Contoh
Pembaruan untuk pengiriman pesan
[{
"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"
}]
Pembaruan untuk pengiriman pesan dengan kegagalan
[{
"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"
}]
Peristiwa Microsoft.Communication.AdvancedMessageAnalysisCompleted(Pratinjau)
Diterbitkan saat Communication Service menyelesaikan Analisis AI dengan pesan pelanggan.
Contoh skenario: Pengguna WhatsApp mengirim pesan WhatsApp ke Nomor WhatsApp Business yang tersambung ke saluran Pesan Tingkat Lanjut aktif di sumber daya Communication Services yang telah memilih untuk fitur Analisis Pesan. Akibatnya, Microsoft.Communication.AdvancedMessageAnalysisCompleted dengan analisis pesan WhatsApp pengguna diterbitkan.
Daftar atribut
Detail untuk atribut khusus untuk Microsoft.Communication.AdvancedMessageAnalysisCompleted peristiwa.
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| channelType | string |
✔️ | Jenis saluran saluran tempat pesan dikirim. |
| dari | string |
✔️ | ID saluran yang mengirim pesan, diformat sebagai GUID. |
| ke | string |
✔️ | ID penerima tempat pesan dikirim. |
| receivedTimestamp | DateTimeOffset |
✔️ | Tanda waktu pesan. |
| originalMessage | string |
✔️ | Pesan pengguna asli. |
| intentAnalysis | string |
✔️ | Analisis niat pesan pengguna yang diterima. |
| languageDetection | LanguageDetection |
✔️ | Berisi deteksi bahasa pesan pengguna yang diterima. |
| extractedKeyPhrases | List<string> |
✔️ | Berisi frasa kunci pesan pengguna yang diterima. |
LanguageDetection
| Atribut | Jenis | Dapat diubah ke null | Deskripsi |
|---|---|---|---|
| bahasa | string |
✔️ | Languege terdeteksi. |
| confidenceScore | float |
✔️ | Skor keyakinan bahasa terdeteksi. |
| terjemahan | string |
✔️ | Terjemahan pesan. |
Contoh
Analisis Pesan Selesai
[{
"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"
}]
Mulai Cepat
Untuk mulai cepat yang memperlihatkan cara berlangganan peristiwa Olahpesan Tingkat Lanjut menggunakan web hook, lihat Mulai Cepat: Menangani peristiwa Olahpesan Tingkat Lanjut.