Addresses

Get Resource Address from a Client

Retrieves one resource address visible to the authenticated Subscriber by address ID. Use it when a subscriber client already holds a callable address identifier; use List Resource Addresses from a Client to discover visible addresses. Authenticate with a Subscriber Access Token (SAT), not a project API token.

Resource addresses are callable handles, not standalone SIP Address configurations or physical E911 Addresses.

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.

get/api/fabric/addresses/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/addresses/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a FabricAddress.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring required

Name of the Fabric Address.

display_namestring required

Display name of the Fabric Address.

cover_urlstring required

Cover url of the Fabric Address.

preview_urlstring required

Preview url of the Fabric Address.

lockedboolean required

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

created_atstring date-time required

Fabric Address Creation Date.

type'app' | 'room' | 'call' | 'subscriber' required

DisplayTypes

Example response

{
  "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"
}

Changes

No operation changes found yet. Some revisions have not been checked.