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);
}

destinations = client.voice.destinations.list()
for destination in destinations.data:
    print(destination.country_code, destination.enabled, destination.status)

destinations, err := client.Voice.Destinations.List(context.Background())
if err != nil {
	log.Fatal(err)
}
for _, destination := range destinations.Data {
	fmt.Println(destination.CountryCode, destination.Enabled, destination.Status)
}

$destinations = $bird->voice->destinations->list();
foreach ($destinations->getData() ?? [] as $destination) {
    echo $destination->getCountryCode(), ' ', $destination->getEnabled() ? 'on' : 'off', "\n";
}

bird voice destinations list

curl -X GET "https://us1.platform.bird.com/v1/voice/destinations" \
  -H "Authorization: Bearer $TOKEN"

Réponse200

{
  "data": [
    {
      "country_code": "US",
      "country_name": "Netherlands",
      "dial_code": "31",
      "region": "western_europe",
      "super_region": "europe",
      "status": "available"
    }
  ]
}

Returns every country the Voice service supports, each annotated with whether your workspace has enabled calling to it and whether the country is currently callable. Use this to render and manage your destination allowlist.

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.

total

integer

obligatoire

Total number of destination countries.

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet. Les ressources sont en anglais.

Comprendre le conceptShould I use a Bird SDK or call the API directly?Suivre le parcours d'apprentissageBuild your first integration Guide d'implémentationSend your first email

Obtenir un guide d'implémentation

const destinations = await bird.voice.destinations.list();
for (const destination of destinations.data) {
  console.log(destination.country_code, destination.enabled, destination.status);
}

destinations = client.voice.destinations.list()
for destination in destinations.data:
    print(destination.country_code, destination.enabled, destination.status)

destinations, err := client.Voice.Destinations.List(context.Background())
if err != nil {
	log.Fatal(err)
}
for _, destination := range destinations.Data {
	fmt.Println(destination.CountryCode, destination.Enabled, destination.Status)
}

$destinations = $bird->voice->destinations->list();
foreach ($destinations->getData() ?? [] as $destination) {
    echo $destination->getCountryCode(), ' ', $destination->getEnabled() ? 'on' : 'off', "\n";
}

bird voice destinations list

curl -X GET "https://us1.platform.bird.com/v1/voice/destinations" \
  -H "Authorization: Bearer $TOKEN"

Réponse200

{
  "data": [
    {
      "country_code": "US",
      "country_name": "Netherlands",
      "dial_code": "31",
      "region": "western_europe",
      "super_region": "europe",
      "status": "available"
    }
  ]
}