Skip to content

Commit 4f6118b

Browse files
Court72Court72
authored
Merge pull request #235331 from amagginetti/end-of-call-survey-concept
Create end of call survey concept document
2 parents bbcf759 + ee7cd93 commit 4f6118b

File tree

2 files changed

+132
-2
lines changed

2 files changed

+132
-2
lines changed

‎articles/communication-services/concepts/voice-video-calling/end-of-call-survey-concept.md

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
title: Azure Communication Services End of Call Survey overview
3+
titleSuffix: An Azure Communication Services concept document
4+
description: Learn about the End of Call Survey.
5+
author: amagginetti
6+
ms.author: amagginetti
7+
manager: mvivion
8+
9+
services: azure-communication-services
10+
ms.date: 4/03/2023
11+
ms.topic: conceptual
12+
ms.service: azure-communication-services
13+
ms.subservice: calling
14+
---
15+
16+
17+
18+
# End of Call Survey overview
19+
20+
21+
[!INCLUDE [Public Preview](../../includes/public-preview-include-document.md)]
22+
23+
24+
> [!NOTE]
25+
> End of Call Survey is currently supported only for our JavaScript / Web SDK.
26+
27+
28+
The End of Call Survey provides you with a tool to understand how your end users perceive the overall quality and reliability of your JavaScript / Web SDK calling solution.
29+
30+
## Purpose of the End of Call Survey
31+
It’s difficult to determine a customer’s perceived calling experience and determine how well your calling solution is performing without gathering subjective feedback from customers.
32+
33+
You can use the End of Call Survey to collect and analyze customers **subjective** opinions on their calling experience as opposed to relying only on **objective** measurements such as audio and video bitrate, jitter, and latency, which may not indicate if a customer had a poor calling experience. After publishing survey data, you can view the survey results through Azure for analysis and improvements. Azure Communication Services uses these survey results to monitor and improve quality and reliability.
34+
35+
36+
## Survey structure
37+
38+
The survey is designed to answer two questions from a user’s point of view.
39+
40+
- **Question 1:** How did the users perceive their overall call quality experience?
41+
42+
- **Question 2:** Did the user perceive any Audio, Video, or Screen Share issues in the call?
43+
44+
The API allows applications to gather data points that describe user perceived ratings of their Overall Call, Audio, Video, and Screen Share experiences. Microsoft analyzes survey API results according to the following goals.
45+
46+
### End of Call Survey API goals
47+
48+
49+
| API Rating Categories | Question Goal |
50+
| ----------- | ----------- |
51+
| Overall Call | Responses indicate how a call participant perceived their overall call quality. |
52+
| Audio | Responses indicate if the user perceived any Audio issues. |
53+
| Video | Responses indicate if the user perceived any Video issues. |
54+
| Screenshare | Responses indicate if the user perceived any Screen Share issues. |
55+
56+
57+
58+
## Survey capabilities
59+
60+
61+
62+
### Default survey API configuration
63+
64+
| API Rating Categories | Cutoff Value* | Input Range | Comments |
65+
| ----------- | ----------- | -------- | -------- |
66+
| Overall Call | 2 | 1 - 5 | Surveys a calling participant’s overall quality experience on a scale of 1-5. A response of 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. |
67+
| Audio | 2 | 1 - 5 | A response of 1 indicates an imperfect audio experience and 5 indicates no audio issues were experienced. |
68+
| Video | 2 | 1 - 5 | A response of 1 indicates an imperfect video experience and 5 indicates no video issues were experienced. |
69+
| Screenshare | 2 | 1 - 5 | A response of 1 indicates an imperfect screen share experience and 5 indicates no screen share issues were experienced. |
70+
71+
72+
73+
> [!NOTE]
74+
>A question’s indicated cutoff value in the API is the threshold that Microsoft uses when analyzing your survey data. When you customize the cutoff value or Input Range, Microsoft analyzes your survey data according to your customization.
75+
76+
### More survey tags
77+
| Rating Categories | Optional Tags |
78+
| ----------- | ----------- |
79+
| Overall Call | `CallCannotJoin` `CallCannotInvite` `HadToRejoin` `CallEndedUnexpectedly` `OtherIssues` |
80+
| Audio | `NoLocalAudio` `NoRemoteAudio` `Echo` `AudioNoise` `LowVolume` `AudioStoppedUnexpectedly` `DistortedSpeech` `AudioInterruption` `OtherIssues` |
81+
| Video | `NoVideoReceived` `NoVideoSent` `LowQuality` `Freezes` `StoppedUnexpectedly` `DarkVideoReceived` `AudioVideoOutOfSync` `OtherIssues` |
82+
| Screenshare | `NoContentLocal` `NoContentRemote` `CannotPresent` `LowQuality` `Freezes` `StoppedUnexpectedly` `LargeDelay` `OtherIssues` |
83+
84+
85+
86+
### End of Call Survey customization
87+
You can choose to collect each of the four API values or only the ones you find most important. For example, you can choose to only ask customers about their overall call experience instead of asking them about their audio, video, and screen share experience. You can also customize input ranges to suit your needs. The default input range is 1 to 5 for Overall Call, and 0 to 1 for Audio, Video, and Screenshare. However, each API value can be customized from a minimum of 0 to maximum of 100.
88+
89+
You can choose to collect each of the four API values or only the ones
90+
you find most important. For example, you can choose to only ask
91+
customers about their overall call experience instead of asking them
92+
about their audio, video, and screen share experience. You can also
93+
customize input ranges to suit your needs. The default input range is 1
94+
to 5 for Overall Call, Audio, Video, and
95+
Screenshare. However, each API value can be customized from a minimum of
96+
0 to maximum of 100.
97+
98+
### Customization options
99+
100+
101+
| API Rating Categories | Cutoff Value* | Input Range |
102+
| ----------- | ----------- | -------- |
103+
| Overall Call | 0 - 100 | 0 - 100 |
104+
| Audio | 0 - 100 | 0 - 100 |
105+
| Video | 0 - 100 | 0 - 100 |
106+
| Screenshare | 0 - 100 | 0 - 100 |
107+
108+
> [!NOTE]
109+
> A question’s indicated cutoff value in the API is the threshold that Microsoft uses when analyzing your survey data. When you customize the cutoff value or Input Range, Microsoft analyzes your survey data according to your customization.
110+
111+
<!-- ## Store and view survey data:
112+
113+
// todo@amagginetti
114+
// testing adding a comment here.
115+
116+
// TODO@amagginetti
117+
// testing comment here, need to remove comment on this and re-enable.
118+
119+
> [!IMPORTANT]
120+
> You must enable a Diagnostic Setting in Azure Monitor to send the log data of your surveys to a Log Analytics workspace, Event Hubs, or an Azure storage account to receive and analyze your survey data. If you do not send survey data to one of these options your survey data will not be stored and will be lost. To enable these logs for your Communications Services, see: **[Enable logging in Diagnostic Settings](../analytics/enable-logging.md)**
121+
122+
You can only view your survey data if you have enabled a Diagnostic Setting to capture your survey data.
123+
124+
## Next Steps
125+
126+
- Learn how to use the Log Analytics workspace, see: [Log Analytics Tutorial](../../../../articles/azure-monitor/logs/log-analytics-tutorial.md)
127+
128+
- Create your own queries in Log Analytics, see: [Get Started Queries](../../../../articles/azure-monitor/logs/get-started-queries.md) -->
129+

‎articles/communication-services/toc.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -577,9 +577,10 @@ items:
577577
- name: Call flow topologies
578578
href: concepts/detailed-call-flows.md
579579
- name: Mobile integrations
580+
- name: Quality and Reliability
580581
items:
581-
- name: Push notifications
582-
href: concepts/notifications.md
582+
- name: End of Call Survey
583+
href: concepts/voice-video-calling/end-of-call-survey-concept.md
583584
- name: Analytics
584585
items:
585586
- name: Call logs

0 commit comments

Comments
 (0)