Appearance
Infrastructure
FreshGet Resource Address from a Client
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Returns a resource address by ID. This endpoint uses bearer token authentication with a SAT ( Subscriber Access Token), which can be generated using the Create Subscriber Token endpoint.
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
AuthorizationBearer
SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer followed by a space and the subscriber token.
Example:
Authorization: Bearer <subscriber_token>Path parameters
idstringRequiredformat: "uuid"
Unique ID of a FabricAddress.
Response
The request has succeeded.
idstringformat: "uuid"
Unique ID of the Fabric Address.
namestring
Name of the Fabric Address.
display_namestring
Display name of the Fabric Address.
cover_urlstring
Cover url of the Fabric Address.
preview_urlstring
Preview url of the Fabric Address.
lockedboolean
Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls.
channelsobject
Channels of the Fabric Address.
Show 3 variants
created_atdatetime
Fabric Address Creation Date.
typeenum
DisplayTypes
Allowed values:approomcallsubscriber
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List Resource Addresses
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
This endpoint is used to retrieve addresses associated with a specific Resource.
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)Path parameters
idstringRequiredformat: "uuid"
The unique identifier of the Resource.
Response
The request has succeeded.
datalist of objects
An array opf objects that contain a list of Resource Addresses
linksobject
Object containing pagination links
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List Resource Addresses from a Client
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Lists resource addresses visible to the authenticated subscriber. This endpoint uses bearer token authentication with a SAT (Subscriber Access Token), which can be generated using the Create Subscriber Token endpoint.
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
AuthorizationBearer
SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer followed by a space and the subscriber token.
Example:
Authorization: Bearer <subscriber_token>Response
The request has succeeded.
datalist of objects
An array of objects containing a list of Resource Addresses
linksobject
Object containing pagination links
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Delete Resource
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Deletes a Resource by ID
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)Path parameters
idstringRequiredformat: "uuid"
Unique ID of a Resource.
Response
There is no content to send for this request, but the headers may be useful.
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Get Resource
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Returns a Resource by ID
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)Path parameters
idstringRequiredformat: "uuid"
Unique ID of a Resource.
Response
The request has succeeded.
AI Agentobject
Show 7 properties
OR
Call Flowobject
Show 7 properties
OR
cXML Webhookobject
Show 7 properties
OR
cXML Scriptobject
Show 7 properties
OR
cXML Applicationobject
Show 7 properties
OR
Dialogflow Agentobject
Show 7 properties
OR
FreeSWITCH Connectorobject
Show 7 properties
OR
Relay Applicationobject
Show 7 properties
OR
SIP Endpointobject
Show 7 properties
OR
SIP Gatewayobject
Show 7 properties
OR
Subscriberobject
Show 7 properties
OR
SWML Webhookobject
Show 7 properties
OR
SWML Scriptobject
Show 7 properties
OR
Conference Roomobject
Show 7 properties
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List Resources
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
A list of Fabric Resources
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)Response
The request has succeeded.
datalist of objects
An array of objects that contain a list of Resource data
Show 14 variants
linksobject
Object containing pagination links
Show 4 properties
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Get SIP profile
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Retrieves the SIP profile settings for your project.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.
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)Response
The request has succeeded.
domainstring
A string representation of the fully qualified domain name for this profile.
domain_identifierstring
String representing the domain_identifier portion of the profile. Must be unique across your project.
default_codecslist of strings
A list of codecs this profile will support. Currently supported values are: OPUS, G722, PCMU, PCMA, VP8, H264.
default_cipherslist of strings
A list of encryption ciphers this profile will support. Currently supported values are: AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80, AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32, AES_CM_128_HMAC_SHA1_32.
default_encryptionenum
A string representing whether connections to an endpoint that uses this profile require encryption or if encryption is optional. Encryption will always be used if possible. Possible values are required or optional.
Allowed values:requiredoptional
default_send_asstring
The e164 formatted number you wish to set as the originating number when dialing PSTN phone numbers from a SIP Endpoint that uses this profile. Specify null or an empty string to randomly choose a purchased or verified number from within the project.
Errors
401
Unauthorized Error
500
Internal Server Error
Update SIP profile
For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Updates the SIP profile settings for your project.
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.
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.
domain_identifierstringOptional
String representing the domain_identifier portion of the profile. Must be unique across your project.
default_codecslist of stringsOptional
A list of codecs this profile will support. Currently supported values are: OPUS, G722, PCMU, PCMA, VP8, H264.
default_cipherslist of stringsOptional
A list of encryption ciphers this profile will support. Currently supported values are: AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80, AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32, AES_CM_128_HMAC_SHA1_32.
default_encryptionenumOptional
A string representing whether connections to an endpoint that uses this profile require encryption or if encryption is optional. Encryption will always be used if possible. Possible values are required or optional.
default_send_asstringOptional
The e164 formatted number you wish to set as the originating number when dialing PSTN phone numbers from a SIP Endpoint that uses this profile. Specify null or an empty string to randomly choose a purchased or verified number from within the project.
Response
The request has succeeded and a new resource has been created as a result.
domainstring
A string representation of the fully qualified domain name for this profile.
domain_identifierstring
String representing the domain_identifier portion of the profile. Must be unique across your project.
default_codecslist of strings
A list of codecs this profile will support. Currently supported values are: OPUS, G722, PCMU, PCMA, VP8, H264.
default_cipherslist of strings
A list of encryption ciphers this profile will support. Currently supported values are: AEAD_AES_256_GCM_8, AES_256_CM_HMAC_SHA1_80, AES_CM_128_HMAC_SHA1_80, AES_256_CM_HMAC_SHA1_32, AES_CM_128_HMAC_SHA1_32.
default_encryptionenum
A string representing whether connections to an endpoint that uses this profile require encryption or if encryption is optional. Encryption will always be used if possible. Possible values are required or optional.
default_send_asstring
The e164 formatted number you wish to set as the originating number when dialing PSTN phone numbers from a SIP Endpoint that uses this profile. Specify null or an empty string to randomly choose a purchased or verified number from within the project.
Errors
401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error