Sign inGet Started

Update the voice settings

PATCH
/v1/voice/settings
const settings = await bird.voice.settings.update({
  inbound_configuration: { route: { type: "trunk", trunk_id: "spt_01krdgeqcxet5s7t44vh8rt9mg" } },
});
console.log(settings.inbound_configuration.route.type);
Response200
{
  "inbound_configuration": {
    "route": {
      "type": "reject"
    }
  }
}

Changes your workspace's voice settings. Omit a field to leave it as it is.

inbound_configuration.route applies to every Bird number that has no inbound route of its own, from the next call it receives. A number with its own route keeps it, and verified caller IDs receive no calls. The route is checked the same way as a number's: a trunk must be yours and have inbound calling enabled, and a forward target must be one of your verified caller IDs, otherwise the update returns 412. A trunk_id that is not one of your trunks returns 404. Deleting the trunk, or turning off its inbound calling, sets the default back to "reject".

Request Payload

inbound_configuration
object

The route for calls arriving on any of your Bird numbers that has no inbound route of its own; verified caller IDs receive no calls. It takes effect on the next call to each of those numbers. Numbers with their own route keep it.

Show child parameters

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
inbound_configuration.route
object
required

The workspace's default inbound route. Defaults to "reject".

Show child attributes

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