List Trunks

This request returns a list of the tenant’s telephone trunks.

Resource

GET /trunks[?parameters]

Parameters

Common Search Parameters

Name Type Description

Name	Type	Description
`include`	[String] seperate by comma if you want to include multiple fields	Include fields to the result. include=[included fields] registrationDate → date of the last registration registrationStatus → the registration status of the trunk defaultCallerNr → the default caller number of the trunk rejectedRegistrationCause → the cause of the last rejected registration

include

[String]
seperate by comma if you want to include multiple fields

Include fields to the result. include=[included fields]
registrationDate → date of the last registration
registrationStatus → the registration status of the trunk
defaultCallerNr → the default caller number of the trunk
rejectedRegistrationCause → the cause of the last rejected registration

Payload

None

Response

List Response < Trunk >

Context

Authorization

Administrator

Errors

Common Errors

Example

Request

GET https://xelion.nl/api/v1/master/trunks?include=registrationDate,registrationStatus,defaultCallerNr,rejectedRegistrationCause

Response

{
  "data": [
    {
      "object": {
        "defaultCallerNr": "+31202459000",
        "registrationStatus": "",
        "registrationDate": "",
        "rejectedRegistrationCause": "",
        "commonName": "SIP trunk main office",
        "oid": "4874626",
        "objectType": "XCCTrunk"
      },
      "links": [
        {
          "rel": "self",
          "href": "https://xelion.nl/api/v1/master/trunks/4874626",
          "method": "GET"
        }
      ]
    },
    {
      "object": {
        "defaultCallerNr": "",
        "registrationStatus": "",
        "registrationDate": "",
        "rejectedRegistrationCause": "",
        "commonName": "route xelion network",
        "oid": "4882936",
        "objectType": "XCCTrunk"
      },
      "links": [
        {
          "rel": "self",
          "href": "https://xelion.nl/api/v1/master/trunks/4882936",
          "method": "GET"
        }
      ]
    },
    {
      "object": {
        "defaultCallerNr": "+31307654321",
        "registrationStatus": "",
        "registrationDate": "",
        "rejectedRegistrationCause": "",
        "commonName": "trunk backup",
        "oid": "5960507",
        "objectType": "XCCTrunk"
      },
      "links": [
        {
          "rel": "self",
          "href": "https://xelion.nl/api/v1/master/trunks/5960507",
          "method": "GET"
        }
      ]
    }
  ],
  "meta": {
    "links": [
      {
        "rel": "refresh",
        "href": "https://xelion.nl/api/v1/master/trunks?include=registrationDate,registrationStatus,defaultCallerNr,rejectedRegistrationCause",
        "method": "GET"
      },
      {
        "rel": "next",
        "href": "https://xelion.nl/api/v1/master/trunks?after=5960507",
        "method": "GET"
      },
      {
        "rel": "previous",
        "href": "https://xelion.nl/api/v1/master/trunks?before=4874626",
        "method": "GET"
      }
    ],
    "paging": {
      "previousId": "4874626",
      "nextId": "5960507"
    }
  }
}