Sign inGet Started
Rozpocznij
Przewodniki
Referencja API
SDK
CLI
Baza wiedzy
Changelog

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);
}
Odpowiedź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.

Treść odpowiedzi

data
array of object
wymagane

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

Pokaż atrybuty podrzędne
data.country_code
string
wymagane
data.country_name
string
wymagane

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
wymagane

Whether your workspace has enabled calling to this country.

data.status
string
wymagane

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
wymagane

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

data.daily_spend_limit
nullable object
wymagane

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.

Pokaż atrybuty podrzędne
total
integer
wymagane

Total number of destination countries.

Powiązane zasoby

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.

Uzyskaj brief wdrożeniowy