removeFromQueueNotification

A call has been removed from a queue and the Enqueue command’s actionUrl is being invoked. A PerCL response is expected except if reason is hangup.

Request ParameterTypeDescription
requestTypestringContext or reason why this request is being made. Will be removeFromQueueNotification - A Call has been removed from a Queue and the Enqueue command’s actionUrl is being invoked.
callIdstringUnique ID for this call, generated by FreeClimb.
accountIdstringAccount ID associated with your account.
fromstringPhone number of the party that initiated the Call (in E.164 format).
tostringPhone number provisioned to the customer 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 the caller is in.
queueResultstringFinal result of the enqueued Call. Valid values are:
queueFull - Targeted Queue was full, so the enqueue attempt was rejected.
hangup - Enqueued caller hung up while in the Queue.
systemError - FreeClimb system malfunctioned during the enqueue process.
queueTimeintegerTime (in seconds) the Call spent in the Queue. This is only available if the Call was actually enqueued.