list_addresses | SignalWire

List addresses associated with a SIP endpoint resource.

Path parameters

idstringRequiredformat: "uuid"

The unique identifier of the SIP Endpoint.

Response

datalist of objectsRequired

An array of objects that contain a list of SIP Endpoint 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_endpoints/7ecfd15a-fb9a-45a4-9b89-c0740a44c593/addresses?page_number=0&page_size=50&type=sip_endpoint",
19     "first": "https://example.signalwire.com/api/fabric/resources/sip_endpoints/7ecfd15a-fb9a-45a4-9b89-c0740a44c593/addresses?page_size=50&type=sip_endpoint",
20     "next": "https://example.signalwire.com/api/fabric/resources/sip_endpoints/7ecfd15a-fb9a-45a4-9b89-c0740a44c593/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=sip_endpoint",
21     "prev": "https://example.signalwire.com/api/fabric/resources/sip_endpoints/7ecfd15a-fb9a-45a4-9b89-c0740a44c593/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=sip_endpoint"
22   }
23 }

Example

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