Get Voice IN Trunk Group#
Description
Returns a single Voice IN Trunk Group.
Request#
HTTP Method: GET
URI Path: /v3/voice_in_trunk_groups/
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID identifier of the Trunk Group. |
include |
|
Optional |
Includes:
Value |
Description |
|---|---|
trunks |
Examples#
http
1GET /v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664 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/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664 -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": "418fe352-04b8-4e03-a7ce-cb57efd8c664",
7 "type": "voice_in_trunk_groups",
8 "links": {
9 "self": "https://api.didww.com/v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664"
10 },
11 "attributes": {
12 "created_at": "2017-06-25T14:56:31.513Z",
13 "name": "Common Group",
14 "capacity_limit": 69
15 },
16 "relationships": {
17 "voice_in_trunks": {
18 "links": {
19 "self": "https://api.didww.com/v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/relationships/voice_in_trunks",
20 "related": "https://api.didww.com/v3/voice_in_trunk_groups/418fe352-04b8-4e03-a7ce-cb57efd8c664/voice_in_trunks"
21 }
22 }
23 },
24 "meta": {
25 "trunks_count": 1
26 }
27 }
28}
http
1GET /v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae?include=voice_in_trunks 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/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae?include=voice_in_trunks' -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": "465b059a-b4a2-4c8e-ab3b-33dc60e096ae",
7 "type": "voice_in_trunk_groups",
8 "links": {
9 "self": "https://api.didww.com/v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae"
10 },
11 "attributes": {
12 "created_at": "2017-06-25T14:56:31.513Z",
13 "name": "Common Group",
14 "capacity_limit": 69
15 },
16 "relationships": {
17 "voice_in_trunks": {
18 "links": {
19 "self": "https://api.didww.com/v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae/relationships/voice_in_trunks",
20 "related": "https://api.didww.com/v3/voice_in_trunk_groups/465b059a-b4a2-4c8e-ab3b-33dc60e096ae/voice_in_trunks"
21 },
22 "data": [
23 {
24 "type": "voice_in_trunks",
25 "id": "87133f4d-4a88-436b-b74b-b63e79318426"
26 }
27 ]
28 }
29 },
30 "meta": {
31 "trunks_count": 1
32 }
33 },
34 "included": [
35 {
36 "id": "87133f4d-4a88-436b-b74b-b63e79318426",
37 "type": "voice_in_trunks",
38 "attributes": {
39 "priority": 1,
40 "capacity_limit": 5,
41 "weight": 65535,
42 "name": "Office Mobile",
43 "cli_format": "e164",
44 "cli_prefix": null,
45 "description": null,
46 "ringing_timeout": null,
47 "configuration": {
48 "type": "pstn_configurations",
49 "attributes": {
50 "dst": "1xxxxxxxxx"
51 }
52 }
53 },
54 "relationships": {
55 "voice_in_trunk_group": {
56 "links": {
57 "self": "https://api.didww.com/v3/voice_in_trunks/87133f4d-4a88-436b-b74b-b63e79318426/relationships/voice_in_trunk_group",
58 "related": "https://api.didww.com/v3/voice_in_trunks/87133f4d-4a88-436b-b74b-b63e79318426/voice_in_trunk_group"
59 }
60 }
61 }
62 }
63 ]
64}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |