Sign inGet Started

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. 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
daily_spend_limit.currency_code
string
required

The organization's wallet currency, which every amount here is in.

daily_spend_limit.limit
nullable object
required

The daily limit calls are admitted against: the workspace limit when one is set, otherwise the default, and never more than max_limit. Null when there is no limit.

Show child attributes
daily_spend_limit.used
nullable object
required

Used toward today's limit, including calls in progress. A call counts its expected cost when it starts; the part it did not use returns when it is billed. Null when today's usage cannot be read right now; the limit is still enforced.

Show child attributes
daily_spend_limit.used.amount
string
required

Decimal amount as a string, in major currency units.

daily_spend_limit.used.currency_code
string
required

ISO 4217 currency code.

daily_spend_limit.remaining
nullable object
required

What is left of the limit today, never below zero. Null when there is no limit or today's usage cannot be read.

Show child attributes
daily_spend_limit.resets_at
string
required

When usage resets to zero, at midnight UTC.

daily_spend_limit.default_limit
nullable object
required

The daily limit a workspace has until it sets its own. Null when there is no default limit.

Show child attributes
daily_spend_limit.max_limit
nullable object
required

The highest daily limit this workspace can set. Null when there is no maximum.

Show child attributes
daily_spend_limit.workspace_limit
nullable object
required

The daily limit this workspace set for itself. Null when it uses the default.

Show child attributes

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