List SIP gateway Addresses

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways/:id/addresses

GET

/api/fabric/resources/sip_gateways/:id/addresses

$ curl https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways/id/addresses \
>      -u "<project_id>:<api_token>"

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 }

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Returns the project-scoped resource addresses assigned to one SIP Gateway. Use these callable handles to see how calls can reach the gateway and continue to its external SIP destination; use [Get SIP gateway](/docs/apis/rest/sip-gateway/get-sip-gateway) for destination and media settings, or the SIP Credential address operation for a registering device. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

The unique identifier of the SIP Gateway.

Response

The request has succeeded.

datalist of objects

An array of objects containing a list of SIP Gateway Addresses

linksobject

Object containing pagination links

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error