assignPhoneRoute | SignalWire

Assign a phone route to a Fabric resource.

Path parameters

idstringRequiredformat: "uuid"

The unique identifier of the Resource.

Request

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

idstringRequiredformat: "uuid"

Unique ID of the Fabric Address.

namestringRequired

Name of the Fabric Address.

display_namestringRequired

Display name of the Fabric Address.

cover_urlstringRequired

Cover url of the Fabric Address.

preview_urlstringRequired

Preview url of the Fabric Address.

lockedbooleanRequired

Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls.

channelsobjectRequired

Channels of the Fabric Address.

created_atdatetimeRequired

Fabric Address Creation Date.

typeenumRequired

The display type of a fabric address pointing to an application.

Response Example

Response

{
  "id": "691af061-cd86-4893-a605-173f47afc4c2",
  "name": "justice-league",
  "display_name": "Justice League",
  "cover_url": "https://coverurl.com",
  "preview_url": "https://previewurl.com",
  "locked": true,
  "channels": {
    "audio": "/external/resource_name?channel=audio"
  },
  "created_at": "2024-05-06T12:20:00Z",
  "type": "app"
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
const result = await client.fabric.resources.assignPhoneRoute("resource-id", {
  phone_route_id: "route-uuid",
  handler: "calling"
});
console.log(`Phone route assigned: ${result.id}`);