Get account capacity

GET

api

account

{account_id}

capacity

Get account capacity

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>'

import requests

url = "https://api.vobiz.ai/api/v1/account/{account_id}/capacity"

headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/account/{account_id}/capacity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

string

required

Your Vobiz account ID. Use the same value in 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

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.

Get account capacity

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>'

import requests

url = "https://api.vobiz.ai/api/v1/account/{account_id}/capacity"

headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<x-auth-id>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/account/{account_id}/capacity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Example

​Response fields

​Capacity behaviour

​Health and automatic pauses

​Related monitoring endpoints

Example

Response fields

Capacity behaviour

Health and automatic pauses

Related monitoring endpoints