Skip to content

Commit f7dbaf6

Browse files
Merge pull request #182405 from LaithRodan/master
Update communication-services-voice-video-events.md
2 parents b4e8cdc + 2a6b230 commit f7dbaf6

File tree

1 file changed

+148
-0
lines changed

1 file changed

+148
-0
lines changed

articles/event-grid/communication-services-voice-video-events.md

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ Azure Communication Services emits the following voice and video calling event t
1717
| Event type | Description |
1818
| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
1919
| Microsoft.Communication.RecordingFileStatusUpdated | Published when recording file is available |
20+
| Microsoft.Communication.CallStarted | Published when call is started |
21+
| Microsoft.Communication.CallEnded | Published when call is ended |
22+
| Microsoft.Communication.CallParticipantAdded | Published when participant is added |
23+
| Microsoft.Communication.CallParticipantRemoved | Published when participant is removed |
2024

2125
## Event responses
2226

@@ -58,3 +62,147 @@ This section contains an example of what that data would look like for each even
5862
}
5963
]
6064
```
65+
66+
### Microsoft.Communication.CallStarted
67+
68+
```json
69+
[
70+
{
71+
"id": "a8bcd8a3-12d7-46ba-8cde-f6d0bda8feeb",
72+
"topic": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
73+
"subject": "call/{serverCallId}/startedBy/8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1",
74+
"data": {
75+
"startedBy": {
76+
"rawId": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1",
77+
"communicationUser": {
78+
"id": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1"
79+
}
80+
},
81+
"serverCallId": "{serverCallId}",
82+
"group": {
83+
"id": "00000000-0000-0000-0000-000000000000"
84+
},
85+
"isTwoParty": true
86+
},
87+
"eventType": "Microsoft.Communication.CallStarted",
88+
"dataVersion": "1.0",
89+
"metadataVersion": "1",
90+
"eventTime": "2021-09-22T17:02:38.6905856Z"
91+
}
92+
]
93+
```
94+
95+
### Microsoft.Communication.CallEnded
96+
97+
```json
98+
[
99+
{
100+
"id": "530183db-987b-4a3a-b6c1-3391bab12864",
101+
"topic": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
102+
"subject": "call/{serverCallId}",
103+
"data": {
104+
"durationOfCall": 49.728617199999995,
105+
"startedBy": {
106+
"rawId": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1",
107+
"communicationUser": {
108+
"id": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1"
109+
}
110+
},
111+
"serverCallId": "{serverCallId}",
112+
"group": {
113+
"id": "00000000-0000-0000-0000-000000000000"
114+
},
115+
"isTwoParty": true
116+
},
117+
"eventType": "Microsoft.Communication.CallEnded",
118+
"dataVersion": "1.0",
119+
"metadataVersion": "1",
120+
"eventTime": "2021-09-22T17:03:12.6143005Z"
121+
}
122+
123+
]
124+
```
125+
126+
### Microsoft.Communication.CallParticipantAdded
127+
128+
```json
129+
[
130+
{
131+
"id": "615adcbd-23b2-4563-aba7-9d1b424d3d38",
132+
"topic": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
133+
"subject": "call/{serverCallId}/participant/8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1",
134+
"data": {
135+
"user": {
136+
"rawId": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1",
137+
"communicationUser": {
138+
"id": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1"
139+
}
140+
},
141+
"displayName": "Sharif Edge",
142+
"participantId": "041e3b8a-1cce-4ebf-b587-131312c39410",
143+
"endpointType": "acs-web-test-client-ACSWeb(3617/1.0.0.0/os=windows; browser=chrome; browserVer=93.0; deviceType=Desktop)/TsCallingVersion=_TS_BUILD_VERSION_/Ovb=_TS_OVB_VERSION_",
144+
"startedBy": {
145+
"rawId": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1",
146+
"communicationUser": {
147+
"id": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1"
148+
}
149+
},
150+
"serverCallId": "{serverCallId}",
151+
"group": {
152+
"id": "00000000-0000-0000-0000-000000000000"
153+
},
154+
"isTwoParty": true
155+
},
156+
"eventType": "Microsoft.Communication.CallParticipantAdded",
157+
"dataVersion": "1.0",
158+
"metadataVersion": "1",
159+
"eventTime": "2021-09-22T17:02:39.2843314Z"
160+
}
161+
]
162+
```
163+
### Microsoft.Communication.CallParticipantRemoved
164+
165+
```json
166+
[
167+
{
168+
"id": "7b2307f3-57ec-4257-85a1-8ce654534ea9",
169+
"topic": "/subscriptions/{subscription-id}/resourcegroups/{group-name}/providers/microsoft.communication/communicationservices/{communication-services-resource-name}",
170+
"subject": "call/aHR0cHM6Ly9jb252LWRldi0yMS5jb252LWRldi5za3lwZS5uZXQ6NDQzL2NvbnYvbVQ4NnVfempBMG05QVM4VnRvSWFrdz9pPTAmZT02Mzc2Nzc3MTc2MDAwMjgyMzA/participant/8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-27cc-07fd-0848220077d8",
171+
"data": {
172+
"user": {
173+
"rawId": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-27cc-07fd-0848220077d8",
174+
"communicationUser": {
175+
"id": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-27cc-07fd-0848220077d8"
176+
}
177+
},
178+
"displayName": "Sharif Chrome",
179+
"participantId": "750a1442-3156-4914-94d2-62cf73796833",
180+
"endpointType": "acs-web-test-client-ACSWeb(3617/1.0.0.0/os=windows; browser=chrome; browserVer=93.0; deviceType=Desktop)/TsCallingVersion=_TS_BUILD_VERSION_/Ovb=_TS_OVB_VERSION_",
181+
"startedBy": {
182+
"rawId": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1",
183+
"communicationUser": {
184+
"id": "8:acs:bc360ba8-d29b-4ef2-b698-769ebef85521_0000000c-1fb9-4878-07fd-0848220077e1"
185+
}
186+
},
187+
"serverCallId": "aHR0cHM6Ly9jb252LWRldi0yMS5jb252LWRldi5za3lwZS5uZXQ6NDQzL2NvbnYvbVQ4NnVfempBMG05QVM4VnRvSWFrdz9pPTAmZT02Mzc2Nzc3MTc2MDAwMjgyMzA",
188+
"group": {
189+
"id": "00000000-0000-0000-0000-000000000000"
190+
},
191+
"isTwoParty": false
192+
},
193+
"eventType": "Microsoft.Communication.CallParticipantRemoved",
194+
"dataVersion": "1.0",
195+
"metadataVersion": "1",
196+
"eventTime": "2021-09-22T17:28:41.1497652Z"
197+
}
198+
]
199+
```
200+
201+
## Limitations
202+
Calling events are only available for ACS VoIP users. PSTN, bots, echo bot and Teams users events are excluded.
203+
No calling events will be available for ACS - Teams meeting interop call.
204+
205+
206+
207+
208+

0 commit comments

Comments
 (0)