Redirect

Metreos.CallControl.Redirect

Summary

Redirects the application server's side of a pending call to the specified destination.

Usage

Redirect allows one to attempt to send a pending incoming call (non-answered) to the destination specified by the To parameter. From the application server's standpoint, the result of the redirect attempt is never known.

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: Redirect, AnswerCall, RejectCall, AcceptCall, or simply do nothing with the call. The practical use of Redirect is to send a call somewhere else other than the original destination.

The specified CallId of the call is destroyed after this operation has completed successfully.

With an application that is using Redirect, keep in mind that eventually the incoming call attempt will timeout and the opportunity to Redirect will have passed. There is no way to retreive or otherwise restore the incoming call if the call attempt times out.

Remarks

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.

Action Parameters
Parameter Name.NET TypeDefaultDescription
CallId *System.StringThe CallId of the call to redirect.
To *System.StringThe number to redirect this call to.
TimeoutSystem.Int32The 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 

Success

No description.

Failure

No description.

Timeout

No description.