Sign in
Alias Addresses

List alias addresses

Lists the alias addresses in your SignalWire project. An alias is a named route in the public or private context that forwards calls and messages to the resource it points at. SIP addresses and phone numbers are managed through their own operations.

Permissions

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

Learn more about API scopes.

get/api/fabric/alias_addresses

Query parameters

page_sizeinteger

The number of results per page.

page_numberinteger

The page index, used together with page_token.

page_tokenstring

Opaque cursor token from a previous response's links.next or links.prev. Begins with PA or PB.

Response

The request has succeeded.

items_countinteger required

The number of alias addresses in this page of results.

Example response

{
  "links": {
    "self": "https://example.signalwire.com/api/fabric/addresses/alias?page_number=0&page_size=50",
    "first": "https://example.signalwire.com/api/fabric/addresses/alias?page_number=0&page_size=50",
    "next": "https://example.signalwire.com/api/fabric/addresses/alias?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca",
    "prev": "https://example.signalwire.com/api/fabric/addresses/alias?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  },
  "items_count": 1,
  "data": [
    {
      "type": "alias",
      "name": "support",
      "display_name": "Support Line",
      "channels": [
        "audio",
        "messaging",
        "video"
      ],
      "codecs": [],
      "uri": "/public/support",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z"
    }
  ]
}

Changes

Changed in 1 of the 161 revisions of this API.1

Of the 161 revisions, 3 have a changelog that could not be searched.