API v3

GET /trunks/channels

Channels in use per trunk, now and at peak, against each trunk's limit, with a series.

Addresshttps://api.voicepro.plus/v3/trunks/channels
Key permissionread

Fields

NameInType
rangequery1h | 24h | 7d | 30d

* required

Example

curl -X GET "https://api.voicepro.plus/v3/trunks/channels?range=24h" \
  -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
  "object": "trunk_channels",
  "range": "24h",
  "bucket_seconds": 900,
  "history_through": "2026-10-28T21:45:00Z",
  "unavailable": [],
  "trunks": [
    {
      "name": "ACME_SIP_GW1",
      "limit": 120,
      "now": 38,
      "now_at": "2026-10-28T21:59:30Z",
      "peak": 96,
      "peak_at": "2026-10-28T18:15:00Z",
      "series": [
        {
          "at": "2026-10-28T21:15:00Z",
          "channels": 41
        },
        {
          "at": "2026-10-28T21:30:00Z",
          "channels": 36
        }
      ]
    }
  ],
  "data_as_of": "2026-10-28T21:45:00Z"
}

Errors

Every error has the same shape: { "error": { "type", "code", "message", "param", "request_id" } }.

missing_api_key401: No Authorization header, or not a Bearer key.
invalid_api_key401: The key is not recognised.
api_key_revoked401: The key was revoked in the portal.
api_key_expired401: The key passed the expiry date set on it.
missing_scope403: The key lacks the scope this endpoint needs; param names the scope.
ip_not_allowed403: The key has an IP allowlist and this request came from elsewhere.
account_not_active403: The workspace is suspended or closed.
invalid_parameter400: A query parameter or body field has a bad value; param names it.
missing_parameter400: A required parameter or field is missing; param names it.
unknown_parameter400: A parameter or field that this endpoint does not accept; param names it.
invalid_json400: The body is not valid JSON.
invalid_cursor400: The cursor is malformed, expired or from a different list.
invalid_time_range400: from or to is not an ISO 8601 date-time, or to is not after from.
range_too_long400: The time range is longer than this endpoint allows (stated in the endpoint).
route_not_found404: No such path in v3.
resource_not_found404: No object with that id on this account.
service_not_enabled404: The account does not have this service (voice trunk, IoT, numbers); param names it.
rate_limited429: Too many requests for this key or for the whole account (the message says which); wait Retry-After seconds.
internal_error500: Our fault. Quote the request_id to support.

More in Voice trunk