Get account capacity

Inspect live account concurrency, available capacity, utilisation, and the running campaigns consuming it.

GET /api/v1/account/{account_id}/capacity

Get account capacity

cURL

curl --request GET \
  --url https://api.vobiz.ai/api/v1/account/{account_id}/capacity \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>'

GET https://api.vobiz.ai/api/v1/account/{account_id}/capacity

Call this before and during a campaign to understand how many calls can run concurrently.

Authentication required

• X-Auth-ID — your Vobiz account ID
• X-Auth-Token — your Vobiz auth token

account_id · string · required

Your Vobiz account ID. Use the same value in X-Auth-ID.

X-Auth-ID · string · required

Your Vobiz account ID, for example MA_XXXXXXXX.

Example

cURL

curl "https://api.vobiz.ai/api/v1/account/{account_id}/capacity" \
  -H "X-Auth-ID: {account_id}" \
  -H "X-Auth-Token: {auth_token}"

Response fields

Field	Description
concurrent_calls	Active calls across the account.
max_concurrent	Account concurrency limit.
concurrent_free	Capacity available for new calls.
utilization_pct	Current utilisation percentage.
running_campaigns	Summaries of the campaigns consuming capacity, with running and queued breakdown.

The endpoint returns 502 when the upstream platform concurrency service is unavailable.

Capacity behaviour

A campaign’s max_concurrent cannot exceed the account concurrency limit. Capacity is enforced at dial time: a saturated account does not fail the campaign — it stays running and waits for a slot.

The cps field remains for backward compatibility but does not gate campaign capacity. Use live concurrency and max_concurrent when reasoning about throughput.

Health and automatic pauses

A running campaign reports active, idle, stalled, or not_started health through Retrieve a campaign. Operational pause reasons are:

Reason	Clears
manual_pause	Manual resume
window_closed	Automatically, at the next open window
caller_pool_exhausted	Manual resume after adding pool capacity
caller_pool_daily_limit_reached	Automatically, at midnight in the campaign timezone
account_inactive	Manual resume once the account is reactivated
stalled	Manual resume
consecutive_failures	Manual resume after fixing the failure cause
balance_insufficient	Manual resume after topping up

Related monitoring endpoints

Endpoint	Use
GET /campaigns/{campaign_id}	Status, computed health, counters, and pause reason.
GET /campaigns/{campaign_id}/contacts	Contact state with status and search filters.
GET /campaigns/{campaign_id}/calls	Every attempt, including attempts with no matching CDR.
GET /campaigns/{campaign_id}/results	Current or final contact outcomes as CSV.