Base endpoint
Outbound call queues
Get outbound queue count
Retrieve the total count of outbound call queue entries matching the specified filters.number
required
The unique identifier of the business
object
Optional filters for counting queue entries
boolean
Whether the request succeeded
number
Total count of matching queue entries
Get outbound queue entries
Retrieve paginated outbound call queue entries with filtering and sorting.number
Page number (1-indexed, default: 1)
number
Number of results per page (default: 50, max: 100)
object
Filter criteria (same as count endpoint)
string
Field to sort by:
createdAt, updatedAt, scheduledTimestring
Sort direction:
asc or descGet single outbound queue entry
Retrieve detailed information about a specific outbound queue entry.string
required
The unique identifier of the queue entry
Inbound call queues
Get inbound queue count
Retrieve the total count of inbound call queue entries.Get inbound queue entries
Retrieve paginated inbound call queue entries.Get single inbound queue entry
Retrieve detailed information about a specific inbound queue entry.Queue entry structure
string
Unique identifier for the queue entry
number
Associated business ID
string
Campaign identifier (for outbound calls)
string
Agent handling the call
string
Phone number being called (outbound) or calling (inbound)
string
Queue status:
Pending, InProgress, Completed, Failed, Cancelledstring
When the call is scheduled (ISO 8601)
string
When the call started (ISO 8601)
string
When the call completed (ISO 8601)
number
Number of retry attempts
string
Last error message if failed
Use cases
Campaign monitoring
Track the progress of outbound calling campaigns in real-time
Queue analytics
Analyze call queue metrics and performance
Call center operations
Monitor inbound call queues for contact centers
Retry management
Identify and manage failed calls for retry
Error codes
Related endpoints
- Calls API - Initiate and manage calls
- Conversations API - Retrieve call transcripts and history
- Business API - Manage business configuration