Get the voice settings

GET

/v1/voice/settings

const settings = await bird.voice.settings.get();
console.log(settings.inbound_configuration.route.type);

settings = client.voice.settings.get()
print(settings.inbound_configuration.route.root.type)

bird voice settings get

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

Response200

{
  "inbound_configuration": {
    "route": {
      "type": "reject"
    }
  }
}

Returns the voice settings for your workspace.

inbound_configuration.route is what happens to calls for every Bird number that has no inbound route of its own. Verified caller IDs receive no calls, so it never applies to them. It is "reject" until you change it.

Response Payload

inbound_configuration

object

required

What happens to a call arriving for any of your Bird numbers that has no inbound route of its own.

Show child attributes

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

const settings = await bird.voice.settings.get();
console.log(settings.inbound_configuration.route.type);

settings = client.voice.settings.get()
print(settings.inbound_configuration.route.root.type)

bird voice settings get

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

Response200

{
  "inbound_configuration": {
    "route": {
      "type": "reject"
    }
  }
}

Get the voice settings

Response Payload

Related resources