Skip to main content

Reject Call

IMPORTANT!

If you hadn't yet read the intro part of this section, please click here to read it first.

Description

This module provides the developer access to the Cloudonix Reject Verb. Activating this module will instruct your currently running voice application to reject the current active voice call. Rejecting a currently active voice call will result in its disconnection and termination of the currently running voice application.

PAY ATTENTION

Using the output, of this module, in the middle your CXML script will result in the following directives not being executed and the termination of the currently running voice application.

Workflow

This module may be executed at any point of a scenario - however, pay attention to where the output is used in your CXML response.

Module Example

Parameters

ParameterDescription
ConnectionThe Voice Application Connection to be used for the query.
Reject ReasonSee Below.
ActionThe voice application to execute. Available for Attached or Detached Voice Applications.
EndpointThe voice application remote HTTP endpoint. Available for Custom Voice Application Endpoint only.
Additional DataAn array of key=value pairs, to be passed to the new Voice Application as part of the request data.

Reject Reason Options

Empty

The call is rejected with an application error, without specifying a specific cause. This is equivalent to a SIP 500 error.

Access Denied

The call is rejected with a security error. This is equivalent to a SIP 403 error.

Destination Busy

The call is rejected with a busy error. This is equivalent to a SIP 486 error.

No Channels Available to Service Call

The call is rejected with a congestion error. This is equivalent to a SIP 503 error.

Call Failed

The call is rejected with an application error. This is equivalent to a SIP 603 error.

Advanced Mode

This module doesn't have advanced usage mode available.