Get the voice settings
Returns the voice settings for your workspace.
inbound_configuration.route is what happens to calls for every Bird number that has no inbound route of its own. Verified caller IDs receive no calls, so it never applies to them. It is "reject" until you change it.
daily_spend_limit is the daily limit outbound calls are admitted against, what has been used toward it today including calls in progress, and when it resets at midnight UTC.
Request
- Base URL: https://us1.platform.bird.com
- URL: https://us1.platform.bird.com/v1/voice/settings
- Auth: one of:
- HTTP bearer
- API key in cookie bird_session
Headers
Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.
Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.
Response
The workspace's voice settings.
Example response
{
"inbound_configuration": {
"route": {
"type": "reject"
}
},
"daily_spend_limit": {
"currency_code": "EUR",
"limit": {
"amount": "0.00995",
"currency_code": "EUR"
},
"used": {
"amount": "0.00995",
"currency_code": "EUR"
},
"remaining": {
"amount": "0.00995",
"currency_code": "EUR"
},
"default_limit": {
"amount": "0.00995",
"currency_code": "EUR"
},
"max_limit": {
"amount": "0.00995",
"currency_code": "EUR"
},
"workspace_limit": {
"amount": "0.00995",
"currency_code": "EUR"
}
}
}Changes
No recorded changes to this operation across all 2 revisions of this API.