Provider
Synchronous
No Custom Parameters
DeleteConnection can perform one of three distinct operations:
release a connection, release a conference and all connections in it, or remove a connection from a conference.
If releasing the resources associated with a connection, specify a valid ConnectionId and no ConferenceId.
If releasing the resources associated with a conference and releasing all the connections currently in the conference, specify a valid ConferenceId and no ConnectionId.
If removing a connection from a conference, specify both a valid ConnectionId to be removed from a valid ConferenceId.
If one wanted to destroy a conference but have all connections remain open and connected, then one would have to use the DeleteConnection action for every connection in the conference. Each time the DeleteConnection action is used in such a scenario, one would need to specifying both ConferenceId and the ConnectionId being removed.
DeleteConnection is invoked automatically be the Application Runtime Environment by the Call Control API
whenever a call, previously created by AnswerCall or MakeCall, is hung up or transferred (assuming the call is not currently in a peer-to-peer call).
When the last connection is removed from a conference, the conference is automatically released. The ConferenceId of that conference is no longer valid after that point, and does not need to be deleted with DeleteConnection.
If releasing the resources associated with a connection, then the RTP resource associated with this connection is also released. If the connection was using low bitrate codecs, then one Enhanced RTP resource is also released.
If releasing the resources associated with a conference and releasing all the connections currently in the conference, the RTP resource and conference resource (and Enhanced RTP resource, if applicable) of each participant is released.
If removing a connection from a conference, then the conference resource associated with this connection is released.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| ConnectionId | System.String | The connection to perform the DeleteConnection on. | |
| ConferenceId | System.String | The conference to perform the DeleteConnection on. | |
| 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 |
|---|---|---|
| ResultCode | System.String | A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes. |
Branch Conditions
No description.
No description.
No description.