Skip to content

Commit af93b91

Browse files
Merge pull request #288266 from tinaharter/threadIdFeatureQuickStart
Server managed thread id feature quick start
2 parents 65fec79 + 019d7cd commit af93b91

File tree

1 file changed

+20
-4
lines changed
  • articles/communication-services/how-tos/cte-calling-sdk/includes/manage-calls

1 file changed

+20
-4
lines changed

articles/communication-services/how-tos/cte-calling-sdk/includes/manage-calls/manage-calls-web.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,9 @@ const localVideoStreams = call.localVideoStreams;
328328
```
329329

330330
## Manage chat thread
331-
Providing a chat ID is mandatory for making group calls and adding participants to existing calls. Associated chat and call have a separate list of participants. Before adding participants to the call, add the user to the chat to provide the best user experience and satisfy information barrier requirements. Adding a user to the call without adding the user to the chat can result in exceptions if an information barrier is set up.
331+
>[!IMPORTANT]
332+
> The optional Chat ID is only available in [1.29.1](https://www.npmjs.com/package/@azure/communication-calling/v/1.29.1) or later of the Calling SDK for JavaScript. If you're using an earlier version, ensure you provide a unique thread ID manually.
333+
Providing a chat ID is optional for making group calls and adding participants to existing calls. Associated chat and call have a separate list of participants. Before adding participants to the call, add the user to the chat to provide the best user experience and satisfy information barrier requirements. Adding a user to the call without adding the user to the chat can result in exceptions if an information barrier is set up.
332334

333335
Consider the following scenario, where Alice makes a call to Bob, then Alice adds Charlie, and 3 minutes later, Alice removes Charlie from the call.
334336

@@ -342,6 +344,20 @@ Consider the following scenario, where Alice makes a call to Bob, then Alice add
342344
If Teams user stops call recording, the recording is placed into the chat associated with the thread. Provided chat ID impacts the experience of Teams users in Teams clients.
343345

344346
Recommendations for the management of chat ID:
345-
- Escalation of the 1:1 phone call by adding another phone participant: Use Graph API to get the existing chat ID with only Teams user as a participant or create a new group chat with participants: Teams user ID and "00000000-0000-0000-0000-000000000000".
346-
- Group call with single Teams user and multiple phone participants: Use Graph API to get existing chat ID with only Teams user as a participant or create a new group chat with participants: Teams user ID and "00000000-0000-0000-0000-000000000000".
347-
- Group call with more than 2 Teams users: Use Graph API to get or create a group chat with the Teams users.
347+
- Escalation of the 1:1 phone call by adding another phone participant:
348+
* Method `addParticipant` allows you to provide optional parameter thread ID. If the parameter isn't provided, then a new group chat is created, and all participants are added to the call and chat participants list. If the parameter is provided, then Teams users can see ongoing call associated to this group chat in Teams app. You can create new group chat via Graph API.
349+
```js
350+
addParticipant(participant: MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)
351+
```
352+
- Start group call with single Microsoft 365 user and multiple phone participants:
353+
* Method `startCall` API allows you to start a group call with multiple participants and optionally provide thread ID. If the parameter isn't provided, then a new group chat is created, and all Microsoft 365 participants are added to the call and chat participants list. If the parameter is provided, then Teams users can see ongoing call associated to this group chat in Teams app. You can create new group chat via Graph API.
354+
```js
355+
startCall(MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[])
356+
```
357+
* Use Graph API to get existing chat ID with only Teams user as a participant or create a new group chat with participants: Teams user ID and "00000000-0000-0000-0000-000000000000".
358+
- Start group call with more than 2 Microsoft 365 users:
359+
* (Optional way) When making a group call with more than 2 Microsoft 365 users using ACS Calling SDK, the SDK will automatically create the thread by default.
360+
```js
361+
startCall(MicrosoftTeamsUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[])
362+
```
363+
* If desired, the developer can provide a unique thread ID to start the group call or add participants. In this case, the ACS Calling SDK will use the given thread ID to create the group call. A chat thread is created for the Teams users and this thread is associated to the group call for users in Teams app. This allows them to chat during the call. Chat thread management can be done via [Graph API](/graph/api/group-post-threads)

0 commit comments

Comments
 (0)