Skip to content

Commit 7f4ede6

Browse files
committed
update
1 parent 70368a7 commit 7f4ede6

File tree

2 files changed

+32
-19
lines changed

2 files changed

+32
-19
lines changed

articles/communication-services/toc.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,9 @@ items:
202202
href: tutorials/virtual-visits/sample-builder.md
203203
- name: Proxy your calling traffic
204204
href: tutorials/proxy-calling-support-tutorial.md
205+
- name: Survey users
206+
href: tutorials/end-of-call-survey-tutorial.md
207+
displayName: diagnostics, Survey, feedback, quality, reliability, users, end, call, quick
205208
- name: Call management
206209
items:
207210
- name: Manage calls

articles/communication-services/tutorials/end-of-call-survey-tutorial.md

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -35,27 +35,21 @@ This tutorial shows you how to use the Azure Communication Services End of Call
3535
- [Node.js](https://nodejs.org/) active Long Term Support(LTS) versions are recommended.
3636

3737
- 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).
3939

4040

4141
> [!IMPORTANT]
4242
> 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.
4343
4444
## Sample of API usage
4545

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.
4746

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.
5048

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.
5150

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.
5252

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.
5953

6054
### Rate call only - no custom scale
6155

@@ -84,7 +78,7 @@ call.feature(Features.CallSurvey).submitSurvey({
8478
}).then(() => console.log('survey submitted successfully'));
8579
```
8680

87-
### Rate overall, audio / video call with sample issue
81+
### Rate overall, audio, and video with a sample issue
8882

8983
``` javascript
9084
call.feature(Features.CallSurvey).submitSurvey({
@@ -94,7 +88,7 @@ call.feature(Features.CallSurvey).submitSurvey({
9488
}).then(() => console.log('survey submitted successfully'))
9589
```
9690

97-
### Handle Errors that SDK can throw
91+
### Handle errors the SDK can send
9892
``` javascript
9993
call.feature(Features.CallSurvey).submitSurvey({
10094
overallRating: { score: 3 }
@@ -113,7 +107,7 @@ API will return the error messages when data validation failed or unable to subm
113107
- overallRating.score
114108
- audioRating.score
115109
- videoRating.score
116-
- screenshareRating.score
110+
- ScreenshareRating.score
117111
- ${propertyName}: ${rating.score} should be between ${rating.scale?.lowerBound} and ${rating.scale?.upperBound}. ;
118112
- ${propertyName}: ${rating.scale?.lowScoreThreshold} should be between ${rating.scale?.lowerBound} and ${rating.scale?.upperBound}. ;
119113
- ${propertyName} lowerBound: ${rating.scale?.lowerBound} and upperBound: ${rating.scale?.upperBound} should be between 0 and 100. ;
@@ -125,13 +119,18 @@ API will return the error messages when data validation failed or unable to subm
125119

126120
| API Rating Categories | Cutoff Value* | Input Range | Comments |
127121
| ----------- | ----------- | -------- | -------- |
128-
| 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. |
129123
| Audio | 2 | 1 - 5 | A response of 1 indicates an imperfect audio experience and 5 indicates no audio issues were experienced. |
130124
| Video | 2 | 1 - 5 | A response of 1 indicates an imperfect video experience and 5 indicates no video issues were experienced. |
131125
| Screenshare | 2 | 1 - 5 | A response of 1 indicates an imperfect screen share experience and 5 indicates no screen share issues were experienced. |
132126

133127

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.
131+
132+
133+
### More survey tags
135134
| Rating Categories | Optional Tags |
136135
| ----------- | ----------- |
137136
| Overall Call | `CallCannotJoin` `CallCannotInvite` `HadToRejoin` `CallEndedUnexpectedly` `OtherIssues` |
@@ -142,6 +141,17 @@ API will return the error messages when data validation failed or unable to subm
142141

143142
### Customization options
144143

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+
145155

146156
| API Rating Categories | Cutoff Value* | Input Range |
147157
| ----------- | ----------- | -------- |
@@ -150,7 +160,8 @@ API will return the error messages when data validation failed or unable to subm
150160
| Video | 0 - 100 | 0 - 100 |
151161
| Screenshare | 0 - 100 | 0 - 100 |
152162

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.
154165
155166
<!--
156167
## Collect survey data
@@ -188,10 +199,9 @@ Surveying Guidelines
188199
- Consider using surveys for separate ACS Resources in controlled experiments to identify release impacts.
189200

190201

191-
<!-- ## Next Steps
202+
## Next Steps
192203

193204
- Learn how to use the Log Analytics workspace, see: [Log Analytics Tutorial](../../../articles/azure-monitor/logs/log-analytics-tutorial.md)
194205

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)
197207

0 commit comments

Comments
 (0)