Create a SIP trunk

POST

/v1/voice/trunks

const trunk = await bird.voice.trunks.create({
  name: "Lisbon office",
  outbound_enabled: true,
  inbound_enabled: true,
});
console.log(trunk.id, trunk.domain);

trunk = client.voice.trunks.create(
    name="Lisbon office", outbound_enabled=True, inbound_enabled=True
)
print(trunk.id, trunk.domain)

trunk, err := client.Voice.Trunks.Create(context.Background(), bird.VoiceTrunksCreateParams{
	Name:            "Lisbon office",
	OutboundEnabled: bird.Ptr(true),
	InboundEnabled:  bird.Ptr(true),
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(trunk.Id, trunk.Domain)

$trunk = $bird->voice->trunks->create(
    (new VoiceTrunkCreate())->setName('Lisbon office')->setOutboundEnabled(true)->setInboundEnabled(true),
);
echo $trunk->getId(), ' ', $trunk->getDomain(), "\n";

bird voice trunks create \
  --digest-algorithms MD5 \
  --name 'Production PBX trunk' \
  --outbound-enabled=true

curl -X POST "https://us1.platform.bird.com/v1/voice/trunks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "digest_algorithms": [
      "MD5"
    ],
    "name": "Production PBX trunk",
    "outbound_enabled": true
  }'

Réponse201

