About
A list of SIP trunks is retrieved using the following request.
Resource URI
Complete details about your SIP trunks are requested with the following request.
GET
/v2/Properties/{PropertySid}/SipTrunksRequest
URI Parameters
| Parameter | Type | Description |
|---|---|---|
| PropertySid | string | The secure identifier of the Property for which to search SIP trunks for. |
Optional Parameters
These parameters are only associated with the request for a list of SIP trunk records. Results can be filtered with any number of the following parameters.
| Parameter | Type | Description |
|---|---|---|
| Type | short | Filter by the type of SIP trunk. 0 – IP to IP, 1 – Authenticated. |
| Active | boolean | Filter by true - Active or false - Inactive SIP trunks. |
| ProvisioningState | short | Filter by the provisioning state of the SIP trunk. 0 - Inactive, 1 - Provisioning, 2 - Active, 3 - Deprovisioning. |
| Results_Skip | integer | Return results after the specified index. This enables custom pagination of results. Default is 0. |
| Results_Count | integer | Limit the results to this number. Default result count is a limit of 50. |
Response
200 – OK
Our service will respond to every SIP trunk list request with JSON formatted data. Requests for SIP trunks will respond with a list of objects containing the following parameters.
Common Response Parameters
| Parameter | Type | Description |
|---|---|---|
| SipTrunkSid | string | The secure identifier of the SIP trunk. |
| Created (Unix timestamp) |
unsigned integer | Timestamp of when the SIP trunk was created (UTC). |
| Modified (Unix timestamp) |
unsigned integer | Timestamp of when the SIP trunk was last modified (UTC). |
| EndDate (Unix timestamp) |
unsigned integer | Timestamp of when the SIP trunk was deactivated (UTC). |
| Name | string | The name of the SIP trunk. |
| Type | short | The type of the SIP trunk. |
| ChannelLimit | integer | The maximum number of channels allowed for the SIP trunk. |
| CustomerReference | string | A customer-provided reference for the SIP trunk. |
| ExternalReference | string | An external reference for the SIP trunk. |
| DefaultCallerId | string | The default caller ID for the SIP trunk. |
| ProvisioningState | short | The current provisioning state of the SIP trunk. |
400 - Error
For error codes and messages, please refer to the REST API Error Codes page.