Get Fabric Address

GET 
/addresses/:id

Returns a Fabric Address by ID. This endpoint uses the bearer token authentication method with the SAT (Subscriber Access Token) wich can be generated using the Create Subscriber Token endpoint.

Request

Path Parameters

id uuidrequired

Unique ID of a FabricAddress.

Responses

200

The request has succeeded.

application/json

Schema

Schema

iduuidrequired

Universal Unique Identifier.

namestringrequired
Name of the Fabric Address.
Example: justice-league
display_namestringrequired
Display name of the Fabric Address.
Example: Justice League
typeDisplayTypes (string)required

DisplayTypes

Possible values: [app, room, call, subscriber]

cover_urlstringrequired
Cover url of the Fabric Address.
Example: https://coverurl.com
preview_urlstringrequired
Preview url of the Fabric Address.
Example: https://previewurl.com
lockedbooleanrequired
Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls.
Example: true

channel

object

required

oneOf

AudioChannel

audiostringrequired

Audio Channel of Fabric Address

Example: /external/resource_name?channel=audio

MessagingChannel

messagingstringrequired

Messaging Channel of Fabric Address

Example: /external/resource_name?channel=messaging

VideoChannel

videostringrequired

Video Channel of Fabric Address

Example: /external/resource_name?channel=video
created_atdate-timerequired
Fabric Address Creation Date.
Example: 2024-05-06T12:20-12Z

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "justice-league",
  "display_name": "Justice League",
  "type": "app",
  "cover_url": "https://coverurl.com",
  "preview_url": "https://previewurl.com",
  "locked": true,
  "channel": {
    "audio": "/external/resource_name?channel=audio"
  },
  "created_at": "2024-05-06T12:20-12Z"
}

401

Access is unauthorized.

application/json

Schema

Schema

string

Possible values: [Unauthorized]

404

The server cannot find the requested resource.

application/json

Schema

Schema

string

Possible values: [Not Found]