Sign inGet Started

Update enabled Voice destination countries

PATCH
/v1/voice/destinations
const destinations = await bird.voice.destinations.update({
  destinations: [{ country_code: "PT", enabled: true }],
});
console.log(destinations.data?.length ?? 0);
Réponse200
{
  "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"
      }
    }
  ]
}

Enables or disables specific destination countries for your workspace, and sets or removes their daily spend limits. Only the countries listed in the request change; any country you do not list keeps its current setting. Each code must be a country the Voice service supports, or the request is rejected and nothing changes; removing a daily spend limit is the exception and accepts any country code. A daily spend limit caps what your workspace spends on calls to a country each day, whether or not it is enabled.

Corps de la requête

destinations
array of object
obligatoire

The destination countries to change. Only the countries listed here change, and only the fields you send; anything else keeps its current setting. A country listed more than once takes its last enabled, but may set or remove daily_spend_limit only once. A limit can be set only on a country the Voice service supports; removing one accepts any country code. Otherwise the request is rejected and nothing changes.

Afficher les paramètres enfants

Contenu de la réponse

data
array of object
obligatoire

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

Afficher les attributs enfants
data.country_code
string
obligatoire
data.country_name
string
obligatoire

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
obligatoire

Whether your workspace has enabled calling to this country.

data.status
string
obligatoire

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
obligatoire

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

data.daily_spend_limit
nullable object
obligatoire

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.

Afficher les attributs enfants
total
integer
obligatoire

Total number of destination countries.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.