---
title: "Get the voice settings"
canonical: "https://bird.com/docs/api/reference/get-voice-settings"
---

# Get the voice settings

`GET /v1/voice/settings`

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.

## Code samples

**TypeScript**

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

Examples: [TypeScript](/docs/api/reference/get-voice-settings.ts.md) · [Python](/docs/api/reference/get-voice-settings.py.md) · [CLI](/docs/api/reference/get-voice-settings.cli.md) · [MCP](/docs/api/reference/get-voice-settings.mcp.md) · [cURL](/docs/api/reference/get-voice-settings.curl.md)

## Example response `200`

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

## Response body

- `inbound_configuration` (object, required): What happens to a call arriving for any of your Bird numbers that has no inbound route of its own.
- `inbound_configuration.route` (object, required): The workspace's default inbound route. Defaults to "reject".
  - Variant `reject`
    - `inbound_configuration.route.type` (string, required)

      Refuses the call. Setting it is how you stop a number answering without giving it up. It is also the default inbound route of a new workspace.

      Value: `reject`
  - Variant `trunk`
    - `inbound_configuration.route.type` (string, required)

      Delivers the call to one of your SIP trunks.

      Value: `trunk`
    - `inbound_configuration.route.trunk_id` (string, required): The SIP trunk that answers these calls. It must be one of yours and must have inbound calling enabled. Turning that trunk's inbound calling off, or deleting it, removes this route: a number returns to your workspace's default inbound route, and a workspace default becomes "reject".
  - Variant `forward`
    - `inbound_configuration.route.type` (string, required)

      Places a call to another of your numbers and connects the two.

      Value: `forward`
    - `inbound_configuration.route.forward_to` (string, required): The number calls are forwarded to, in E.164 format. It has to be one of your verified caller IDs. That is checked when you set it and again on every call it forwards, so a caller ID you later remove stops forwarding rather than carrying on.
    - `inbound_configuration.route.forward_as` (string, required)

      Which number the forwarded leg presents as its caller. Include the choice
      on every write. Reads return the effective choice; older configurations
      without a stored choice return `dialed_number`.

      Possible values: `dialed_number`, `calling_number`
  - Variant `sequence`
    - `inbound_configuration.route.type` (string, required)

      Runs the named sequence's active publication from the selected voice-call entry.

      Value: `sequence`
    - `inbound_configuration.route.sequence_id` (string, required): Named sequence whose active publication handles the call.
    - `inbound_configuration.route.entry_node_id` (string, required): Voice-call entry in the sequence's active publication.

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)