Concurrency - Vobiz

GET

api

Account

{auth_id}

concurrency

Get concurrency limits

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/concurrency \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/concurrency"

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

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

print(response.text)

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

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

{
  "account_id": "MA_XXXXXXXX",
  "concurrent_calls": 0,
  "max_concurrent": 46,
  "utilization_pct": 0,
  "request_id": "aabbccdd1234567890abcdef12345678"
}

Overview

The Concurrency API lets you retrieve real-time data about how many concurrent lines are active for your account. Use it to monitor line utilization and ensure you have sufficient capacity.

Get Concurrency

GET https://api.vobiz.ai/api/v1/Account/{auth_id}/concurrency

Returns the current number of concurrent lines active for a specific account.

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token
Content-Type: application/json

Request

cURL

curl -X GET "https://api.vobiz.ai/api/v1/Account/YOUR_AUTH_ID/concurrency" \
--header 'X-Auth-ID: YOUR_AUTH_ID' \
--header 'X-Auth-Token: YOUR_AUTH_TOKEN' \
--header 'Accept: application/json'

Response

JSON Response

{
    "account_id": "MA_XXXXXXXX",
    "concurrent_calls": 0,
    "max_concurrent": 46,
    "utilization_pct": 0,
    "request_id": "aabbccdd1234567890abcdef12345678"
}

Response fields

Field	Type	Description
`account_id`	string	The account these counters belong to.
`concurrent_calls`	integer	Number of calls currently active.
`max_concurrent`	integer	The account’s concurrent-call ceiling. Equals `concurrent_calls_limit` from the Account object (`base_concurrent_calls_limit + purchased_concurrent_calls`).
`utilization_pct`	integer	`concurrent_calls` as a percentage of `max_concurrent`.
`request_id`	string	Unique identifier for this request, useful for support.

Concurrency vs CPS. max_concurrent caps how many calls can be live at once; the separate CPS limit (cps_limit) caps how many new calls you can start per second. Both are raised by purchasing add-ons (purchased_concurrent_calls, purchased_cps) - see The Account Object. When utilization_pct approaches 100, new calls are rejected until channels free up.

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

Response

200 - application/json

Concurrency info

account_id

string

required

concurrent_calls

integer

required

max_concurrent

integer

required

utilization_pct

integer

required

request_id

string

required

Get concurrency limits

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/concurrency \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/concurrency"

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

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

print(response.text)

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

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

{
  "account_id": "MA_XXXXXXXX",
  "concurrent_calls": 0,
  "max_concurrent": 46,
  "utilization_pct": 0,
  "request_id": "aabbccdd1234567890abcdef12345678"
}

​Overview

​Get Concurrency

​Request

​Response

​Response fields

Authorizations

Path Parameters

Response

Overview

Get Concurrency

Request

Response

Response fields