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](/docs/apis/rest/phone-numbers/purchase-phone-number) or [Import phone number](/docs/apis/rest/phone-numbers/create-imported-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](/docs/platform/your-signalwire-api-space).

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.

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the Fabric Address.
namestring
Name of the Fabric Address.
display_namestring
Display name of the Fabric Address.
cover_urlstring
Cover url of the Fabric Address.
preview_urlstring
Preview url of the Fabric Address.
lockedboolean
Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls.
channelsobject
Channels of the Fabric Address.
created_atdatetime
Fabric Address Creation Date.
typeenum
The display type of a fabric address pointing to an application.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error