queueWait

A queued Call is requesting instructions to execute during the wait in the Queue and the corresponding waitUrl is being invoked. A PerCL response is expected.

The following are the only PerCL commands supported in the PerCL script response to a request to the waitUrl:

Play
Say
Pause
GetDigits
Dequeue
Hangup

Request Parameter

Type

Description

requestType

string

Context or reason why this request is being made. Will be queueWait - A queued call is requesting instructions to execute during the wait in the queue and the corresponding waitUrl is being invoked.

callId

string

Unique ID 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 command.

conferenceId

string

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

queueId

string

ID of the Queue the caller is in.

queuePosition

string

Current queue position of the enqueued Call.

queueTime

integer

Time (in seconds) the Call spent in the Queue. This is only available if the Call was actually enqueued.

averageQueueTime

integer

This field is being deprecated and will removed in an upcoming release.

Average amount of time that currently enqueued callers have been in the Queue.

currentQueueSize

integer

Current number of enqueued Calls in this Queue.