Skip to navigation
Resource ManagementAlias Addresses

Get alias address

View as MarkdownOpen in Claude

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.

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)

Path parameters

idstringRequiredformat: "uuid"
Unique ID of an alias address.

Response

The request has succeeded.
idstringformat: "uuid"
Unique identifier for the alias address.
typeenum

The object type. Always alias.

Allowed values:
resource_idstringformat: "uuid"
ID of the resource that handles calls and messages to this alias.
namestring

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

display_namestring

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

display_typeenum
Display type derived from the handler resource. Returned for reference only and cannot be set.
Allowed values:
channelslist of enums
Channels enabled on this alias.
Allowed values:
codecslist of enums
Codecs enabled for calls to this alias. Empty when none are set.
contextenum
Access context the alias lives in.
Allowed values:
uristring

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

created_atdatetime
Date and time when the alias address was created.
updated_atdatetime
Date and time when the alias address was last updated.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error