SIP Endpoints

Return SIP endpoints

Changed on

Returns a list of all SIP endpoints with paging.

get/v1/projects/{projectId}/trunks/{sipTrunkId}/endpoints

Request

  • Base URL
    https://elastic-trunking.api.sinch.com
  • URL
    https://elastic-trunking.api.sinch.com/v1/projects/{projectId}/trunks/{sipTrunkId}/endpoints
  • 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.

sipTrunkIdstring required

The ID of the SIP trunk.

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

Response

A successful response.

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,
  "endpoints": [
    {
      "address": "127.0.0.1",
      "port": 5060,
      "sipTrunkId": "bbc55c4c-fe25-11ec-8482-d2e74e85a66f",
      "name": "Acme Endpoint",
      "transport": "UDP",
      "priority": 1,
      "createTime": "2022-01-01T00:00:00Z",
      "updateTime": "2022-01-01T00:00:00Z"
    }
  ]
}

Changes