@@ -131,7 +131,7 @@ You can only view your survey data if you have enabled a Diagnostic Setting to c
131
131
132
132
133
133
134
-
134
+ markdown github-flavored markdown
135
135
136
136
137
137
Functionality described in this document is currently in public preview.
@@ -298,3 +298,280 @@ Link</u>**</span>
298
298
299
299
- Create your own queries in Log Analytics, see: [ Get Started
300
300
Queries] ( https://review.learn.microsoft.com/en-us/azure/azure-monitor/logs/get-started-queries )
301
+
302
+
303
+
304
+
305
+ markdown - strict
306
+
307
+
308
+
309
+ ** Important**
310
+
311
+ Functionality described in this document is currently in public preview.
312
+ This preview version is provided without a service-level agreement, and
313
+ we don't recommend it for production workloads. Certain features might
314
+ not be supported or might have constrained capabilities. For more
315
+ information, see [ ** Supplemental Terms of Use for Microsoft Azure
316
+ Previews** ] ( https://azure.microsoft.com/support/legal/preview-supplemental-terms/ ) .
317
+
318
+ ** Note**
319
+
320
+ End of Call Survey is currently supported only for our JavaScript / Web
321
+ SDK.
322
+
323
+ The End of Call Survey provides you with a tool to understand how your
324
+ end users perceive the overall quality and reliability of your
325
+ JavaScript / Web SDK calling solution.
326
+
327
+ ## ** Purpose of the End of Call Survey**
328
+
329
+ It’s difficult to determine a customer’s perceived calling experience
330
+ and determine how well your calling solution is performing without
331
+ gathering subjective feedback from customers.
332
+
333
+ You can use the End of Call Survey to collect and analyze customers
334
+ ** subjective** opinions on their calling experience as opposed to
335
+ relying only on ** objective** measurements such as audio and video
336
+ bitrate, jitter, and latency, which may not indicate if a customer had a
337
+ poor calling experience. After publishing survey data, you can view the
338
+ survey results through Azure for analysis and improvements. Azure
339
+ Communication Services uses these survey results to monitor and improve
340
+ quality and reliability.
341
+
342
+ ## ** Survey Structure**
343
+
344
+ The survey is designed to answer two questions from a user’s point of
345
+ view.
346
+
347
+ - ** Question 1:** How did the users perceive their overall call
348
+ quality experience?
349
+
350
+ - ** Question 2:** Did the user perceive any Audio, Video, or Screen
351
+ Share issues in the call?
352
+
353
+ The API allows applications to gather data points that describe user
354
+ perceived ratings of their Overall Call, Audio, Video, and Screen Share
355
+ experiences. Microsoft analyzes survey API results according to the
356
+ following goals.
357
+
358
+ ### ** End of Call Survey API Goals**
359
+
360
+ <table >
361
+ <colgroup >
362
+ <col style =" width : 64% " />
363
+ <col style =" width : 35% " />
364
+ </colgroup >
365
+ <thead >
366
+ <tr class =" header " >
367
+ <th ><strong >API Rating Categories</strong ></th >
368
+ <th ><strong >Question Goal</strong ></th >
369
+ </tr >
370
+ </thead >
371
+ <tbody >
372
+ <tr class =" odd " >
373
+ <td ><ol type =" 1 " >
374
+ <li ><p >Overall Call</p ></li >
375
+ </ol ></td >
376
+ <td >Responses indicate how a call participant perceived their
377
+ <strong >overall</strong > call quality.</td >
378
+ </tr >
379
+ <tr class =" even " >
380
+ <td ><ol start =" 2 " type =" 1 " >
381
+ <li ><p >Audio</p ></li >
382
+ </ol ></td >
383
+ <td >Responses indicate if the user perceived any <strong >Audio</strong >
384
+ issues.</td >
385
+ </tr >
386
+ <tr class =" odd " >
387
+ <td ><ol start =" 3 " type =" 1 " >
388
+ <li ><p >Video</p ></li >
389
+ </ol ></td >
390
+ <td >Responses indicate if the user perceived any <strong >Video</strong >
391
+ issues.</td >
392
+ </tr >
393
+ <tr class =" even " >
394
+ <td ><ol start =" 4 " type =" 1 " >
395
+ <li ><p >Screen Share</p ></li >
396
+ </ol ></td >
397
+ <td >Responses indicate if the user perceived any <strong >Screen
398
+ Share</strong > issues.</td >
399
+ </tr >
400
+ </tbody >
401
+ </table >
402
+
403
+ ##
404
+
405
+ ## ** Survey Capabilities**
406
+
407
+ ### ** Default survey API configuration**
408
+
409
+ <table >
410
+ <colgroup >
411
+ <col style =" width : 20% " />
412
+ <col style =" width : 11% " />
413
+ <col style =" width : 12% " />
414
+ <col style =" width : 55% " />
415
+ </colgroup >
416
+ <thead >
417
+ <tr class =" header " >
418
+ <th ><strong >API Rating Categories</strong ></th >
419
+ <th ><strong >Cutoff Value*</strong ></th >
420
+ <th ><strong >Input Range</strong ></th >
421
+ <th ><strong >Comments</strong ></th >
422
+ </tr >
423
+ </thead >
424
+ <tbody >
425
+ <tr class =" odd " >
426
+ <td >Overall Call</td >
427
+ <td >2</td >
428
+ <td >1 - 5</td >
429
+ <td >Survey’s a calling participant’s overall quality experience on a
430
+ scale of 1-5 where 1 indicates an imperfect call experience and 5
431
+ indicates a perfect call. The cutoff value of 2 means that a customer
432
+ response of 1 or 2 indicates a less than perfect call experience.</td >
433
+ </tr >
434
+ <tr class =" even " >
435
+ <td >Audio</td >
436
+ <td >2</td >
437
+ <td >1 – 5</td >
438
+ <td >A response of 1 indicates an imperfect audio experience and 5
439
+ indicates no audio issues were experienced.</td >
440
+ </tr >
441
+ <tr class =" odd " >
442
+ <td >Video</td >
443
+ <td >2</td >
444
+ <td >1 – 5</td >
445
+ <td >A response of 1 indicates an imperfect video experience and 5
446
+ indicates no video issues were experienced.</td >
447
+ </tr >
448
+ <tr class =" even " >
449
+ <td >Screenshare</td >
450
+ <td >2</td >
451
+ <td >1 – 5</td >
452
+ <td >A response of 1 indicates an imperfect screen share experience and 5
453
+ indicates no screen share issues were experienced.</td >
454
+ </tr >
455
+ </tbody >
456
+ </table >
457
+
458
+ - \* ** Note:** A question’s indicated cutoff value in the API is the
459
+ threshold that Microsoft uses when analyzing your survey data. When
460
+ you customize the cutoff value or Input Range, Microsoft analyzes
461
+ your survey data according to your customization.
462
+
463
+ ### ** Additional survey tags**
464
+
465
+ <table >
466
+ <colgroup >
467
+ <col style =" width : 15% " />
468
+ <col style =" width : 84% " />
469
+ </colgroup >
470
+ <thead >
471
+ <tr class =" header " >
472
+ <th ><strong >Rating Categories</strong ></th >
473
+ <th ><strong >Optional Tags</strong ></th >
474
+ </tr >
475
+ </thead >
476
+ <tbody >
477
+ <tr class =" odd " >
478
+ <td >Overall Call</td >
479
+ <td >'CallCannotJoin' | 'CallCannotInvite' | 'HadToRejoin' |
480
+ 'CallEndedUnexpectedly' | 'OtherIssues'</td >
481
+ </tr >
482
+ <tr class =" even " >
483
+ <td >Audio</td >
484
+ <td >'NoLocalAudio' | 'NoRemoteAudio' | 'Echo' | 'AudioNoise' |
485
+ 'LowVolume' | 'AudioStoppedUnexpectedly' | 'DistortedSpeech' |
486
+ 'AudioInterruption' | 'OtherIssues'</td >
487
+ </tr >
488
+ <tr class =" odd " >
489
+ <td >Video</td >
490
+ <td >'NoVideoReceived' | 'NoVideoSent' | 'LowQuality' | 'Freezes' |
491
+ 'StoppedUnexpectedly' | 'DarkVideoReceived' | 'AudioVideoOutOfSync' |
492
+ 'OtherIssues'</td >
493
+ </tr >
494
+ <tr class =" even " >
495
+ <td >Screenshare</td >
496
+ <td >'NoContentLocal' | 'NoContentRemote' | 'CannotPresent' |
497
+ 'LowQuality' | 'Freezes' | 'StoppedUnexpectedly' | 'LargeDelay' |
498
+ 'OtherIssues'</td >
499
+ </tr >
500
+ </tbody >
501
+ </table >
502
+
503
+ ### ** End of Call Survey Customization**
504
+
505
+ You can choose to collect each of the four API values or only the ones
506
+ you find most important. For example, you can choose to only ask
507
+ customers about their overall call experience instead of asking them
508
+ about their audio, video, and screen share experience. You can also
509
+ customize input ranges to suit your needs. The default input range is 1
510
+ to 5 for Overall Call, <span class =" mark " >Audio</span >, Video, and
511
+ Screenshare. However, each API value can be customized from a minimum of
512
+ 0 to maximum of 100.
513
+
514
+ ### ** Customization options**
515
+
516
+ <table >
517
+ <colgroup >
518
+ <col style =" width : 53% " />
519
+ <col style =" width : 20% " />
520
+ <col style =" width : 26% " />
521
+ </colgroup >
522
+ <thead >
523
+ <tr class =" header " >
524
+ <th ><strong >API Rating Categories</strong ></th >
525
+ <th ><strong >Cutoff Value*</strong ></th >
526
+ <th ><strong >Input Range</strong ></th >
527
+ </tr >
528
+ </thead >
529
+ <tbody >
530
+ <tr class =" odd " >
531
+ <td >Overall Call</td >
532
+ <td >0 - 100</td >
533
+ <td >0 – 100</td >
534
+ </tr >
535
+ <tr class =" even " >
536
+ <td >Audio</td >
537
+ <td >0 - 100</td >
538
+ <td >0 – 100</td >
539
+ </tr >
540
+ <tr class =" odd " >
541
+ <td >Video</td >
542
+ <td >0 - 100</td >
543
+ <td >0 – 100</td >
544
+ </tr >
545
+ <tr class =" even " >
546
+ <td >Screenshare</td >
547
+ <td >0 - 100</td >
548
+ <td >0 - 100</td >
549
+ </tr >
550
+ </tbody >
551
+ </table >
552
+
553
+ - \* ** Note** : A question’s indicated cutoff value in the API is the
554
+ threshold that Microsoft uses when analyzing your survey data. When
555
+ you customize the cutoff value or Input Range, Microsoft analyzes
556
+ your survey data according to your customization.
557
+
558
+ ## ** Store and view survey data:**
559
+
560
+ ** Important**
561
+
562
+ You must enable a Diagnostic Setting in Azure Monitor to send the log
563
+ data of your surveys to a Log Analytics workspace, Event Hubs, or an
564
+ Azure storage account to receive and analyze your survey data. If you do
565
+ not send survey data to one of these options your survey data will not
566
+ be stored and will be lost. To enable these logs for your Communications
567
+ Services, see: ** Enable logging in Diagnostic Settings**
568
+
569
+ You can only view your survey data if you have enabled a Diagnostic
570
+ Setting to capture your survey data. <span class =" mark " >To learn how to
571
+ use the End of Call Survey and view your survey data, see: ** <u >Tutorial
572
+ Link</u >** </span >
573
+
574
+ ## ** Next Steps**
575
+
576
+ - Create your own queries in Log Analytics, see: [ Get Started
577
+ Queries] ( https://review.learn.microsoft.com/en-us/azure/azure-monitor/logs/get-started-queries )
0 commit comments