API v3
GET /traffic/destinations
Traffic by destination country for a time range.
Addresshttps://api.voicepro.plus/v3/traffic/destinations
Key permissionread
Fields
| Name | In | Type | |
|---|---|---|---|
| limit | query | integer | |
| cursor | query | string | next_cursor from the previous page. |
| from | query | string | Default: 24 hours before to. |
| to | query | string | Default: now. |
* required
Example
curl -X GET "https://api.voicepro.plus/v3/traffic/destinations" \ -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
"object": "list",
"data": [
{
"object": "traffic_destination",
"country": "FR",
"calls": 410,
"answered": 295,
"asr": 0.72,
"minutes": 701.2,
"spend": {
"amount": "35.06",
"currency": "USD"
}
}
],
"has_more": false,
"next_cursor": null
}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.