Skip to content
vocapable.Docs

Phone usage counts for a period (never prices)

GET
/v1/workspace/phone/usage
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/phone/usage?period=month' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
period
Period
string
default: month
Allowed values: month 30d 7d

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PhoneUsage
object
period
required
Period
string
Allowed values: month 30d 7d
window
required
PhoneUsageWindow
object
start
required
Start
string format: date-time
end
required
End
string format: date-time
items
required
Items
Array<object>
PhoneUsageItem
object
key
required
Key
string
Allowed values: human_call_minutes recording_minutes transcription_minutes texts
label
required
Label
string
quantity
required
Quantity
integer
unit
required
Unit
string
Allowed values: minutes segments
breakdown
required
Breakdown
Array<object>
PhoneUsagePart
object
key
required
Key
string
label
required
Label
string
quantity
required
Quantity
integer
as_of
required
As Of
string format: date-time
note
required
Note
string
Example
{
  "period": "month",
  "items": [
    {
      "key": "human_call_minutes",
      "unit": "minutes"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}