@@ -130,3 +130,171 @@ You can only view your survey data if you have enabled a Diagnostic Setting to c
130
130
- Create your own queries in Log Analytics, see: [ Get Started Queries] ( ../../../../articles/azure-monitor/logs/get-started-queries.md )
131
131
132
132
133
+
134
+
135
+
136
+
137
+ Functionality described in this document is currently in public preview.
138
+ This preview version is provided without a service-level agreement, and
139
+ we don't recommend it for production workloads. Certain features might
140
+ not be supported or might have constrained capabilities. For more
141
+ information, see [ ** Supplemental Terms of Use for Microsoft Azure
142
+ Previews** ] ( https://azure.microsoft.com/support/legal/preview-supplemental-terms/ ) .
143
+
144
+ ** Note**
145
+
146
+ End of Call Survey is currently supported only for our JavaScript / Web
147
+ SDK.
148
+
149
+ The End of Call Survey provides you with a tool to understand how your
150
+ end users perceive the overall quality and reliability of your
151
+ JavaScript / Web SDK calling solution.
152
+
153
+ ## ** Purpose of the End of Call Survey**
154
+
155
+ It’s difficult to determine a customer’s perceived calling experience
156
+ and determine how well your calling solution is performing without
157
+ gathering subjective feedback from customers.
158
+
159
+ You can use the End of Call Survey to collect and analyze customers
160
+ ** subjective** opinions on their calling experience as opposed to
161
+ relying only on ** objective** measurements such as audio and video
162
+ bitrate, jitter, and latency, which may not indicate if a customer had a
163
+ poor calling experience. After publishing survey data, you can view the
164
+ survey results through Azure for analysis and improvements. Azure
165
+ Communication Services uses these survey results to monitor and improve
166
+ quality and reliability.
167
+
168
+ ## ** Survey Structure**
169
+
170
+ The survey is designed to answer two questions from a user’s point of
171
+ view.
172
+
173
+ - ** Question 1:** How did the users perceive their overall call quality
174
+ experience?
175
+
176
+ - ** Question 2:** Did the user perceive any Audio, Video, or Screen
177
+ Share issues in the call?
178
+
179
+ The API allows applications to gather data points that describe user
180
+ perceived ratings of their Overall Call, Audio, Video, and Screen Share
181
+ experiences. Microsoft analyzes survey API results according to the
182
+ following goals.
183
+
184
+ ### ** End of Call Survey API Goals**
185
+
186
+ <table >
187
+ <colgroup >
188
+ <col style =" width : 64% " />
189
+ <col style =" width : 35% " />
190
+ </colgroup >
191
+ <thead >
192
+ <tr class =" header " >
193
+ <th ><strong >API Rating Categories</strong ></th >
194
+ <th ><strong >Question Goal</strong ></th >
195
+ </tr >
196
+ </thead >
197
+ <tbody >
198
+ <tr class =" odd " >
199
+ <td ><ol type =" 1 " >
200
+ <li ><p >Overall Call</p ></li >
201
+ </ol ></td >
202
+ <td >Responses indicate how a call participant perceived their
203
+ <strong >overall</strong > call quality.</td >
204
+ </tr >
205
+ <tr class =" even " >
206
+ <td ><ol start =" 2 " type =" 1 " >
207
+ <li ><p >Audio</p ></li >
208
+ </ol ></td >
209
+ <td >Responses indicate if the user perceived any <strong >Audio</strong >
210
+ issues.</td >
211
+ </tr >
212
+ <tr class =" odd " >
213
+ <td ><ol start =" 3 " type =" 1 " >
214
+ <li ><p >Video</p ></li >
215
+ </ol ></td >
216
+ <td >Responses indicate if the user perceived any <strong >Video</strong >
217
+ issues.</td >
218
+ </tr >
219
+ <tr class =" even " >
220
+ <td ><ol start =" 4 " type =" 1 " >
221
+ <li ><p >Screen Share</p ></li >
222
+ </ol ></td >
223
+ <td >Responses indicate if the user perceived any <strong >Screen
224
+ Share</strong > issues.</td >
225
+ </tr >
226
+ </tbody >
227
+ </table >
228
+
229
+ ##
230
+
231
+ ## ** Survey Capabilities**
232
+
233
+ ### ** Default survey API configuration**
234
+
235
+ | ** API Rating Categories** | ** Cutoff Value\* ** | ** Input Range** | ** Comments** |
236
+ | ---------------------------| --------------------| -----------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
237
+ | Overall Call | 2 | 1 - 5 | Survey’s a calling participant’s overall quality experience on a scale of 1-5 where 1 indicates an imperfect call experience and 5 indicates a perfect call. The cutoff value of 2 means that a customer response of 1 or 2 indicates a less than perfect call experience. |
238
+ | Audio | 2 | 1 – 5 | A response of 1 indicates an imperfect audio experience and 5 indicates no audio issues were experienced. |
239
+ | Video | 2 | 1 – 5 | A response of 1 indicates an imperfect video experience and 5 indicates no video issues were experienced. |
240
+ | Screenshare | 2 | 1 – 5 | A response of 1 indicates an imperfect screen share experience and 5 indicates no screen share issues were experienced. |
241
+
242
+ - \* ** Note:** A question’s indicated cutoff value in the API is the
243
+ threshold that Microsoft uses when analyzing your survey data. When
244
+ you customize the cutoff value or Input Range, Microsoft analyzes your
245
+ survey data according to your customization.
246
+
247
+ ### ** Additional survey tags**
248
+
249
+ | ** Rating Categories** | ** Optional Tags** |
250
+ | -----------------------| -----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
251
+ | Overall Call | 'CallCannotJoin' \| 'CallCannotInvite' \| 'HadToRejoin' \| 'CallEndedUnexpectedly' \| 'OtherIssues' |
252
+ | Audio | 'NoLocalAudio' \| 'NoRemoteAudio' \| 'Echo' \| 'AudioNoise' \| 'LowVolume' \| 'AudioStoppedUnexpectedly' \| 'DistortedSpeech' \| 'AudioInterruption' \| 'OtherIssues' |
253
+ | Video | 'NoVideoReceived' \| 'NoVideoSent' \| 'LowQuality' \| 'Freezes' \| 'StoppedUnexpectedly' \| 'DarkVideoReceived' \| 'AudioVideoOutOfSync' \| 'OtherIssues' |
254
+ | Screenshare | 'NoContentLocal' \| 'NoContentRemote' \| 'CannotPresent' \| 'LowQuality' \| 'Freezes' \| 'StoppedUnexpectedly' \| 'LargeDelay' \| 'OtherIssues' |
255
+
256
+ ### ** End of Call Survey Customization**
257
+
258
+ You can choose to collect each of the four API values or only the ones
259
+ you find most important. For example, you can choose to only ask
260
+ customers about their overall call experience instead of asking them
261
+ about their audio, video, and screen share experience. You can also
262
+ customize input ranges to suit your needs. The default input range is 1
263
+ to 5 for Overall Call, <span class =" mark " >Audio</span >, Video, and
264
+ Screenshare. However, each API value can be customized from a minimum of
265
+ 0 to maximum of 100.
266
+
267
+ ### ** Customization options**
268
+
269
+ | ** API Rating Categories** | ** Cutoff Value\* ** | ** Input Range** |
270
+ | ---------------------------| --------------------| -----------------|
271
+ | Overall Call | 0 - 100 | 0 – 100 |
272
+ | Audio | 0 - 100 | 0 – 100 |
273
+ | Video | 0 - 100 | 0 – 100 |
274
+ | Screenshare | 0 - 100 | 0 - 100 |
275
+
276
+ - \* ** Note** : A question’s indicated cutoff value in the API is the
277
+ threshold that Microsoft uses when analyzing your survey data. When
278
+ you customize the cutoff value or Input Range, Microsoft analyzes your
279
+ survey data according to your customization.
280
+
281
+ ## ** Store and view survey data:**
282
+
283
+ ** Important**
284
+
285
+ You must enable a Diagnostic Setting in Azure Monitor to send the log
286
+ data of your surveys to a Log Analytics workspace, Event Hubs, or an
287
+ Azure storage account to receive and analyze your survey data. If you do
288
+ not send survey data to one of these options your survey data will not
289
+ be stored and will be lost. To enable these logs for your Communications
290
+ Services, see: ** Enable logging in Diagnostic Settings**
291
+
292
+ You can only view your survey data if you have enabled a Diagnostic
293
+ Setting to capture your survey data. <span class =" mark " >To learn how to
294
+ use the End of Call Survey and view your survey data, see: ** <u >Tutorial
295
+ Link</u >** </span >
296
+
297
+ ## ** Next Steps**
298
+
299
+ - Create your own queries in Log Analytics, see: [ Get Started
300
+ Queries] ( https://review.learn.microsoft.com/en-us/azure/azure-monitor/logs/get-started-queries )
0 commit comments