FreeSWITCH Connector

Update FreeSWITCH connector

Changes how a connected FreeSWITCH deployment is identified when SignalWire routes communications through it. Relay Applications and SIP Gateways have separate update operations.

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.

put/api/fabric/resources/freeswitch_connectors/{id}

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a FreeSWITCH Connector.

Request body

namestring

Name of the FreeSWITCH Connector

caller_idstring

Caller ID for the connector

send_asstring

Send as identifier

Example request

{
  "name": "Booking Assistant",
  "caller_id": "123456",
  "send_as": "123456"
}

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 FreeSWITCH Connector Fabric Resource

type'freeswitch_connector' 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": "Main FreeSWITCH Server",
  "type": "freeswitch_connector",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "freeswitch_connector": {
    "name": "Booking Assistant",
    "caller_id": "123456",
    "send_as": "123456"
  }
}

Changes

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