Sign in
Alias Addresses

Get alias address

Retrieves one alias address from your SignalWire project by ID. Use List alias addresses to find IDs. An ID that belongs to a different kind of address, such as a SIP address, returns a 404.

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/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of an alias address.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

type'alias' required

The object type. Always alias.

resource_idstring uuid required

Universal Unique Identifier.

namestring required

URL-safe name for the alias. Used to build its address.

display_namestring required

Human-friendly label for the alias. Defaults to name.

display_type'app' | 'room' | 'call' | 'subscriber' required

DisplayTypes

channelsAliasAddressChannel[] required

Channels enabled on this alias.

codecsAddressCodec[] required

Codecs enabled for calls to this alias. Empty when none are set.

context'public' | 'private' required

Access context an alias address lives in.

uristring required

The resource address this alias resolves to, in the form /<context>/<name>.

created_atstring date-time required

Date and time when the alias address was created.

updated_atstring date-time required

Date and time when the alias address was last updated.

Example response

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