Skip to navigation
PlatformSIP Profile

Get SIP profile

View as MarkdownOpen in Claude

Retrieves the SIP Profile shared across your SignalWire project. The profile supplies project-wide defaults to SIP Credentials that use it; individual registering devices and external destinations are represented by SIP Credentials and SIP Gateways.

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.
domainstringOptional
A string representation of the fully qualified domain name for this profile.
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.
Allowed values:
default_outbound_policyenumOptional

How calls placed by a SIP endpoint whose call_handler is default are handled. passthrough connects the call to the dialed destination, including PSTN numbers, and block-pstn does the same but blocks calls to PSTN numbers.

Allowed values:
default_send_asstringOptional

The E.164 number SIP endpoints that use this profile send as their From number when dialing PSTN phone numbers. Returns random when no number is set, meaning a purchased or verified number from the project is chosen. random is only a response value: to clear the number with Update SIP profile, send null or an empty string.

Errors

500
Internal Server Error