About

Details about SIP trunk is retrieved using the following requests.

Resource URI

Complete details about your SIP trunk is requested with the following request.

GET
/v2/Accounts/{AccountSid}/SipTrunk/{SipTrunkSid}/Details
or
/v2/Properties/{PropertySid}/SipTrunk/{SipTrunkSid}/Details

Request

URI Parameters

Parameter Type Description
PropertySid string Property secure identification to retrieve SIP trunk's details.
AccountSid string Account secure identification to retrieve SIP trunk's details.
SipTrunkSid string The secure identifier of the sip trunk.

Response

200 – OK

Our service will respond to every SIP trunk details request with JSON formatted data. Requests for SIP trunk details will respond with an object containing the following parameters.

Response Parameters

Parameter Type Description
SipTrunkSid string The secure identifier of the SIP trunk.
Created
(Unix timestamp)		 unsigned integer Unix time the SIP trunk was created.
Modified
(Unix timestamp)		 unsigned integer Unix time the SIP trunk was last modified.
EndDate
(Unix timestamp)		 unsigned integer Unix time the SIP trunk was deactivated.
Name string The name of the SIP trunk.
Type short SIP trunk type. 0 – IP to IP, 1 – Authenticated.
ChannelLimit integer The 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
(E.164 Format)		 string The default caller ID for the SIP trunk.
ProvisioningState short The current provisioning state of the SIP trunk. 0 - Inactive, 1 - Provisioning, 2 - Active, 3 - Deprovisioning.
SipTrunkAllowedCountries array An array of objects representing the countries allowed for the SIP trunk. Each object contains:
* Created (unsigned integer): Unix time the country allowance was created.
* Modified (unsigned integer): Unix time the country allowance was last modified.
* CountryCode (string): The country code (e.g., AU, NZ).
SipTrunkNumberRanges array An array of objects representing the number ranges associated with the SIP trunk. Each object contains:
* Created (unsigned integer): Unix time the number range was created.
* Modified (unsigned integer): Unix the number range was last modified.
* StartNumber (string): The starting number of the range.
* Length (integer): The length of the number range.
* RouteOnly (boolean): Indicates if the number range is for routing only.
SipTrunkIpAddresses array An array of objects representing the IP addresses associated with the SIP trunk. Each object contains:
* Created (unsigned integer): Unix time the IP address was added.
* Modified (unsigned integer): Unix time the IP address was last modified.
* IpAddress (string): The IP address.
SipTrunkCredentials object An object containing the credentials for the SIP trunk. This object contains:
* Created (unsigned integer): Unix time the credentials were created.
* Modified (unsigned integer): Unix time the credentials were last modified.
* Realm (string): The realm for the SIP trunk credentials.

Example: Details of a sip trunk.

{
  "SipTrunkSid": "AG5T3HFR5ASD54FS5GB3SDAFJAKSH6DS",
  "Created": 1692931200,
  "Modified": 1695536800,
  "EndDate": 1700000000,
  "Name": "Sip Trunk Name",
  "Type": 1,
  "ChannelLimit": 50,
  "CustomerReference": "CustomerRef",
  "ExternalReference": "12345",
  "DefaultCallerId": "+61799999999",
  "ProvisioningState": 2,
  "SipTrunkAllowedCountries": [
    {
      "Created": 1693000000,
      "Modified": 1694000000,
      "CountryCode": "AU"
    },
    {
      "Created": 1693100000,
      "Modified": 1694100000,
      "CountryCode": "NZ"
    }
  ],
  "SipTrunkCredentials": {
    "Created": 1693500000,
    "Modified": 1694500000,
    "Realm": "realm"
  }
}

400 - Error

For error codes and messages, please refer to the REST API Error Codes page.