Sign in
Relay Application

Create Relay application

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 for request-and-response HTTP handling, or 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.

post/api/fabric/resources/relay_applications

Request body

namestring required

Name of the Relay Application

topicstring required

Topic of the Relay Application

call_status_callback_urlstring

Call status callback URL

Example request

{
  "name": "Booking Assistant",
  "topic": "booking",
  "call_status_callback_url": "https://booking.com/callbacks"
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

project_idstring uuid required

Universal Unique Identifier.

display_namestring required

Display name of the Relay Application Fabric Resource

type'relay_application' required

Type of the Fabric Resource

created_atstring date-time required

Date and time when the resource was created.

updated_atstring date-time required

Date and time when the resource was updated.

Example response

{
  "display_name": "Customer Service Bot",
  "type": "relay_application",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "relay_application": {
    "name": "Booking Assistant",
    "topic": "booking",
    "call_status_callback_url": "https://example.com/callbacks"
  }
}

Changes

No changes found, but 3 of the 138 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.