List Relay applications

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/relay_applications

GET

/api/fabric/resources/relay_applications

curl https://{your_space_name}.signalwire.com/api/fabric/resources/relay_applications \
     -u "<project_id>:<api_token>"

{
  "data": [
    {
      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
      "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
      "display_name": "Customer Service Bot",
      "type": "relay_application",
      "created_at": "2024-05-06T12:20:00Z",
      "updated_at": "2024-05-06T12:20:00Z",
      "relay_application": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "Booking Assistant",
        "topic": "booking",
        "call_status_callback_url": "https://example.com/callbacks"
      }
    }
  ],
  "links": {
    "self": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=relay_application",
    "first": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&type=relay_application",
    "next": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=relay_application",
    "prev": "https://example.signalwire.com/api/fabric/resources/relay_applications/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=relay_application"
  }
}

Returns the project’s Relay Application resources, which route calls or messages to a Relay Server SDK application listening on a topic. Use it to discover topic-backed handlers before retrieving or changing one. Use a SWML Webhook for an HTTP server that returns instructions per request, or a Call Flow for a visual handler.

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.

Returns the project's Relay Application resources, which route calls or messages to a Relay Server SDK application listening on a topic. Use it to discover topic-backed handlers before retrieving or changing one. Use a [SWML Webhook](/docs/apis/rest/swml-webhook/list-swml-webhooks) for an HTTP server that returns instructions per request, or a [Call Flow](/docs/apis/rest/call-flows/list-call-flows) for a visual handler. #### 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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Response

The request has succeeded.

datalist of objects

An array of objects that contain a list of Relay Application data

linksobject

Object containing pagination links

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error