Provider
Synchronous
No Custom Parameters
Rejects an incoming call, indicating to the remote endpoint that the called party is not able to receive this call.
When a call is inbound to an script via IncomingCall, the call is in a ringing state and a script can choose to do one of 5 things: RejectCall, AnswerCall, Redirect, AcceptCall, or simply do nothing with the call. The practical use of Reject is to indicate to the calling party that their call could not be completed.
From the perspective of the script instance initiated by the incoming call, the telephony protocol of the call has already been chosen by the time IncomingCall has been fired. However, any call created by the application via MakeCall or Barge will use the protocol configured on the partition of the script instance. See Call Routing for more information on how the application server interfaces with the outside world for the routing of calls.
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 reject with RejectCall. | |
| 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.