Get Trunk Groups#

Description

Returns a collection of Trunk Groups.

Request#

HTTP Method: GET

URI Path: /v3/trunk_groups

URI Query Parameters:

Name

Type

Is Required?

Description

include

string

Optional

Inclusion

sort

string

Optional

Sorting

Includes:

Value

Description

trunks

List of Trunk Objects

Sorting:

Value

Sorts by:

name

The name field.

created_at

The created_at field.

capacity_limit

The capacity_limit field.

Examples#

http

1GET /v3/trunk_groups HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]

curl

1curl -i -X GET https://api.didww.com/v3/trunk_groups -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": [{
 6      "id": "65b401cb-42f5-4911-877d-dc317a46b478",
 7      "type": "trunk_groups",
 8      "links": {
 9        "self": "https://api.didww.com/v3/trunk_groups/65b401cb-42f5-4911-877d-dc317a46b478"
10      },
11      "attributes": {
12        "created_at": "2017-06-25T14:56:31.513Z",
13        "name": "Common Group",
14        "capacity_limit": 69
15      },
16      "relationships": {
17        "trunks": {
18          "links": {
19            "self": "https://api.didww.com/v3/trunk_groups/65b401cb-42f5-4911-877d-dc317a46b478/relationships/trunks",
20            "related": "https://api.didww.com/v3/trunk_groups/65b401cb-42f5-4911-877d-dc317a46b478/trunks"
21          }
22        }
23      },
24      "meta": {
25        "trunks_count": 1
26      }
27    },
28    {
29      "id": "72a60b4a-affb-46c7-8a8a-7e042c7611e8",
30      "type": "trunk_groups",
31      "links": {
32        "self": "https://api.didww.com/v3/trunk_groups/72a60b4a-affb-46c7-8a8a-7e042c7611e8"
33      },
34      "attributes": {
35        "created_at": "2017-06-25T14:56:31.513Z",
36        "name": "Custom Group",
37        "capacity_limit": 50
38      },
39      "relationships": {
40        "trunks": {
41          "links": {
42            "self": "https://api.didww.com/v3/trunk_groups/72a60b4a-affb-46c7-8a8a-7e042c7611e8/relationships/trunks",
43            "related": "https://api.didww.com/v3/trunk_groups/72a60b4a-affb-46c7-8a8a-7e042c7611e8/trunks"
44          }
45        }
46      },
47      "meta": {
48        "trunks_count": 0,
49                "api_version": "2017-09-18"
50      }
51    }
52  ],
53  "meta": {
54    "total_records": 2,
55    "api_version": "2017-09-18"
56  },
57  "links": {
58    "first": "https://api.didww.com/v3/trunk_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
59    "last": "https://api.didww.com/v3/trunk_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
60  }
61}

Other Responses#

Code

Success

Description

401

No

Unauthorized