Skip to content
vocapable.Docs

Estimated carrier (Twilio) pass-through cost by call type (owners, web only)

GET
/v1/workspace/phone/carrier-estimate
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/phone/carrier-estimate?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
PhoneCarrierEstimate

Web only (E15-R3): an estimate of what the tenant’s own carrier will bill.

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
currency
required
Currency
string
Allowed value: usd
rate_table_version
required
Rate Table Version
string
lines
required
Lines
Array<object>
PhoneCarrierEstimateLine
object
key
required
Key
string
Allowed values: outbound_app inbound_app recording transcription_fallback
label
required
Label
string
minutes
required
Minutes
integer
estimate_minor
required
Estimate Minor
integer
total_minor
required
Total Minor
integer
per_minute_minor
required
Per Minute Minor
object
key
additional properties
string
note
required
Note
string
Example
{
  "period": "month",
  "currency": "usd",
  "lines": [
    {
      "key": "outbound_app"
    }
  ]
}

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": {}
    }
  ]
}