Resource ManagementRelay Application

Create Relay application

View as MarkdownOpen in Claude
Creates a resource that routes calls or messages to a Relay Server SDK application listening on the configured topic. Use it when your long-running server application will handle events through the Relay SDK; use [Create SWML webhook](/docs/apis/rest/swml-webhook/create-swml-webhook) for request-and-response HTTP handling, or [Create call flow](/docs/apis/rest/call-flows/create-call-flow) for visual call logic. #### 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) ```

Request

This endpoint expects an object.
namestringRequired
Name of the Relay Application
topicstringRequired
Topic of the Relay Application
call_status_callback_urlstringOptional
Call status callback URL

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the Relay Application.
project_idstringformat: "uuid"
Unique ID of the Project.
display_namestring
Display name of the Relay Application Fabric Resource
typeenum
Type of the Fabric Resource
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
relay_applicationobject
Relay Application data.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error