Skip to main content

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​

The request has succeeded.

Schema

    id uuidrequired

    Universal Unique Identifier.

    name stringrequired

    Name of the Fabric Address.

    Example: justice-league
    display_name stringrequired

    Display name of the Fabric Address.

    Example: Justice League
    type DisplayTypes (string)required

    DisplayTypes

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

    cover_url stringrequired

    Cover url of the Fabric Address.

    Example: https://coverurl.com
    preview_url stringrequired

    Preview url of the Fabric Address.

    Example: https://previewurl.com
    locked booleanrequired

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

    Example: true

    channel

    object

    required

    oneOf

    audio stringrequired

    Audio Channel of Fabric Address

    Example: /external/resource_name?channel=audio
    created_at date-timerequired

    Fabric Address Creation Date.

    Example: 2024-05-06T12:20-12Z