Sign inGet Started

Get the voice settings

GET
/v1/voice/settings
const settings = await bird.voice.settings.get();
console.log(settings.inbound_configuration.route.type);
响应200
{
  "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.

响应载荷

inbound_configuration
object
必填

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

显示子属性
daily_spend_limit
nullable object
必填

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.

显示子属性
daily_spend_limit.currency_code
string
必填

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

daily_spend_limit.limit
nullable object
必填

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.

显示子属性
daily_spend_limit.used
nullable object
必填

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.

显示子属性
daily_spend_limit.remaining
nullable object
必填

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

显示子属性
daily_spend_limit.resets_at
string
必填

When usage resets to zero, at midnight UTC.

daily_spend_limit.default_limit
nullable object
必填

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

显示子属性
daily_spend_limit.default_limit.amount
string
必填

Decimal amount as a string, in major currency units.

daily_spend_limit.default_limit.currency_code
string
必填

ISO 4217 currency code.

daily_spend_limit.max_limit
nullable object
必填

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

显示子属性
daily_spend_limit.workspace_limit
nullable object
必填

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

显示子属性