About
Use this request to create a new SIP trunk associated with a property.
Resource URI
POST
/v2/Properties/{PropertySid}/SipTrunkRequest
URI Parameters
| Parameter | Type | Description |
|---|---|---|
| PropertySid | string | The secure identification to create a SIP trunk. |
Resource Parameters
| Parameter | Type | Description |
|---|---|---|
| Name | string | Name to add to a sip trunk. |
| DefaultCallerId (E.164 Format including +) |
string | Must be a non-shared-rate, non-tollfree AU number in +E.164 format. |
| Type | short | Sip Trunk type. 0 – IP to IP, 1 – Authenticated. |
Nested Parameters
SipTrunkIpAddresses (array of objects) (required when Type = 0)
| Parameter | Type | Description |
|---|---|---|
| IpAddress | string | Subnet must be IPv4 CIDR (/24 or smaller). Use /32 for a single IP. Only public IP addresses are allowed. |
SipTrunkCredentials (object) (required when Type = 1)
| Parameter | Type | Description |
|---|---|---|
| Realm | string | Realm for SIP authentication. |
| Password | string | Password for SIP authentication. 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). |
SipTrunkAllowedCountries (array of objects)
| Parameter | Type | Description |
|---|---|---|
| CountryCode | string | Allowed country codes. Example: AU, NZ. |
Optional Parameters
| Parameter | Type | Description |
|---|---|---|
| ChannelLimit | integer | Optional. Default value is 1. |
| CustomerReference | string | Optional. Custom reference for a sip trunk. |
Response
200 – OK
The server will respond with JSON containing the SIP trunk identifier.
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| SipTrunkSid | string | The secure identifier which uniquely identifies this SIP trunk. |
400 – Error
For error codes and messages, please refer to the REST API Error Codes page.