SIP Trunks

Returns a list of all SIP trunks. If you specify pagination settings, the list of SIP trunks can be returned separated and sorted into pages.

get/v1/projects/{projectId}/trunks

Request

  • Base URL
    https://elastic-trunking.api.sinch.com
  • URL
    https://elastic-trunking.api.sinch.com/v1/projects/{projectId}/trunks
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Path parameters

projectIdstring required
Example:3acb7ae1-cf3d-4112-ba5e-3a9d8c71cd47

The projectId is a required parameter you must include when making any API calls. You can find your project ID on your Build dashboard.

Query parameters

pageinteger

The page you want to fetch, can set to 1 for first page, or omitted for first page

sizeinteger

The size of each page to fetch

domainstring

Filter by domain

Response

Request completed successfully

totalItemsinteger

Total size of the result.

pageNumberstring

The token to be used for listing the next page

sizeinteger

The number of items per page. default is 1000

Example response

{
  "totalItems": 10000,
  "pageNumber": "1",
  "size": 2000,
  "sipTrunks": [
    {
      "hostName": "acme-domain-1",
      "topLevelDomain": ".elastic-sip.sinch.com",
      "domain": "acme-domain-1.elastic-sip.sinch.com",
      "name": "Acme Trunk",
      "callsPerSecond": 100,
      "enableCallerName": true,
      "callForwardNumber": "+17208511190",
      "enableCallForward": true,
      "createTime": "2022-01-01T00:00:00Z",
      "updateTime": "2022-01-01T00:00:00Z",
      "projectId": "1bf62742-7b84-4666-9cbe-8e5734fd57d0"
    }
  ]
}

Changes

    • breaking

      the response property /// became nullable for the status

    • info

      the response optional property /// became not read-only for the status

    • info

      endpoint added