Provider
Synchronous
No Custom Parameters
Ends a call.
Hangup allows one to end a call that was previously created by a successful AnswerCall, MakeCall, or Barge.
Hangup can also be used to abort an uncompompleted, ringing outbound call that has been placed with MakeCall.
When the call is hung up, a call that is not in a peer-to-peer relationship has the associated ConnectionId destroyed automatically; there is no need to use DeleteConnection with a call that has been hungup. Note that the behavior for a call in a peer-to-peer relationship is significantly different. The other call established as a peer is also hung up. There is no media connection associated with either call in a peer-to-peer relationship so there is no media connection cleanup in that regard.
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 the call to hangup with Hangup. | |
| 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. |
No Result Data
Branch Conditions
No description.
No description.
No description.