Provider
Synchronous
No Custom Parameters
BridgeCalls will cause both call legs in a peer-to-peer relationship to renegotiate their audio streams to instead transmit and receive audio to a media engine; in the process creating two new media engine connections.
Calls in a peer-to-peer relationship stream media directly to one another, bypassing the media engine. This is advantageous if there is no reason to perfom Media Control API operations on the calls; however, if at some point during the call media control is needed, then BridgeCalls is a means to cause both calls to renegotiate their audio streams and begin streaming to and from the media engine. Using this action creates two media engine connections, one for each call.
Either CallId in the peer-to-peer call can be used as the CallId action parameter of this action.
Using BridgeCalls completely removes the peer-to-peer relationship of the call; however, internal to the application server, the peer-to-peer relationship of the two CallId participants is retained, which allows one to specify the callId of just one of these calls in the CallId action parameter in UnbridgeCalls (as opposed to having to specify PeerCallId as well).
The Call Control API makes every effort to abstract the complexities of the underlying telephony protocol; however, one should consult the Call Control Feature Matrix to understand what Call Control actions and action parameters are valid for each of the four supported protocols. One can set installation and deployment guidelines based on the Call Control actions and action parameters that an application uses; the Call Control Feature Matrix makes developing such guidelines feasible.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| CallId * | System.String | Indicates either call leg in the peer-to-peer call. | |
| Timeout | System.Int32 | The Timeout property specifies to the Application Runtime Environment how long to wait for a response from the provider for the current action. The ReturnValue returned in this case is 'Timeout'. The value must be a literal value in milliseconds. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| MmsId | System.UInt32 | Unique identifier used to identify the media engine in control of both connections. A common use for this ID is to ensure that other connections which will ultimately be conferenced with these two connections are all created on the same media engine. This correlation is necessary because all connections in a single conference must all reside on the same media engine. |
| ConnectionId | System.String | Unique identifier used to identify the connection created for the call specified in the CallId action parameter. All subsequent Media Control API operations can use this connection. |
| PeerConnectionId | System.String | Unique identifier used to identify the connection created for the other call leg than that specified by the CallId action parameter. All subsequent Media Control API operations can use this connection. |
| ConferenceId | System.String | The ConferenceID of the conference created for these two connections. |
| MediaRxIP | System.String | The IP address chosen by the application server for the Rx RTP stream for the ConnectionId result data parameter. |
Branch Conditions
No description.
No description.
No description.