Create Inbound Trunk Group#
Creates a Trunk Group.
Request#
HTTP Method: POST
URI Path: /v3/voice_in_trunk_groups
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
include |
|
No |
Request Body Object Attributes#
Name |
Type |
Nullable |
Is Required? |
Description |
|---|---|---|---|---|
name |
|
No |
Yes |
Unique name of the Trunk Group. |
external_reference_id |
|
Yes |
No |
Optional identifier for the trunk group in the customer’s external system. Maximum length is 100 characters. |
capacity_limit |
|
No |
No |
Maximum number of simultaneous calls for the Trunk Group. |
Request Body Object Relationships#
Name |
Type |
Description |
|---|---|---|
voice_in_trunks |
Linkage for included trunks. |
Examples#
http
1POST /v3/voice_in_trunk_groups HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
6
7{
8 "data": {
9 "type": "voice_in_trunk_groups",
10 "attributes": {
11 "name": "Main group",
12 "capacity_limit": 100
13 }
14 }
15}
curl
1curl -i -X POST https://api.didww.com/v3/voice_in_trunk_groups -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"capacity_limit": 100, "name": "Main group"}, "type": "voice_in_trunk_groups"}}'
response
1HTTP/1.1 201 Created
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "a6370df6-86db-4a1a-9a54-3742f1d8615c",
7 "type": "voice_in_trunk_groups",
8 "links": {
9 "self": "https://api.didww.com/v3/voice_in_trunk_groups/a6370df6-86db-4a1a-9a54-3742f1d8615c"
10 },
11 "attributes": {
12 "created_at": "2017-06-25T14:56:31.513Z",
13 "external_reference_id": null,
14 "name": "Main group",
15 "capacity_limit": 100
16 },
17 "relationships": {
18 "voice_in_trunks": {
19 "links": {
20 "self": "https://api.didww.com/v3/voice_in_trunk_groups/a6370df6-86db-4a1a-9a54-3742f1d8615c/relationships/voice_in_trunks",
21 "related": "https://api.didww.com/v3/voice_in_trunk_groups/a6370df6-86db-4a1a-9a54-3742f1d8615c/voice_in_trunks"
22 }
23 }
24 },
25 "meta": {
26 "trunks_count": 0
27 }
28 }
29}
http
1POST /v3/voice_in_trunk_groups HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
6
7{
8 "data": {
9 "type": "voice_in_trunk_groups",
10 "attributes": {
11 "name": "Main group",
12 "capacity_limit": 100
13 },
14 "relationships": {
15 "voice_in_trunks": {
16 "data": [
17 {
18 "type": "voice_in_trunks",
19 "id": "b7a9d1ce-6a89-4071-bc0d-486ee223787d"
20 },
21 {
22 "type": "voice_in_trunks",
23 "id": "7ca415f8-8342-427a-bbfc-171b995f75d6"
24 },
25 {
26 "type": "voice_in_trunks",
27 "id": "46aa9cac-a8dd-4a06-82db-cb0731e53ba0"
28 }
29 ]
30 }
31 }
32 }
33}
curl
1curl -i -X POST https://api.didww.com/v3/voice_in_trunk_groups -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"capacity_limit": 100, "name": "Main group"}, "relationships": {"voice_in_trunks": {"data": [{"type": "voice_in_trunks", "id": "b7a9d1ce-6a89-4071-bc0d-486ee223787d"}, {"type": "voice_in_trunks", "id": "7ca415f8-8342-427a-bbfc-171b995f75d6"}, {"type": "voice_in_trunks", "id": "46aa9cac-a8dd-4a06-82db-cb0731e53ba0"}]}}, "type": "voice_in_trunk_groups"}}'
response
1HTTP/1.1 201 Created
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "faea735d-ba77-40ef-bf13-f4dfc0f43a68",
7 "type": "voice_in_trunk_groups",
8 "links": {
9 "self": "https://api.didww.com/v3/voice_in_trunk_groups/faea735d-ba77-40ef-bf13-f4dfc0f43a68"
10 },
11 "attributes": {
12 "created_at": "2017-06-25T14:56:31.513Z",
13 "external_reference_id": null,
14 "name": "Main group",
15 "capacity_limit": 100
16 },
17 "relationships": {
18 "voice_in_trunks": {
19 "links": {
20 "self": "https://api.didww.com/v3/voice_in_trunk_groups/faea735d-ba77-40ef-bf13-f4dfc0f43a68/relationships/voice_in_trunks",
21 "related": "https://api.didww.com/v3/voice_in_trunk_groups/faea735d-ba77-40ef-bf13-f4dfc0f43a68/voice_in_trunks"
22 }
23 }
24 },
25 "meta": {
26 "trunks_count": 3
27 }
28 }
29}
http
1POST /v3/voice_in_trunk_groups?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]
6
7{
8 "data": {
9 "type": "voice_in_trunk_groups",
10 "attributes": {
11 "name": "Main group",
12 "capacity_limit": 100
13 },
14 "relationships": {
15 "voice_in_trunks": {
16 "data": [
17 {
18 "type": "voice_in_trunks",
19 "id": "1dcbcdae-4ad6-4c42-acc3-b4ec097dd2f7"
20 },
21 {
22 "type": "voice_in_trunks",
23 "id": "c606cd05-a19f-4d3c-9362-3857a79a6e1d"
24 }
25 ]
26 }
27 }
28 }
29}
curl
1curl -i -X POST 'https://api.didww.com/v3/voice_in_trunk_groups?include=voice_in_trunks' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"capacity_limit": 100, "name": "Main group"}, "relationships": {"voice_in_trunks": {"data": [{"type": "voice_in_trunks", "id": "1dcbcdae-4ad6-4c42-acc3-b4ec097dd2f7"}, {"type": "voice_in_trunks", "id": "c606cd05-a19f-4d3c-9362-3857a79a6e1d"}]}}, "type": "voice_in_trunk_groups"}}'
response
1HTTP/1.1 201 Created
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "3b49216d-ccb0-4376-b9fa-a43ffcb48c35",
7 "type": "voice_in_trunk_groups",
8 "links": {
9 "self": "https://api.didww.com/v3/voice_in_trunk_groups/3b49216d-ccb0-4376-b9fa-a43ffcb48c35"
10 },
11 "attributes": {
12 "created_at": "2017-08-16T14:04:36.013Z",
13 "external_reference_id": null,
14 "name": "Main group",
15 "capacity_limit": 100
16 },
17 "relationships": {
18 "voice_in_trunks": {
19 "links": {
20 "self": "https://api.didww.com/v3/voice_in_trunk_groups/3b49216d-ccb0-4376-b9fa-a43ffcb48c35/relationships/voice_in_trunks",
21 "related": "https://api.didww.com/v3/voice_in_trunk_groups/3b49216d-ccb0-4376-b9fa-a43ffcb48c35/voice_in_trunks"
22 },
23 "data": [
24 {
25 "type": "voice_in_trunks",
26 "id": "1dcbcdae-4ad6-4c42-acc3-b4ec097dd2f7"
27 },
28 {
29 "type": "voice_in_trunks",
30 "id": "c606cd05-a19f-4d3c-9362-3857a79a6e1d"
31 }
32 ]
33 }
34 },
35 "meta": {
36 "trunks_count": 2
37 }
38 },
39 "included": [
40 {
41 "data": {
42 "id": "1dcbcdae-4ad6-4c42-acc3-b4ec097dd2f7",
43 "type": "voice_in_trunks",
44 "attributes": {
45 "priority": 1,
46 "capacity_limit": 2,
47 "weight": 65535,
48 "name": "Office PSTN",
49 "cli_format": "e164",
50 "cli_prefix": null,
51 "description": null,
52 "ringing_timeout": null,
53 "configuration": {
54 "type": "pstn_configurations",
55 "attributes": {
56 "dst": "18337249999"
57 ]
58 }
59 }
60 },
61 "relationships": {
62 "voice_in_trunk_group": {
63 "links": {
64 "self": "https://api.didww.com/v3/voice_in_trunks/1dcbcdae-4ad6-4c42-acc3-b4ec097dd2f7/relationships/voice_in_trunk_group",
65 "related": "https://api.didww.com/v3/voice_in_trunks/1dcbcdae-4ad6-4c42-acc3-b4ec097dd2f7/voice_in_trunk_group"
66 }
67 }
68 }
69 }
70 },
71 {
72 "data": {
73 "id": "c606cd05-a19f-4d3c-9362-3857a79a6e1d",
74 "type": "voice_in_trunks",
75 "attributes": {
76 "priority": 1,
77 "capacity_limit": 18,
78 "weight": 65535,
79 "name": "Office sip",
80 "cli_format": "e164",
81 "cli_prefix": "+1",
82 "description": null,
83 "ringing_timeout": null,
84 "configuration": {
85 "type": "sip_configurations",
86 "attributes": {
87 "dst": "1xxxxxxxxx",
88 "host": "example.com",
89 "port": null,
90 "codec_ids": [
91 9,
92 6
93 ]
94 }
95 }
96 },
97 "relationships": {
98 "voice_in_trunk_group": {
99 "links": {
100 "self": "https://api.didww.com/v3/voice_in_trunks/c606cd05-a19f-4d3c-9362-3857a79a6e1d/relationships/voice_in_trunk_group",
101 "related": "https://api.didww.com/v3/voice_in_trunks/c606cd05-a19f-4d3c-9362-3857a79a6e1d/voice_in_trunk_group"
102 }
103 }
104 }
105 }
106 }
107 ]
108}
Other Responses#
Code |
Success |
Description |
|---|---|---|
422 |
No |
|
401 |
No |