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

Update the voice settings

PATCH
/v1/voice/settings
const settings = await bird.voice.settings.update({
  inbound_configuration: { route: { type: "trunk", trunk_id: "spt_01krdgeqcxet5s7t44vh8rt9mg" } },
});
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"
    }
  }
}

Changes your workspace's voice settings. Omit a field to leave it as it is.

inbound_configuration.route applies to every Bird number that has no inbound route of its own, from the next call it receives. A number with its own route keeps it, and verified caller IDs receive no calls. The route is checked the same way as a number's: a trunk must be yours and have inbound calling enabled, and a forward target must be one of your verified caller IDs, otherwise the update returns 412. A trunk_id that is not one of your trunks returns 404. A ring_group_id that is not one of your ring groups or the default group returns 422. Deleting the trunk, or turning off its inbound calling, sets the default back to "reject".

daily_spend_limit.workspace_limit sets your workspace's own daily spend limit. It can be above or below default_limit, up to max_limit, and must be in your organization's wallet currency, otherwise the update returns 422. An organization without a wallet cannot set a limit yet and gets 422 until it has one. Null removes it so the default applies. Calls already in progress are never ended; the limit applies from the next call.

Request Payload

inbound_configuration
object

The route for calls arriving on any of your Bird numbers that has no inbound route of its own; verified caller IDs receive no calls. It takes effect on the next call to each of those numbers. Numbers with their own route keep it.

Show child parameters
daily_spend_limit
object
Show child parameters

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
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