Create alias address
Creates an alias address that forwards to an existing resource in your project. name and resource_id are required; display_name defaults to name, channels to all three, codecs to none, and context to public. The handler resource can’t be changed later: to point an alias at a different resource, delete it and create a new one.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Calling, Fax, Messaging, or Video.
Authentication
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)
Request
URL-safe name for the alias — lowercase letters and numbers, with underscores or dashes in place of spaces. Dashes can’t start or end the name or appear twice in a row. Must be unique within its context and is used to build the alias’s address.
ID of the resource that handles calls and messages to this alias. Must reference a resource in your project. Cannot be changed after creation: to point an alias at a different resource, delete it and create a new one.
Human-friendly label for the alias. Defaults to name.
Access context to create the alias in. Defaults to public.
Response
The object type. Always alias.
URL-safe name for the alias. Used to build its address.
Human-friendly label for the alias. Defaults to name.
Codecs enabled for calls to this alias, or null when none are set.
The resource address this alias resolves to, in the form /<context>/<name>.