For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • BedrockAgent
      • CLI Tools
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions
      • LiveWire
      • MCP Gateway
      • PomBuilder
      • Prefabs
      • Search
      • SkillBase
      • Skills
      • SWAIGFunction
      • SWMLBuilder
      • SWMLService
      • WebService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • Chat
      • Compat
      • Datasphere
      • Fabric
        • Addresses
        • AI Agents
        • Call Flows
        • Conference Rooms
        • cXML Applications
        • cXML Scripts
        • cXML Webhooks
        • FreeSWITCH Connectors
        • RELAY Applications
        • Resources
        • SIP Endpoints
        • SIP Gateways
          • create
          • delete
          • get
          • list
          • list_addresses
          • update
        • Subscribers
        • SWML Scripts
        • SWML Webhooks
        • Tokens
      • Imported Numbers
      • Logs
      • Lookup
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSub
      • Queues
      • Recordings
      • Registry
      • RestClient
      • Short Codes
      • SignalWireRestError
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Response Example
  • Example
REST ClientFabricSIP Gateways

list_addresses

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

update

Next
Built with

List addresses associated with a SIP gateway resource.

Path parameters

idstringRequiredformat: "uuid"
The unique identifier of the SIP Gateway.

Response

datalist of objectsRequired
An array of objects containing a list of SIP Gateway Addresses
linksobjectRequired
Object containing pagination links

Response Example

Response
1{
2 "data": [
3 {
4 "id": "691af061-cd86-4893-a605-173f47afc4c2",
5 "name": "justice-league",
6 "display_name": "Justice League",
7 "cover_url": "https://coverurl.com",
8 "preview_url": "https://previewurl.com",
9 "locked": true,
10 "channels": {
11 "audio": "/external/resource_name?channel=audio"
12 },
13 "created_at": "2024-05-06T12:20:00Z",
14 "type": "call"
15 }
16 ],
17 "links": {
18 "self": "https://example.signalwire.com/api/fabric/resources/sip_gateways/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50",
19 "first": "https://example.signalwire.com/api/fabric/resources/sip_gateways/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50",
20 "next": "https://example.signalwire.com/api/fabric/resources/sip_gateways/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
21 "prev": "https://example.signalwire.com/api/fabric/resources/sip_gateways/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
22 }
23}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4 project="your-project-id",
5 token="your-api-token",
6 host="your-space.signalwire.com",
7)
8
9addresses = client.fabric.sip_gateways.list_addresses("gateway-id")
10for addr in addresses.get("data", []):
11 print(f"{addr['display_name']}: {addr['id']}")