Create Relay Application

import requests
url = "https://{your_space_name}.signalwire.com/api/fabric/resources/relay_applications"
payload = {
    "name": "Booking Assistant",
    "topic": "booking"
}
headers = {
    "Authorization": "Basic <project_id>:<api_token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "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"
  }
}

Creates a Relay Application

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.

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) ```

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

Allowed values:

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.

Permissions

Authentication

Request

Response

Errors