List Relay Application Addresses

GET 
/resources/relay_applications/:id/addresses

Returns a list of Relay Application addresses.

Request

Path Parameters

id uuidrequired

The ID of the Relay Application

Responses

200

A list of Relay Application addresses

application/json

Schema

Schema

links

object

self uri

Example: https://{space_name}.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_size=50

first uri

Example: https://{space_name}.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_size=50

next uri

Example: https://{space_name}.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=1&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad

prev uri

Example: https://{space_name}.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad

data

object[]

Array [

id uuid

Example: 993ed018-9e79-4e50-b97b-984bd5534095

resource_id uuid

Example: 993ed018-9e79-4e50-b97b-984bd5534095

name string

Example: reception

display_name string

Example: Reception

type string

Example: room

cover_url uri

Example: https://example.com/cover.jpg

preview_url uri

Example: https://example.com/preview.jpg

channels

object

video uri

Example: /public/reception?channel=video

audio uri

Example: /public/reception?channel=audio

messaging uri

Example: /public/reception?channel=messaging

]

Example (from schema)

{
  "links": {
    "self": "https://{space_name}.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_size=50",
    "first": "https://{space_name}.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_size=50",
    "next": "https://{space_name}.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=1&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad",
    "prev": "https://{space_name}.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad"
  },
  "data": [
    {
      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "resource_id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "name": "reception",
      "display_name": "Reception",
      "type": "room",
      "cover_url": "https://example.com/cover.jpg",
      "preview_url": "https://example.com/preview.jpg",
      "channels": {
        "video": "/public/reception?channel=video",
        "audio": "/public/reception?channel=audio",
        "messaging": "/public/reception?channel=messaging"
      }
    }
  ]
}