Get the live call queue
const url = 'https://api.caller9.app/v1/studios/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/queue';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.caller9.app/v1/studios/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/queue \ --header 'Authorization: Bearer <token>'Returns every live (not yet ended) call in the studio, split into the main queue and the hotline (priority) lane, each ordered by queue position. Includes calls that are queued (ringing, unanswered) as well as calls already on hold, on-air, in a browser, or screening. Also returns the studio’s busy/screen-all flags and the current Contest Mode state.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Studio ID (UUID).
Responses
Section titled “Responses”Live queue snapshot.
object
Main-queue live calls, in queue order.
A live call as shown in the studio queue. Additional internal fields may be present and should be ignored.
object
Call id (use with /v1/calls/{call}/…).
External party in E.164 (caller for inbound, callee for outbound).
Display name (contact name, or the number).
Where the caller currently is: hold, hybrid:N (on-air line N),
browser:<userId>, or null while queued.
Sort key for queue position (ascending). Values are not contiguous.
The organization number that was dialed (inbound only).
Label of the dialed number.
When the studio’s ring-timeout action fires for this queued call.
JSON-encoded array of strings (e.g. "[\"vip\"]"), not a native array.
Call topic / talking points (this call only).
Audio codec negotiated with the caller; null until answered.
Hotline (priority lane) live calls.
A live call as shown in the studio queue. Additional internal fields may be present and should be ignored.
object
Call id (use with /v1/calls/{call}/…).
External party in E.164 (caller for inbound, callee for outbound).
Display name (contact name, or the number).
Where the caller currently is: hold, hybrid:N (on-air line N),
browser:<userId>, or null while queued.
Sort key for queue position (ascending). Values are not contiguous.
The organization number that was dialed (inbound only).
Label of the dialed number.
When the studio’s ring-timeout action fires for this queued call.
JSON-encoded array of strings (e.g. "[\"vip\"]"), not a native array.
Call topic / talking points (this call only).
Audio codec negotiated with the caller; null until answered.
Omitted if the studio configuration could not be loaded.
object
1 when the studio is set to busy (do-not-disturb).
1 when Screen All Calls is on.
object
Current contest phase (present only when armed).
Callers counted so far (present only when armed).
Winning caller number, e.g. 9 for “be caller 9”.
Number of backup winners after the target.
Example
{ "queue": [ { "direction": "inbound", "status": "queued", "call_type": "primary", "favourite": 0 } ], "hotline": [ { "direction": "inbound", "status": "queued", "call_type": "primary", "favourite": 0 } ], "config": { "busy_all": 0, "screen_all": 0 }}Missing, invalid, expired or revoked API key.
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}The key isn’t allowed to do this (e.g. a read-only key making a change).
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}Not found, or belongs to another organization.
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}Too many requests for this API key. Retry after Retry-After seconds.
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}Headers
Section titled “Headers”Seconds until the rate-limit window resets.