{
  "id": "spt_01krdgeqcxet5s7t44vh8rt9mg",
  "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Production PBX trunk",
  "domain": "01kxp5bb9qf878642atrf0xy5r.trunk.eu1.sip.bird.com",
  "ip_acls": [
    {
      "id": "sta_01krdgeqcxet5s7t44vh8rt9mg",
      "trunk_id": "spt_01krdgeqcxet5s7t44vh8rt9mg",
      "cidr": "203.0.113.0/24",
      "description": "Office network"
    }
  ],
  "allowed_api_key_ids": [
    "key_01krdgeqcxet5s7t44vh8rt9mg"
  ],
  "ineligible_api_key_ids": [
    "key_01krdgeqcxet5s7t44vh8rt9mg"
  ],
  "digest_algorithms": [
    "SHA-256",
    "MD5"
  ],
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Provisions a new SIP trunk for the workspace. Bird assigns a unique domain for the trunk; use this domain as the SIP registrar or proxy address in your PBX or SIP client. Pass digest_algorithms when the PBX needs a specific Digest hash, such as MD5-only equipment. Otherwise the trunk offers Bird's default of SHA-256 then MD5.

Corps de la requête

name

string

obligatoire

A human-readable label for this SIP trunk. Mutable, and distinct from the generated wire domain.

outbound_enabled

boolean

Whether the new trunk may place calls. Omit it to create a trunk that does neither direction yet, and enable the ones you want once you know what the trunk is for. The settings below configure outbound, so send this as true alongside them.

inbound_enabled

boolean

Whether the new trunk may receive calls. Omit it to create a trunk that does neither direction yet. A trunk receives no calls until it also has at least one gateway and at least one number, both added after create.

media_bypass

boolean

Whether we take ourselves out of the audio path for calls we forward to this trunk. Omit it to create the trunk with this off, which is what suits equipment behind NAT and any account that wants call recording. It is an inbound setting, so true is accepted only alongside inbound_enabled: true; false is always accepted. It can be changed later.

digest_algorithms

array of string

The Digest hash algorithms to offer, in the order they should be offered. Omit this to use the default of ["SHA-256", "MD5"], which suits most equipment. Send ["MD5"] for a PBX that only implements MD5 and rejects or ignores a challenge offering SHA-256 first. This can be changed later without re-issuing credentials.

session_credentials_enabled

boolean

Whether a session credential may be used to connect to this trunk from a web browser, the CLI or MCP. Omit it to create the trunk with this off, which is what a trunk reached only by a PBX wants. It can be changed later.

Contenu de la réponse

string

obligatoire

Unique identifier for this SIP trunk.

workspace_id

string

obligatoire

name

string

obligatoire

A human-readable label for this SIP trunk. Mutable, and distinct from the generated wire domain.

domain

string

obligatoire

Full SIP address for this trunk, generated as {trunk-id}.trunk.{region}.sip.bird.com. This is the trunk's identity, so configure your PBX or SIP client to send calls to this address. It is derived from the trunk id and cannot be chosen or changed.

outbound_enabled

boolean

obligatoire

Whether this trunk may place calls: your PBX connects to us to dial out. Off on a new trunk. While it is off the trunk refuses every call attempt no matter what its allow lists say, and the connection and authentication settings below have no effect. Set outbound_enabled through the trunk update operation.

inbound_enabled

boolean

obligatoire

Whether this trunk may receive calls: we dial the addresses you declared, for the numbers this trunk answers. Off on a new trunk. Turning it off resets number routes that use this trunk to reject incoming calls. Turning it back on does not restore those routes. Set inbound_enabled through the trunk update operation.

media_bypass

boolean

obligatoire

Whether we take ourselves out of the audio path for calls we forward to this trunk: your equipment and the originating carrier exchange audio directly, and only the call signalling passes through us. Off by default. It applies to inbound calls alone (calls this trunk places are always carried through us, whatever this says). While it is on we cannot record those calls, report their audio quality, or end one because its audio stopped. Your equipment must be reachable for audio from the public internet. Set media_bypass through the trunk update operation.

ip_acls

array of object

obligatoire

The trunk's IP allow list. IP filtering is active whenever this has at least one entry: calls admitted through the allow lists must come from those CIDR ranges. This restriction does not apply to session credentials when session_credentials_enabled is true. An empty list means no IP restriction. Replace the whole ip_acls list through the trunk update operation.

Afficher les attributs enfants

ip_acls.id

string

obligatoire

Unique identifier for this IP ACL entry.

ip_acls.trunk_id

string

obligatoire

ip_acls.cidr

string

obligatoire

IPv4 or IPv6 CIDR block that is allowed to send SIP traffic to this trunk.

ip_acls.description

nullable string

Optional human-readable label for this ACL entry.

ip_acls.created_at

string

obligatoire

allowed_api_key_ids

array of string

obligatoire

The API keys allowed to authenticate this trunk over SIP Digest. A key must hold voice at write level and be neither revoked nor expired to authenticate. ineligible_api_key_ids names the entries that currently cannot. A nonempty list enables API-key authentication, limited to its eligible keys. An empty list means no API-key authentication. A trunk with empty ip_acls and allowed_api_key_ids lists accepts nothing when session_credentials_enabled is false. Replace the whole allowed_api_key_ids list through the trunk update operation.

ineligible_api_key_ids

array of string

obligatoire

The entries in allowed_api_key_ids that cannot authenticate this trunk right now because the key lacks voice at write level, has expired, or was revoked. The bindings remain until you remove them from the trunk. Restoring voice at write level makes a key eligible again if it is still unexpired and unrevoked, without changing its secret or trunk binding. Empty when every allowed key can authenticate.

digest_algorithms

array of string

obligatoire

The Digest hash algorithms this trunk offers, in the order they are offered. We send one challenge line per algorithm and your PBX answers with the first it supports, so the order decides what most equipment picks. Always populated: a trunk with no explicit setting reports the default, ["SHA-256", "MD5"]. A trunk answering with an algorithm that is not on this list is rejected, so narrowing the list also narrows what the trunk accepts. Replace digest_algorithms through the trunk update operation.

session_credentials_enabled

boolean

obligatoire

Whether a session credential may be used to connect to this trunk from a web browser, the CLI or MCP, alongside whatever the allow lists admit. Off by default. It grants nothing on its own: a call still has to present a credential issued to this workspace, and each one expires within minutes. Set session_credentials_enabled through the trunk update operation.

created_at

string

obligatoire

updated_at

string

obligatoire

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 trunk = await bird.voice.trunks.create({
  name: "Lisbon office",
  outbound_enabled: true,
  inbound_enabled: true,
});
console.log(trunk.id, trunk.domain);

trunk = client.voice.trunks.create(
    name="Lisbon office", outbound_enabled=True, inbound_enabled=True
)
print(trunk.id, trunk.domain)

trunk, err := client.Voice.Trunks.Create(context.Background(), bird.VoiceTrunksCreateParams{
	Name:            "Lisbon office",
	OutboundEnabled: bird.Ptr(true),
	InboundEnabled:  bird.Ptr(true),
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(trunk.Id, trunk.Domain)

$trunk = $bird->voice->trunks->create(
    (new VoiceTrunkCreate())->setName('Lisbon office')->setOutboundEnabled(true)->setInboundEnabled(true),
);
echo $trunk->getId(), ' ', $trunk->getDomain(), "\n";

bird voice trunks create \
  --digest-algorithms MD5 \
  --name 'Production PBX trunk' \
  --outbound-enabled=true

curl -X POST "https://us1.platform.bird.com/v1/voice/trunks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "digest_algorithms": [
      "MD5"
    ],
    "name": "Production PBX trunk",
    "outbound_enabled": true
  }'

Réponse201

{
  "id": "spt_01krdgeqcxet5s7t44vh8rt9mg",
  "workspace_id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Production PBX trunk",
  "domain": "01kxp5bb9qf878642atrf0xy5r.trunk.eu1.sip.bird.com",
  "ip_acls": [
    {
      "id": "sta_01krdgeqcxet5s7t44vh8rt9mg",
      "trunk_id": "spt_01krdgeqcxet5s7t44vh8rt9mg",
      "cidr": "203.0.113.0/24",
      "description": "Office network"
    }
  ],
  "allowed_api_key_ids": [
    "key_01krdgeqcxet5s7t44vh8rt9mg"
  ],
  "ineligible_api_key_ids": [
    "key_01krdgeqcxet5s7t44vh8rt9mg"
  ],
  "digest_algorithms": [
    "SHA-256",
    "MD5"
  ],
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}