Get a SIP trunk
GET
/v1/voice/trunks/{trunk_id}
const trunk = await bird.voice.trunks.get("trunk-id");
console.log(trunk.name, trunk.inbound_enabled, trunk.outbound_enabled);trunk = client.voice.trunks.get("trunk-id")
print(trunk.name, trunk.inbound_enabled, trunk.outbound_enabled)trunk, err := client.Voice.Trunks.Get(context.Background(), "trunk-id")
if err != nil {
log.Fatal(err)
}
fmt.Println(trunk.Name, trunk.InboundEnabled, trunk.OutboundEnabled)$trunk = $bird->voice->trunks->get('trunk-id');
echo $trunk->getName(), ' ', $trunk->getInboundEnabled() ? 'in' : '-', "\n";bird voice trunks get <trunk-id>curl -X GET "https://us1.platform.bird.com/v1/voice/trunks/{trunk_id}" \
-H "Authorization: Bearer $TOKEN"响应200
{
"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"
}
Returns a single SIP trunk, including its Bird-assigned domain, its access control lists. Returns a 404 not_found_error if the trunk does not exist in the workspace.
参数
trunk_id
string
响应载荷
id
string
必填
Unique identifier for this SIP trunk.
workspace_id
string
必填
name
string
必填
A human-readable label for this SIP trunk. Mutable, and distinct from the generated wire domain.
domain
string
必填
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
必填
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
必填
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
必填
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
必填
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.
显示子属性
ip_acls.id
string
必填
Unique identifier for this IP ACL entry.
ip_acls.trunk_id
string
必填
ip_acls.cidr
string
必填
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
必填
allowed_api_key_ids
array of string
必填
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
必填
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
必填
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
必填
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
必填
updated_at
string
必填