Sign inGet Started

List Voice destination countries

GET
/v1/voice/destinations
const destinations = await bird.voice.destinations.list();
for (const destination of destinations.data) {
  console.log(destination.country_code, destination.enabled, destination.status);
}
响应200
{
  "data": [
    {
      "country_code": "US",
      "country_name": "Netherlands",
      "dial_code": "31",
      "region": "western_europe",
      "super_region": "europe",
      "status": "available",
      "daily_spend_limit": {
        "limit": {
          "amount": "0.00995",
          "currency_code": "USD"
        },
        "used": {
          "amount": "0.00995",
          "currency_code": "USD"
        },
        "remaining": {
          "amount": "0.00995",
          "currency_code": "USD"
        },
        "resets_at": "2026-10-09T00:00:00Z"
      }
    }
  ]
}

Returns every country the Voice service supports, each annotated with whether your workspace has enabled calling to it, whether the platform supports calling it (status), and any daily spend limit you set for it with today's usage. A supported, enabled country still refuses calls once its daily_spend_limit.remaining reaches zero. Use this to render and manage your destination allowlist.

响应载荷

data
array of object
必填

The Voice destination countries, each annotated with your workspace's enabled setting.

显示子属性
data.country_code
string
必填
data.country_name
string
必填

Full English country name.

data.dial_code
string

International dialling prefix, without the leading plus. Absent for countries that have none.

data.region
nullable string
data.super_region
nullable string
data.enabled
boolean
必填

Whether your workspace has enabled calling to this country.

data.status
string
必填

This country's Voice callability at the destination level, independent of your enabled setting. available means we place calls there; not_supported means we do not.

Possible values (may grow over time): available, not_supported

data.high_risk_destination
boolean
必填

Whether we treat this country as a high-risk calling destination.

data.daily_spend_limit
nullable object
必填

Your workspace's daily spend limit for calls to this country and today's usage toward it. It applies whether or not the country is enabled, including to verification calls. Null when you have not set one, before your organization has a wallet, or while your wallet currency cannot be read; a limit you set is still enforced then.

显示子属性
data.daily_spend_limit.limit
object
必填

The most your workspace can spend on calls to this country each day, in your organization's wallet currency. Calls are also held to the workspace's own daily limit, and whichever is reached first refuses the call.

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

Used toward today's limit for this country, 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.

显示子属性
data.daily_spend_limit.used.amount
string
必填

Decimal amount as a string, in major currency units.

data.daily_spend_limit.used.currency_code
string
必填

ISO 4217 currency code.

data.daily_spend_limit.remaining
nullable object
必填

What is left of this country's limit today, never below zero. Null when today's usage cannot be read.

显示子属性
data.daily_spend_limit.resets_at
string
必填

When usage resets to zero, at midnight UTC.

total
integer
必填

Total number of destination countries.