API v3

GET /numbers/{id}/usage

Calls and SMS for a time range.

Addresshttps://api.voicepro.plus/v3/numbers/{id}/usage
Key permissionnumbers:read

Fields

NameInType
id *pathstring
fromquerystringDefault: 24 hours before to.
toquerystringDefault: now.
stepquery5m | 1h | 1dDefault by range: 5m up to a day, 1h up to a week, else 1d.
compare_fromquerystringWith compare_to: a previous period to compare.
compare_toquerystring

* required

Example

curl -X GET "https://api.voicepro.plus/v3/numbers/num_q4zr7mxkp2wd6hnc3tbvfy5a/usage?from=2026-10-01T00%3A00%3A00Z&to=2026-10-28T00%3A00%3A00Z&step=1d" \
  -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
  "object": "number_usage",
  "number_id": "num_q4zr7mxkp2wd6hnc3tbvfy5a",
  "range": {
    "from": "2026-10-01T00:00:00Z",
    "to": "2026-10-28T00:00:00Z",
    "step": "1d",
    "timezone": "Europe/London"
  },
  "totals": {
    "inbound_calls": 96,
    "outbound_calls": 41,
    "answered_calls": 118,
    "minutes": 402.5,
    "sms": 0
  },
  "previous": {
    "inbound_calls": 88,
    "outbound_calls": 37,
    "answered_calls": 109,
    "minutes": 371,
    "sms": 0
  },
  "series": [
    {
      "t": "2026-10-26T00:00:00Z",
      "calls": 6,
      "sms": 0
    },
    {
      "t": "2026-10-27T00:00:00Z",
      "calls": 9,
      "sms": 0
    }
  ]
}

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.
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 Numbers