For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
      • GETGet SIP profile
      • PUTUpdate SIP profile
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
PlatformSIP Profile

Get SIP profile

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/sip_profile
GET
/api/relay/rest/sip_profile
$curl https://{your_space_name}.signalwire.com/api/relay/rest/sip_profile \
>     -u "<project_id>:<api_token>"
1{
2  "domain": "your-space-example.sip.signalwire.com",
3  "domain_identifier": "example",
4  "default_codecs": [
5    "string"
6  ],
7  "default_ciphers": [
8    "string"
9  ],
10  "default_encryption": "optional",
11  "default_send_as": "+15551234567"
12}

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.

Was this page helpful?
Previous

Update SIP profile

Next
Built with

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:
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