Appearance
Subscribers
FreshCreate Subscriber
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.
Create a new Subscriber.
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.
emailstringRequired
Email of the Subscriber.
passwordstringOptional8-72 characters
Password of the Subscriber. Defaults to a secure random password if not provided.
first_namestringOptional
First name of the Subscriber.
last_namestringOptional
Last name of the Subscriber.
display_namestringOptional
Display name of the Subscriber.
job_titlestringOptional
Job title of the Subscriber.
timezonestringOptional
Timezone of the Subscriber.
countrystringOptional
Country of the Subscriber.
company_namestringOptional
Company name of the Subscriber.
Response
The request has succeeded and a new resource has been created as a result.
idstring
Unique ID of the request.
project_idstring
Unique ID of the project.
display_namestring
Display name of the Subscriber.
typeenum
Type of the resource.
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
subscriberobject
Subscriber data.
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Delete Subscriber
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.
Delete an existing Subscriber.
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 Subscriber.
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 Subscriber
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.
Fetch an existing Subscriber.
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 Subscriber.
Response
The request has succeeded.
idstring
Unique ID of the request.
project_idstring
Unique ID of the project.
display_namestring
Display name of the Subscriber.
typeenum
Type of the resource.
Allowed values:subscriber
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
subscriberobject
Subscriber data.
Show 9 properties
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List Subscriber 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.
List Subscriber Addresses.
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 Subscriber Address.
Response
The request has succeeded.
datalist of objects
An array of objects that contain a list of Subscriber addresses
linksobject
Object containing pagination links
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List Subscribers
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.
Retrieve a list of all subscribers.
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 Subscriber data
linksobject
Object containing pagination links
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Create Subscriber SIP credential
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.
Creates a Subscriber SIP Credential.
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
fabric_subscriber_idstringRequiredformat: "uuid"
Unique ID of a Fabric Subscriber.
Request
This endpoint expects an object.
usernamestringRequired
Username of the Sip Endpoint.
passwordstringRequired
Password of the Sip Endpoint.
caller_idstringOptional
Caller ID of the Sip Endpoint.
send_asstringOptional
The Number to send as.
cipherslist of enumsOptional
Ciphers of the Sip Endpoint.
codecslist of enumsOptional
Codecs of the Sip Endpoint.
encryptionenumOptionalDefaults to default
Encryption requirement of the Sip Endpoint.
Response
The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
Unique ID of the Sip Endpoint.
usernamestring
Username of the Sip Endpoint.
caller_idstring
Caller ID of the Sip Endpoint.
send_asstring
Purchased or verified number
cipherslist of enums
Ciphers of the Sip Endpoint.
codecslist of enums
Codecs of the Sip Endpoint.
encryptionenum
Encryption requirement of the Sip Endpoint.
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Delete Subscriber SIP credential
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 Subscriber SIP Credential 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 Sip Endpoint.
fabric_subscriber_idstringRequiredformat: "uuid"
Unique ID of a Fabric Subscriber.
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 Subscriber SIP credential
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 Subscriber SIP Credential 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 Sip Endpoint.
fabric_subscriber_idstringRequiredformat: "uuid"
Unique ID of a Fabric Subscriber.
Response
The request has succeeded.
idstringformat: "uuid"
Unique ID of the Sip Endpoint.
usernamestring
Username of the Sip Endpoint.
caller_idstring
Caller ID of the Sip Endpoint.
send_asstring
Purchased or verified number
cipherslist of enums
Ciphers of the Sip Endpoint.
codecslist of enums
Codecs of the Sip Endpoint.
encryptionenum
Encryption requirement of the Sip Endpoint.
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
List Subscriber SIP credentials
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 SIP Credentials for the Subscriber.
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
fabric_subscriber_idstringRequiredformat: "uuid"
Unique ID of a Fabric Subscriber.
Response
The request has succeeded.
datalist of objects
Show 7 properties
linksobject
Show 4 properties
Errors
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error
Update Subscriber SIP credential
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 a Subscriber SIP Credential 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 Sip Endpoint.
fabric_subscriber_idstringRequiredformat: "uuid"
Unique ID of a Fabric Subscriber.
Request
This endpoint expects an object.
usernamestringOptional
Username of the Sip Endpoint.
passwordstringOptional
Password of the Sip Endpoint.
caller_idstringOptional
Caller ID of the Sip Endpoint.
send_asstringOptional
The Number to send as.
cipherslist of enumsOptional
Ciphers of the Sip Endpoint.
Allowed values:AEAD_AES_256_GCM_8AES_256_CM_HMAC_SHA1_80AES_CM_128_HMAC_SHA1_80AES_256_CM_HMAC_SHA1_32AES_CM_128_HMAC_SHA1_32
codecslist of enumsOptional
Codecs of the Sip Endpoint.
Show 11 enum values
encryptionenumOptionalDefaults to default
Encryption requirement of the Sip Endpoint.
Allowed values:requiredoptionaldefault
Response
The request has succeeded.
idstringformat: "uuid"
Unique ID of the Sip Endpoint.
usernamestring
Username of the Sip Endpoint.
caller_idstring
Caller ID of the Sip Endpoint.
send_asstring
Purchased or verified number
cipherslist of enums
Ciphers of the Sip Endpoint.
Allowed values:AEAD_AES_256_GCM_8AES_256_CM_HMAC_SHA1_80AES_CM_128_HMAC_SHA1_80AES_256_CM_HMAC_SHA1_32AES_CM_128_HMAC_SHA1_32
codecslist of enums
Codecs of the Sip Endpoint.
Show 11 enum values
encryptionenum
Encryption requirement of the Sip Endpoint.
Allowed values:requiredoptionaldefault
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Create guest embed token
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.
Creates a guest subscriber token from a public Click-to-Call (C2C) token. The returned short-lived token authorizes a guest subscriber to place a call through the C2C embed widget without exposing sensitive credentials or requiring a full subscriber account.
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.
Request
This endpoint expects an object.
tokenstringRequired
Click to Call Token
Response
The request has succeeded and a new resource has been created as a result.
tokenstringformat: "jwt"
Encrypted guest token.
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Create Subscriber guest token
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.
Creates a Subscriber Guest Token. Authenticate this request with your project’s API token.
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.
allowed_addresseslist of stringsRequired
List of up to 10 UUIDs representing the allowed Fabric addresses.
expire_atintegerOptional
A unixtime (the number of seconds since 1970-01-01 00:00:00) at which the token should no longer be valid. Defaults to ‘two hours from now’
regionenumOptional
A routing override that controls which regional cluster the SDK connects to.
Allowed values:us-central
chenumOptional
A direct routing override specifying the regional cluster endpoint, set as the ch claim in the SAT JWE header.
Allowed values:us-central
Response
The request has succeeded and a new resource has been created as a result.
tokenstringformat: "jwt"
Guest Token
refresh_tokenstringformat: "jwt"
Refresh Token
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Create Subscriber invite token
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.
Creates a Subscriber Invite Token for use with client-side API calls. Authenticate this request with a subscriber’s SAT (Subscriber Access Token), not the project level Basic Auth.
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>Request
This endpoint expects an object.
address_idstringRequiredformat: "uuid"
Unique ID of a Subscriber Address
expires_atintegerOptional
A unixtime (the number of seconds since 1970-01-01 00:00:00) at which the token should no longer be valid. Defaults to ‘two hours from now’
Response
The request has succeeded and a new resource has been created as a result.
tokenstringformat: "jwt"
Invite Token
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Create Subscriber token
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.
Create a Subscriber Token.
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.
referencestringRequired
A string that uniquely identifies the subscriber. Often it's an email, but can be any other string.
expire_atintegerOptional
A unixtime (the number of seconds since 1970-01-01 00:00:00) at which the token should no longer be valid. Defaults to ‘two hours from now’
application_idstringOptionalformat: "uuid"
The ID of the application that the token is associated with.
passwordstringOptional
Set or update the subscriber's password. Omit this field or pass an empty string if you don't want to update the password.
fingerprintstringOptionalformat: "^[A-Za-z0-9_-]+$"``=43 characters
Binds the token to a specific device or browser session, letting the holder refresh it without going through your backend. The Browser SDK generates this value automatically when starting a session, forward it to your backend when requesting a token, so tie the token to that client.
Without fingerprint, your backend can still refresh the token using the companion refresh_token returned in this response.
scopeenumOptional
Grants the token’s holder permission to refresh it directly from the Browser SDK client. Pair with fingerprint to bind the token to a device.
Without this scope, your backend can still refresh the token using the companion refresh_token. If sat:refresh is set without fingerprint, the token’s lifetime is limited to 60 seconds.
Allowed values:sat:refresh
first_namestringOptional
Set or update the first name of the subscriber.
last_namestringOptional
Set or update the last name of the subscriber.
display_namestringOptional
Set or update the display name of the subscriber.
job_titlestringOptional
Set or update the job title of the subscriber.
time_zonestringOptional
Set or update the time zone of the subscriber.
countrystringOptional
Set or update the country of the subscriber.
regionenumOptional
A routing override that controls which regional cluster the SDK connects to.
Allowed values:us-central
company_namestringOptional
Set or update the company name of the subscriber.
Response
The request has succeeded.
subscriber_idstringformat: "uuid"
The ID of the subscriber that the token is associated with.
tokenstringformat: "jwt"
The token that is associated with the subscriber.
refresh_tokenstringformat: "jwt"
Refresh token.
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Refresh Subscriber token
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.
Exchanges a valid refresh token for a new subscriber access token and a new refresh token. The new access token is valid for 2 hours, and the new refresh token is valid for 2 hours and 5 minutes.
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.
refresh_tokenstringRequiredformat: "jwt"
The refresh token previously issued alongside a subscriber access token. This token is used to request a new access token.
Response
The request has succeeded and a new resource has been created as a result.
tokenstringformat: "jwt"
A newly generated subscriber access token, valid for 2 hours.
refresh_tokenstringformat: "jwt"
A new refresh token, valid for 2 hours and 5 minutes.
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error
Update Subscriber
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.
Update an existing Subscriber.
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 Subscriber.
Request
This endpoint expects an object.
emailstringRequired
Email of the Subscriber.
passwordstringOptional8-72 characters
Password of the Subscriber. Defaults to a secure random password if not provided.
first_namestringOptional
First name of the Subscriber.
last_namestringOptional
Last name of the Subscriber.
display_namestringOptional
Display name of the Subscriber.
job_titlestringOptional
Job title of the Subscriber.
timezonestringOptional
Timezone of the Subscriber.
countrystringOptional
Country of the Subscriber.
company_namestringOptional
Company name of the Subscriber.
Response
The request has succeeded.
idstring
Unique ID of the request.
project_idstring
Unique ID of the project.
display_namestring
Display name of the Subscriber.
typeenum
Type of the resource.
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
subscriberobject
Subscriber data.
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error