VoiceGateway

Read the organisation allowance and measured usage

GET
/api/v1/org/{orgId}/entitlement

Authorization

consoleSession
cookievg_session<token>

The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.

Path Parameters

orgId*string

Authorised orgId; the server must verify organisation/project ownership before any read.

Length1 <= length

Response Body

Allowance, durable usage and ingestion status.

application/json
  1. response
from*string
Formatdate-time
to*string
Formatdate-time
limitMinutes*integer
Range0 <= value <= 1000000000
active*boolean
revision*integer
Range1 <= value
callSeconds*integer
Range0 <= value
unmeasuredCalls*integer

Retained closed calls first seen in this billing period whose duration is missing or invalid. Excluded from measured seconds. This count can decrease with retention.

Range0 <= value
openCalls*integer

Retained open calls first seen in this billing period. Their duration is not yet measured. This count can decrease with retention.

Range0 <= value
warningPercent*integer
Value in08095100
ingestAllowed*boolean
Example Request
curl -X GET 'https://example.com/api/v1/org/string/entitlement'
Example Response
{  "from": "2019-08-24T14:15:22Z",  "to": "2019-08-24T14:15:22Z",  "limitMinutes": 0,  "active": true,  "revision": 1,  "callSeconds": 0,  "unmeasuredCalls": 0,  "openCalls": 0,  "warningPercent": 0,  "ingestAllowed": true}

Was this page helpful?