About
SIP trunk is updated using the following requests.
Resource URI
Complete details about updating your SIP trunks are requested with the following requests.
PUT
/v2/Accounts/{AccountSid}/SipTrunk/{SipTrunkSid}
or
/v2/Properties/{PropertySid}/SipTrunk/{SipTrunkSid}Request
URI Parameters
| Parameter | Type | Description |
|---|---|---|
| AccountSid | string | Account secure identification to update the SIP trunk. |
| PropertySid | string | Property secure identification to update the SIP trunk. |
| SipTrunkSid | string | The secure identifier of the SIP trunk. |
Optional Parameters
These parameters can be included in the request body to update the SIP trunk record.
| Parameter | Type | Description |
|---|---|---|
| Name | string | The name to assign to a SIP trunk. |
| DefaultCallerId (E.164 Format including +) |
string | The default caller ID for the SIP trunk. Must be a non-shared-rate, non-tollfree AU number in +E.164 format. |
| Type | short | The type of the SIP trunk. 0 - IP to IP, 1 - Authenticated. |
| SipTrunkIpAddresses | array |
An array of IP addresses to associate with the SIP trunk. Each object in the array should contain: * IpAddress (string): The IP address or subnet (e.g., IPv4 subnets in CIDR form like /24 or smaller; add /32 for a single IP address). Only public IP addresses are allowed. Required when Type is 0.
|
| SipTrunkCredentials | object |
An object containing credentials for the SIP trunk. This object should contain: * Realm (string): The realm for the SIP trunk credentials. * Password (string): The password for the SIP trunk credentials. At least 10 characters including the following 4 types of characters: a lower-case letter, an upper-case letter, a number, a special character (such as !@#$%^&*). Not more than 2 identical characters in a row (for example, 111 is not allowed). Required when Type is 1.
|
| SipTrunkAllowedCountries | array |
An array of country codes to allow for the SIP trunk. Each object in the array should contain: * CountryCode (string): The country code (e.g., AU, NZ). |
| ChannelLimit | integer | The maximum number of channels allowed for the SIP trunk. |
| CustomerReference | string | A customer-provided reference for the SIP trunk. |
Example: Updating a sip trunk.
{
"ChannelLimit": 30,
"CustomerReference": "NewReference",
"DefaultCallerId": "+61799999999",
"Type": 0,
"SipTrunkIpAddresses": [
{
"IpAddress": "5.6.7.8/32"
}
]
}Response
204 – No Content
A successful update request will return a 204 No Content status code, indicating that the request has been successfully processed.
400 - Error
For error codes and messages, please refer to the REST API Error Codes page.