REST ClientFabricSIP Gateways

list

View as MarkdownOpen in Claude

List SIP gateway resources in the project.

Response

datalist of objectsRequired
An array of objects that contain a list of SIP Gateway data

Response Example

Response
1{
2  "data": [
3    {
4      "id": "0823a606-0aff-4c90-9eba-f88ba118fe05",
5      "project_id": "bc949800-7b40-43cf-8438-a85facfcbdd1",
6      "display_name": "My SIP Gateway",
7      "type": "sip_gateway",
8      "created_at": "2024-05-06T12:20:00Z",
9      "updated_at": "2024-05-06T12:20:00Z",
10      "sip_gateway": {
11        "id": "cce59cad-104d-4c28-ada4-98cfd102ae09",
12        "uri": "user3@domain.com",
13        "name": "My SIP Gateway",
14        "ciphers": [
15          "AEAD_AES_256_GCM_8"
16        ],
17        "codecs": [
18          "OPUS"
19        ],
20        "encryption": "required"
21      }
22    }
23  ],
24  "links": {
25    "self": "https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=0&page_size=50",
26    "first": "https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=0&page_size=50",
27    "next": "https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
28    "prev": "https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
29  }
30}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com",
7});
8
9const response = await client.fabric.sipGateways.list();
10for (const gateway of response.data ?? []) {
11  console.log(`${gateway.display_name}: ${gateway.id}`);
12}