Skip to navigation
Resource ManagementPhone Routes

Assign Resource to phone route

View as MarkdownOpen in Claude

Assigns an existing Fabric resource as a phone number’s calling or messaging handler. Use it when inbound traffic to an owned number should run an AI Agent, script, Call Flow, Relay Application, or another resource. This operation does not purchase or import the number; use Purchase phone number or Import phone number first when needed.

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.

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"
The unique identifier of the Resource.

Request

This endpoint expects an object.
phone_route_idstringRequiredformat: "uuid"
The id of the phone route.
handlerenumRequired

Indicates if the resource should be assigned to a calling or messaging handler.

Allowed values:

Response

The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
Unique ID of the Fabric Address.
resource_idstringformat: "uuid"
Unique ID of the resource the address routes to.
namestring
Name of the Fabric Address.
display_namestring
Display name of the Fabric Address.
cover_urlstring or null

Cover URL of the Fabric Address, or null when the resource has no cover image.

preview_urlstring or null

Preview URL of the Fabric Address, or null when no preview is available. Only Conference Room addresses return one, while a session with room previews enabled is in progress.

lockedboolean
Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls.
channelsobject
Channels of the Fabric Address.
canonical_uristring or null

The address in canonical form: /<context>/<name> for a resource address, sip:<domain> for a SIP address, or the E.164 number for a phone number or WhatsApp number address. null when the phone number, WhatsApp number, or SIP domain behind the address no longer exists.

typeenum
The display type of a fabric address pointing to an application.
Allowed values:

Errors

422
Unprocessable Entity Error
500
Internal Server Error