List Fabric Addresses

GET 
/addresses

A list of Fabric Addresses. 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

Responses

200

The request has succeeded.

application/json

Schema

Schema

data

object[]

required

Array [

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

]

links

object

required

selfurirequired

Link of the current page

Example: https://{space_name}.signalwire.com/api/fabric/addresses?page_number=0&page_size=50

firsturirequired

Link to the first page

Example: https://{space_name}.signalwire.com/api/fabric/addresses?page_number=0&page_size=50

nexturirequired

Link to the next page

Example: https://{space_name}.signalwire.com/api/fabric/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca

Example (from schema)

{
  "data": [
    {
      "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"
    }
  ],
  "links": {
    "self": "https://{space_name}.signalwire.com/api/fabric/addresses?page_number=0&page_size=50",
    "first": "https://{space_name}.signalwire.com/api/fabric/addresses?page_number=0&page_size=50",
    "next": "https://{space_name}.signalwire.com/api/fabric/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  }
}

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]