Skip to content

Commit ca8475c

Browse files
Merge pull request #244320 from ashwinder/patch-4
Update caller id behaviour for transfer
2 parents dc0dddc + c1f77fb commit ca8475c

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

articles/communication-services/how-tos/call-automation/actions-for-call-control.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ services: azure-communication-services
1616

1717
Call Automation uses a REST API interface to receive requests for actions and provide responses to notify whether the request was successfully submitted or not. Due to the asynchronous nature of calling, most actions have corresponding events that are triggered when the action completes successfully or fails. This guide covers the actions available for steering calls, like CreateCall, Transfer, Redirect, and managing participants. Actions are accompanied with sample code on how to invoke the said action and sequence diagrams describing the events expected after invoking an action. These diagrams help you visualize how to program your service application with Call Automation.
1818

19-
Call Automation supports various other actions to manage call media and recording that aren't included in this guide.
19+
Call Automation supports various other actions to manage call media and recording that have separate guides.
2020

2121
> [!NOTE]
2222
> Call Automation currently doesn't support [Rooms](../../concepts/rooms/room-concept.md) calls.
@@ -308,7 +308,7 @@ client.redirect_call(
308308
```
309309

310310
-----
311-
To redirect the call to a phone number, construct the target with PhoneNumberIdentifier.
311+
To redirect the call to a phone number, construct the target and caller ID with PhoneNumberIdentifier.
312312

313313
# [csharp](#tab/csharp)
314314

@@ -351,7 +351,7 @@ No events are published for redirect. If the target is a Communication Services
351351

352352
## Transfer a 1:1 call
353353

354-
When your application answers a call or places an outbound call to an endpoint, that endpoint can be transferred to another destination endpoint. Transferring a 1:1 call removes your application from the call and hence remove its ability to control the call using Call Automation.
354+
When your application answers a call or places an outbound call to an endpoint, that endpoint can be transferred to another destination endpoint. Transferring a 1:1 call removes your application from the call and hence remove its ability to control the call using Call Automation. The call invite to the target will display the caller ID of the endpoint being transferred. Providing a custom caller ID is not supported.
355355

356356
# [csharp](#tab/csharp)
357357

@@ -385,18 +385,14 @@ result = call_connection_client.transfer_call_to_participant(
385385
target_participant=transfer_destination
386386
)
387387
```
388-
389-
-----
390-
When transferring to a phone number, it's mandatory to provide a source caller ID. This ID serves as the identity of your application(the source) for the destination endpoint.
391-
392388
-----
393389
The sequence diagram shows the expected flow when your application places an outbound 1:1 call and then transfers it to another endpoint.
394390

395391
![Sequence diagram for placing a 1:1 call and then transferring it.](media/transfer-flow.png)
396392

397393
## Add a participant to a call
398394

399-
You can add a participant (Communication Services user or phone number) to an existing call. When adding a phone number, it's mandatory to provide source caller ID. This caller ID is shown on call notification to the participant being added.
395+
You can add a participant (Communication Services user or phone number) to an existing call. When adding a phone number, it's mandatory to provide a caller ID. This caller ID is shown on call notification to the participant being added.
400396

401397
# [csharp](#tab/csharp)
402398

@@ -443,7 +439,7 @@ result = call_connection_client.add_participant(call_invite)
443439
```
444440

445441
-----
446-
To add a Communication Services user, provide a CommunicationUserIdentifier instead of PhoneNumberIdentifier. Source caller ID isn't mandatory in this case.
442+
To add a Communication Services user, provide a CommunicationUserIdentifier instead of PhoneNumberIdentifier. Caller ID isn't mandatory in this case.
447443

448444
AddParticipant publishes a `AddParticipantSucceeded` or `AddParticipantFailed` event, along with a `ParticipantUpdated` providing the latest list of participants in the call.
449445

@@ -484,7 +480,7 @@ result = call_connection_client.remove_participant(remove_this_user)
484480
```
485481

486482
-----
487-
RemoveParticipant will publish a `RemoveParticipantSucceeded` or `RemoveParticipantFailed` event, along with a `ParticipantUpdated` providing the latest list of participants in the call. The removed participant is excluded if the remove operation was successful.
483+
RemoveParticipant will publish a `RemoveParticipantSucceeded` or `RemoveParticipantFailed` event, along with a `ParticipantUpdated` event providing the latest list of participants in the call. The removed participant is omitted from the list.
488484
![Sequence diagram for removing a participant from the call.](media/remove-participant-flow.png)
489485

490486
## Hang up on a call

0 commit comments

Comments
 (0)