Skip to navigation
Resource ManagementFreeSWITCH Connector

Create FreeSWITCH connector

View as MarkdownOpen in Claude

Creates a resource for a FreeSWITCH deployment that has been connected with the supplied token. Use it when calls or messages should route to your own FreeSWITCH; use Create Relay application for a Relay Server SDK process, or Create SIP gateway for an external SIP destination.

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)

Request

This endpoint expects an object.
namestringRequired
Name of the FreeSWITCH Connector
tokenstringRequiredformat: "uuid"
FreeSWITCH token

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the FreeSWITCH Connector.
project_idstringformat: "uuid"
Unique ID of the Project.
display_namestring
Display name of the FreeSWITCH Connector 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.
freeswitch_connectorobject
FreeSWITCH Connector data.

Errors

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