REST ClientSIP Profile

update

View as MarkdownOpen in Claude

Update the project SIP profile. Uses PUT for full replacement.

Request

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

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_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 Example

Response
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}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient();
4const result = await client.sipProfile.update({ default_codecs: ['PCMU', 'PCMA'] });
5console.log(result);