Sign in
SIP Profile

Update SIP profile

Changes the project-wide defaults that SIP Credentials use for registration, media, security, and outbound calling. This updates the project's single SIP Profile; it does not create or update an individual SIP Credential or SIP Gateway.

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.

put/api/relay/rest/sip_profile

Request body

domain_identifierstring

String representing the domain_identifier portion of the profile. Must be unique across your project.

default_codecsstring[]

A list of codecs this profile will support. Currently supported values are: OPUS, G722, PCMU, PCMA, VP8, H264.

default_ciphersstring[]

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_encryption'required' | 'optional'

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.

Example request

{
  "domain_identifier": "example",
  "default_encryption": "optional",
  "default_send_as": "+15551234567"
}

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_codecsstring[]

A list of codecs this profile will support. Currently supported values are: OPUS, G722, PCMU, PCMA, VP8, H264.

default_ciphersstring[]

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_encryption'required' | 'optional'

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.

Example response

{
  "domain": "your-space-example.sip.signalwire.com",
  "domain_identifier": "example",
  "default_encryption": "optional",
  "default_send_as": "+15551234567"
}

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.