Call Queues

Q: How do you create a call queue using the FreeClimb API?
A: Send a POST request to /Accounts/{accountId}/Queues providing configuration options like alias and maxSize.

Q: How do you retrieve a list of all call queues for an account?
A: Send a GET request to /Accounts/{accountId}/Queues.

Q: How do you fetch details for a specific call queue?
A: Send a GET request to /Accounts/{accountId}/Queues/{queueId}.

Q: How do you update configuration options for an existing call queue?
A: Send a POST request to /Accounts/{accountId}/Queues/{queueId} with JSON parameters such as alias or maxSize.

Q: How do you list all callers currently waiting in a specific queue?
A: Send a GET request to /Accounts/{accountId}/Queues/{queueId}/Members.

Q: How do you retrieve details for a specific caller in a queue?
A: Send a GET request to /Accounts/{accountId}/Queues/{queueId}/Members/{callId} using the queue ID and Call ID.

Q: How do you dequeue or manage a specific member inside a call queue?
A: Send a POST request to /Accounts/{accountId}/Queues/{queueId}/Members/{callId} to remove or transfer the caller.

Q: How do you dequeue the caller at the front of a queue (head member)?
A: Send a POST request to /Accounts/{accountId}/Queues/{queueId}/Members/Front.

Queues are the primary means of keeping callers waiting. A Queue is an object to hold callers until they can be provided the service they seek. Queues can be created ahead of time and are deleted automatically when they change state from populated to empty.

Resource properties

uristringURI for this resource, relative to the API base URL.
dateCreatedstring date-timeDate that this resource was created (GMT), in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).
dateUpdatedstring date-timeDate that this resource was last updated (GMT), in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).
dateCreatedISOstring date-timeDate that this resource was created (UTC) in RFC3339 format (e.g., 2024-10-09T15:05:03.358Z).
dateUpdatedISOstring date-timeDate that this resource was last updated (UTC) in RFC3339 format (e.g., 2024-10-09T15:05:03.358Z).
revisionintegerRevision count for the resource. Count is set to 1 on creation and is incremented every time it is updated.
accountIdstringID of the account that created this Queue.
queueIdstringA string that uniquely identifies this Queue resource.
aliasstringA description for this Queue.
currentSizeintegerCount of Calls currently in the Queue.
maxSizeintegerThe maximum number of Calls permitted in the Queue. Default is 100. Maximum is 1000.
averageQueueRemovalTimeintegerThe average amount of time (in seconds) for a call to be removed from the queue.
subresourceUrisobjectList of subresources for this Queue (which includes Queue members).