redirect

The Redirect command is executing and its actionUrl is being invoked. A PerCL response is expected.

Below are the standard parameters of this webhook. There may be additional if the triggering Redirect was the first PerCL command received from the Application in the previous webhook.

Request Parameter

Type

Description

requestType

string

Context or reason why this request is being made. Will be redirect - The Redirect command is executing and its actionUrl is being invoked.

callId

string

Unique identifier for this Call, generated by FreeClimb.

accountId

string

Account ID associated with your account.

from

string

Phone number of the party that initiated the Call (in E.164 format).

to

string

Phone number provisioned to the customer and to which this Call is directed (in E.164 format).

callStatus

string

Descriptive status for the Call. Valid values are:
ringing - Call is currently ringing.
inProgress - Call was answered and is currently in progress (not queued, not in conference).
completed - Call ended normally.
busy - Caller received a busy signal.
failed - Call could not be completed as dialed (most likely because the phone number was non-existent).
noAnswer - Call ended without being answered.
canceled - Call was canceled via the REST API while queued or ringing.

direction

string

String describing the direction of the Call – inbound for inbound calls, outbound for Calls initiated via the REST API, or outboundDial for Calls initiated by the OutDial PerCL command.

conferenceId

string

This is only populated if request pertains to a conference. Otherwise, it is set to null.

queueId

string

This is only populated if the request pertains to a queue. Otherwise, it is set to null.

parentCallId

string

ID of the Call that created this leg (child call).

originalRequestType

string

null or name of original webhook. If this field has a string, there may be additional parameters based on the original webhook that was redirected.