You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/communication-services/tutorials/end-of-call-survey-tutorial.md
+29-19Lines changed: 29 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,27 +35,21 @@ This tutorial shows you how to use the Azure Communication Services End of Call
35
35
-[Node.js](https://nodejs.org/) active Long Term Support(LTS) versions are recommended.
36
36
37
37
- An active Communication Services resource. [Create a Communication Services resource](../quickstarts/create-communication-resource.md). Survey results are tied to single Communication Services resources.
38
-
- An active Log Analytics Workspace, also known as Azure Monitor Logs, to ensure you do not lose your survey results. [Enable logging in Diagnostic Settings](../concepts/analytics/enable-logging.md).
38
+
- An active Log Analytics Workspace, also known as Azure Monitor Logs, to ensure you don't lose your survey results. [Enable logging in Diagnostic Settings](../concepts/analytics/enable-logging.md).
39
39
40
40
41
41
> [!IMPORTANT]
42
42
> End of Call Survey is available starting on the version [1.13.0-beta.4](https://www.npmjs.com/package/@azure/communication-calling/v/1.13.0-beta.4) of the Calling SDK. Make sure to use that version or later when trying the instructions.
43
43
44
44
## Sample of API usage
45
45
46
-
Call Survey feature should be used after the call ends. Users can rate any kind of call, 1:1, group, meeting, outgoing and incoming. Once the call ends the application can present a UI to a user, where they can choose a rating score and if needed, pick issues they’ve encountered during the call from pre-defined list.
47
46
48
-
The code snip below shows an example of one-to-one call. After the end of the call, application can show a survey UI and once user choose rating, application should call feature API to submit survey with the input based on the user choices. Show the survey option.
49
-
We encourage you to use the default rating scale. However, you have the option to submit a survey with custom rating scale. You can check out the sample application for the sample API usage.
47
+
The End of Call Survey feature should be used after the call ends. Users can rate any kind of VoIP call, 1:1, group, meeting, outgoing and incoming. Once a user's call ends, your application can show a UI to the end user allowing them to choose a rating score, and if needed, pick issues they’ve encountered during the call from our predefined list.
50
48
49
+
The following code snips show an example of one-to-one call. After the end of the call, your application can show a survey UI and once the user chooses a rating, your application should call the feature API to submit the survey with the user choices.
51
50
51
+
We encourage you to use the default rating scale. However, you can submit a survey with custom rating scale. You can check out the [sample application](https://github.com/Azure-Samples/communication-services-web-calling-tutorial/blob/main/Project/src/MakeCall/CallSurvey.js) for the sample API usage.
52
52
53
-
We encourage you to use the default rating scale. However, you have the option to submit a survey with custom rating scale. You can check out the [sample application](https://github.com/Azure-Samples/communication-services-web-calling-tutorial/blob/main/Project/src/MakeCall/CallSurvey.js) for the complete API usage. You will need the call object to submit the call survey. You will have the call object when you start or receive a call. The code snip below shows an example of one-to-one call. After the end of the call, show the survey option.
54
-
55
-
56
-
57
-
58
-
When the participant submits the survey, then call the submit survey API with survey data.
| Overall Call | 2 | 1 - 5 | Surveys 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. |
122
+
| 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. |
129
123
| Audio | 2 | 1 - 5 | A response of 1 indicates an imperfect audio experience and 5 indicates no audio issues were experienced. |
130
124
| Video | 2 | 1 - 5 | A response of 1 indicates an imperfect video experience and 5 indicates no video issues were experienced. |
131
125
| Screenshare | 2 | 1 - 5 | A response of 1 indicates an imperfect screen share experience and 5 indicates no screen share issues were experienced. |
132
126
133
127
134
-
### Additional survey tags
128
+
129
+
> [!NOTE]
130
+
>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.
@@ -142,6 +141,17 @@ API will return the error messages when data validation failed or unable to subm
142
141
143
142
### Customization options
144
143
144
+
You can choose to collect each of the four API values or only the ones
145
+
you find most important. For example, you can choose to only ask
146
+
customers about their overall call experience instead of asking them
147
+
about their audio, video, and screen share experience. You can also
148
+
customize input ranges to suit your needs. The default input range is 1
149
+
to 5 for Overall Call, Audio, Video, and
150
+
Screenshare. However, each API value can be customized from a minimum of
151
+
0 to maximum of 100.
152
+
153
+
### Customization examples
154
+
145
155
146
156
| API Rating Categories | Cutoff Value*| Input Range |
147
157
| ----------- | ----------- | -------- |
@@ -150,7 +160,8 @@ API will return the error messages when data validation failed or unable to subm
150
160
| Video | 0 - 100 | 0 - 100 |
151
161
| Screenshare | 0 - 100 | 0 - 100 |
152
162
153
-
-***Note**: 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.
163
+
> [!NOTE]
164
+
> 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.
154
165
155
166
<!--
156
167
## Collect survey data
@@ -188,10 +199,9 @@ Surveying Guidelines
188
199
- Consider using surveys for separate ACS Resources in controlled experiments to identify release impacts.
189
200
190
201
191
-
<!--## Next Steps
202
+
## Next Steps
192
203
193
204
- Learn how to use the Log Analytics workspace, see: [Log Analytics Tutorial](../../../articles/azure-monitor/logs/log-analytics-tutorial.md)
194
205
195
-
- Create your own queries in Log Analytics, see: [Get Started Queries](../../../articles/azure-monitor/logs/get-started-queries.md) -->
196
-
206
+
- Create your own queries in Log Analytics, see: [Get Started Queries](../../../articles/azure-monitor/logs/get-started-queries.md)
0 commit comments