SIP Gateway

List SIP gateway Addresses

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 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.

get/api/fabric/resources/sip_gateways/{id}/addresses

Path parameters

idstring uuid required

Universal Unique Identifier.

The unique identifier of the SIP Gateway.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "name": "justice-league",
      "display_name": "Justice League",
      "cover_url": "https://coverurl.com",
      "preview_url": "https://previewurl.com",
      "locked": true,
      "channels": {
        "audio": "/external/resource_name?channel=audio"
      },
      "created_at": "2024-05-06T12:20:00Z",
      "type": "call"
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/sip_gateways/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/fabric/resources/sip_gateways/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50",
    "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",
    "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"
  }
}

Changes

No changes found, but 3 of the 161 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.