List a SIP trunk's gateways

GET

/v1/voice/trunks/{trunk_id}/gateways

const gateways = await bird.voice.trunks.gateways.list("TRUNK_ID");
for (const gateway of gateways.data) {
  console.log(gateway.id, gateway.priority);
}

gateways = client.voice.trunks.gateways.list("TRUNK_ID")
for gateway in gateways.data:
    print(gateway.id, gateway.priority)

gateways, err := client.Voice.Trunks.Gateways.List(context.Background(), "TRUNK_ID")
if err != nil {
	log.Fatal(err)
}
for _, gateway := range gateways.Data {
	fmt.Println(gateway.Id, gateway.Priority)
}

$gateways = $bird->voice->trunks->gateways->list('TRUNK_ID');
foreach ($gateways->getData() ?? [] as $gateway) {
    echo $gateway->getId(), ' ', $gateway->getPriority(), "\n";
}

bird voice trunks gateways list <trunk-id>

curl -X GET "https://us1.platform.bird.com/v1/voice/trunks/{trunk_id}/gateways" \
  -H "Authorization: Bearer $TOKEN"

响应200

{
  "data": [
    {
      "id": "vtg_01krdgeqcxet5s7t44vh8rt9mg",
      "trunk_id": "spt_01krdgeqcxet5s7t44vh8rt9mg",
      "sip_uri": "sip:pbx.example.com:5060",
      "priority": 0,
      "origination_format": "+{number}",
      "destination_format": "+{number}",
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z"
    }
  ]
}

Returns the gateway addresses used to forward inbound calls to this trunk, ordered by priority. A trunk with no gateway refuses inbound calls. Returns a 404 Not Found error if the trunk does not exist in the workspace.

Returns the complete collection without pagination, including any pre-existing gateways above the current limit of 20. Reads are available when inbound calling is disabled.

参数

trunk_id

string

响应载荷

data

array of object

必填

The trunk's gateways, in priority order.

显示子属性

data.id

string

必填

Unique identifier for this gateway.

data.trunk_id

string

必填

data.sip_uri

string

必填

SIP URI an inbound call to this trunk is forwarded to. The host only: which number is dialed at that host comes from destination_format, because it changes with every call.

data.priority

integer

必填

The order gateways are tried in, lowest first. Gateways sharing a priority take an equal share of calls, and any of them may be tried first on a given call.

data.origination_format

string

必填

How the calling number is spelled to this gateway, as a template whose {number} stands for the number without its leading +. It is stated in the P-Asserted-Identity header of the delivered call.

A gateway that has not asked for anything else reports +{number}, which is E.164. A format with no {number} states that same identity on every call, whoever called.

data.destination_format

string

必填

How this gateway formats the dialed number. In the template, {number} represents the number without its leading +. The result is placed before the sip_uri host. For example, 1234#{number} formats +31201234567 as sip:1234#31201234567@pbx.example.com:5060.

A gateway that has not asked for anything else reports +{number}, which is E.164. A format with no {number} is dialed as it stands, so every number the trunk answers reaches that one number.

data.created_at

string

必填

data.updated_at

string

必填

相关资源

继续查阅此主题的文档、指南和示例。资源为英文。

理解概念Should I use a Bird SDK or call the API directly?跟随学习路径Build your first integration 实施指南Send your first email

获取实施简报

const gateways = await bird.voice.trunks.gateways.list("TRUNK_ID");
for (const gateway of gateways.data) {
  console.log(gateway.id, gateway.priority);
}

gateways = client.voice.trunks.gateways.list("TRUNK_ID")
for gateway in gateways.data:
    print(gateway.id, gateway.priority)

gateways, err := client.Voice.Trunks.Gateways.List(context.Background(), "TRUNK_ID")
if err != nil {
	log.Fatal(err)
}
for _, gateway := range gateways.Data {
	fmt.Println(gateway.Id, gateway.Priority)
}

$gateways = $bird->voice->trunks->gateways->list('TRUNK_ID');
foreach ($gateways->getData() ?? [] as $gateway) {
    echo $gateway->getId(), ' ', $gateway->getPriority(), "\n";
}

bird voice trunks gateways list <trunk-id>

curl -X GET "https://us1.platform.bird.com/v1/voice/trunks/{trunk_id}/gateways" \
  -H "Authorization: Bearer $TOKEN"

响应200

{
  "data": [
    {
      "id": "vtg_01krdgeqcxet5s7t44vh8rt9mg",
      "trunk_id": "spt_01krdgeqcxet5s7t44vh8rt9mg",
      "sip_uri": "sip:pbx.example.com:5060",
      "priority": 0,
      "origination_format": "+{number}",
      "destination_format": "+{number}",
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z"
    }
  ]
}