Campaign capacity and monitoring

GET

api

account

{account_id}

capacity

Campaign capacity and monitoring

curl --request GET \
  --url https://campaign.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://campaign.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://campaign.vobiz.ai/api/v1/account/{account_id}/capacity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Use the account capacity endpoint before and during a campaign to understand how many calls can run concurrently.

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.

cURL

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

The response includes:

concurrent_calls — active calls across the account.
max_concurrent — account concurrency limit.
concurrent_free — capacity available for new calls.
utilization_pct — current utilization percentage.
running_campaigns — summaries of campaigns consuming capacity.

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

Capacity behavior

max_concurrent on a campaign cannot exceed the account concurrency limit. Capacity is enforced at dial time. A saturated account does not fail the campaign; the campaign remains running and waits until a slot becomes available.

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

Monitoring endpoints

Endpoint	Use
`GET /campaigns/{campaign_id}`	Read status, computed health, counters, and pause reason.
`GET /campaigns/{campaign_id}/contacts`	Browse contact state with `status` and `search` filters.
`GET /campaigns/{campaign_id}/calls`	Inspect every attempt, including attempts without a matching CDR.
`GET /campaigns/{campaign_id}/results`	Download current or final contact outcomes.
`GET /capacity`	Inspect account-wide concurrency and running consumers.

Health and automatic pauses

A running campaign reports active, idle, stalled, or not_started health. Operational pause reasons include:

manual_pause
window_closed
caller_pool_exhausted
caller_pool_daily_limit_reached
account_inactive
stalled
consecutive_failures
balance_insufficient

Some reasons require manual action. Daily window and pool daily-limit pauses can resume automatically at the appropriate time.

Campaign caller pool API

Campaign webhook events

Campaign capacity and monitoring

curl --request GET \
  --url https://campaign.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://campaign.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://campaign.vobiz.ai/api/v1/account/{account_id}/capacity', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Capacity behavior

​Monitoring endpoints

​Health and automatic pauses

Capacity behavior

Monitoring endpoints

Health and automatic pauses