dequeue

A queued call has been dequeued and the actionUrl of the corresponding Enqueue action is being invoked. A PerCL response is expected.

Request ParameterTypeDescription
requestTypestringContext or reason why this request is being made. Will be dequeue - A queued call has been dequeued and the actionUrl of the corresponding Enqueue action is being invoked.
callIdstringUnique ID for this call, generated by FreeClimb.
accountIdstringAccount ID associated with the your account.
fromstringPhone number of the party that initiated the Call (in E.164 format).
tostringPhone number provisioned to you and to which this Call is directed (in E.164 format).
callStatusstringDescriptive 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.
directionstringString 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.
conferenceIdstringThis is only populated if request pertains to a Conference. Otherwise, it is set to null.
queueIdstringID of the Queue. This is only populated if the call was actually enqueued.
queueResultstringThe final result of the enqueued Call. Valid values are:
dequeued - Enqueued caller exited the Queue via a Dequeue action (Dequeue command or Queue Members POST REST API).
queueTimeintegerTime (in seconds) the call spent in the Queue. This is only available if the Call was actually enqueued.