Latest Legacy

The Redirect element

You can use the Redirect element to transfer control of a call to a different URL, which then starts processing the new XML response. Any elements after <Redirect> are not processed.

Attributes

method stringCallback-retry configurable

Specifies the HTTP request mode to obtain the Redirect URL.

Allowed values: GET, POST
Defaults to POST.

Parameters sent in the redirect request

From string

The phone number of the party that initiated the call, along with the country code. If the call is inbound, then this is the caller’s caller ID. If the call is outbound — initiated via a request to the API — then this is the phone number you specify as the caller ID.

To string

The phone number of the called party, with the country code. If the call is inbound, then this is your incoming phone number. If the call is outbound, then this is the phone number you provided to call.

Event string

The string Redirect.

CallUUID string

A unique identifier for the call.

CallerName string

For a SIP call, this is the name of the caller. For a PSTN call, this is the caller ID.

Direction string

Indicates the direction of the call. In most cases this will be inbound, and the call would be in a ringing state. If you’re using the Call API, the direction will be outbound, and the call will be in an answered state.

CallStatus string

Indicates the status of the call. The value may be set to ringing, in-progress, or completed. If the call is hung up, CallStatus is set to completed for inbound calls and to completed, busy, failed, timeout, or no-answer for outbound calls.