Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

Get the voice settings

GET
/v1/voice/settings
const settings = await bird.voice.settings.get();
console.log(settings.inbound_configuration.route.type);
Response200
{
  "inbound_configuration": {
    "route": {
      "type": "reject"
    }
  },
  "daily_spend_limit": {
    "currency_code": "EUR",
    "limit": {
      "amount": "0.00995",
      "currency_code": "USD"
    },
    "used": {
      "amount": "0.00995",
      "currency_code": "USD"
    },
    "remaining": {
      "amount": "0.00995",
      "currency_code": "USD"
    },
    "default_limit": {
      "amount": "0.00995",
      "currency_code": "USD"
    },
    "max_limit": {
      "amount": "0.00995",
      "currency_code": "USD"
    },
    "workspace_limit": {
      "amount": "0.00995",
      "currency_code": "USD"
    }
  }
}

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.

Response Payload

inbound_configuration
object
required

What happens to a call arriving for any of your Bird numbers that has no inbound route of its own.

Show child attributes
inbound_configuration.route
object
required

The workspace's default inbound route. Defaults to "reject".

Show child attributes
daily_spend_limit
nullable object
required

The workspace's daily Voice spend limit and today's usage toward it. Null until your organization has a wallet, since amounts are in its currency.

Show child attributes

Related resources

Continue with the documentation, guides and examples for this topic.

Get an implementation brief