Sign inGet Started
Jetzt starten
Anleitungen
API-Referenz
SDKs
CLI
Wissensdatenbank
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);
}
Antwort200
{
  "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.

Antwort-Payload

data
array of object
erforderlich

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

Untergeordnete Attribute anzeigen
data.country_code
string
erforderlich

ISO 3166-1 alpha-2 country code.

data.country_name
string
erforderlich

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

The commercial region this country belongs to, for grouping a destination list the way it is bought rather than alphabetically. null for a country we have not assigned yet. Bird defines these regions independently of ISO and UN M49. A country can move between them, so treat the set as open.

Possible values (may grow over time): western_europe, nordics_baltics, southern_europe, central_eastern_europe, north_america, latin_america_caribbean, middle_east_north_africa, sub_saharan_africa, central_asia_caucasus, south_asia, south_east_asia, east_asia, oceania

data.super_region
nullable string

The continent-scale group the region rolls up into. Derived from region, and null whenever that is. Treat the set as open.

Possible values (may grow over time): europe, americas, middle_east_africa, asia_pacific

data.enabled
boolean
erforderlich

Whether your workspace has enabled calling to this country.

data.status
string
erforderlich

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
erforderlich

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

data.daily_spend_limit
nullable object
erforderlich

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.

Untergeordnete Attribute anzeigen
data.daily_spend_limit.limit
object
erforderlich

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.

Untergeordnete Attribute anzeigen
data.daily_spend_limit.used
nullable object
erforderlich

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.

Untergeordnete Attribute anzeigen
data.daily_spend_limit.remaining
nullable object
erforderlich

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

Untergeordnete Attribute anzeigen
data.daily_spend_limit.remaining.amount
string
erforderlich

Decimal amount as a string, in major currency units.

data.daily_spend_limit.remaining.currency_code
string
erforderlich

ISO 4217 currency code.

data.daily_spend_limit.resets_at
string
erforderlich

When usage resets to zero, at midnight UTC.

total
integer
erforderlich

Total number of destination countries.

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Implementierungs-Briefing erhalten