Get SMS Trunk Groups#
Returns the collection of SMS trunk groups configured for the account.
Request#
HTTP Method: GET
URI Path: /v3/sms_trunk_groups
Note
For all returned data attributes, see SMS Trunk Group Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
include |
|
No |
|
filter[<filter_name>] |
|
No |
|
fields[sms_trunk_groups] |
|
No |
|
sort |
|
No |
|
page[number] |
|
No |
|
page[size] |
|
No |
Page size. Pagination defaults to |
Includes#
Value |
Description |
|---|---|
sms_trunks |
SMS Trunk Object. The trunks in the group. |
incoming_dids |
DID Object. DIDs routed to the group for inbound messages. |
Filters#
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
id |
|
No |
Yes |
The group |
name |
|
No |
Yes |
The group |
external_reference_id |
|
No |
No |
The |
Sorting#
Value |
Sorts by: |
|---|---|
name |
The |
external_reference_id |
The |
created_at |
The |
updated_at |
The |
Prefix a value with - to sort in descending order.
Examples#
http
1GET /v3/sms_trunk_groups HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
curl
1curl -i -X GET https://api.didww.com/v3/sms_trunk_groups -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": [
6 {
7 "id": "c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46",
8 "type": "sms_trunk_groups",
9 "attributes": {
10 "name": "Inbound SMS",
11 "external_reference_id": null,
12 "created_at": "2026-10-22T09:15:42.118Z",
13 "updated_at": "2026-10-22T09:15:42.118Z"
14 },
15 "relationships": {
16 "sms_trunks": {
17 "links": {
18 "self": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/relationships/sms_trunks",
19 "related": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/sms_trunks"
20 }
21 },
22 "incoming_dids": {
23 "links": {
24 "self": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/relationships/incoming_dids",
25 "related": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/incoming_dids"
26 }
27 }
28 },
29 "meta": {
30 "sms_trunks_count": 2
31 }
32 },
33 {
34 "id": "d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91",
35 "type": "sms_trunk_groups",
36 "attributes": {
37 "name": "Support SMS",
38 "external_reference_id": "crm-7781",
39 "created_at": "2026-10-22T09:15:42.118Z",
40 "updated_at": "2026-10-22T09:15:42.118Z"
41 },
42 "relationships": {
43 "sms_trunks": {
44 "links": {
45 "self": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/relationships/sms_trunks",
46 "related": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/sms_trunks"
47 }
48 },
49 "incoming_dids": {
50 "links": {
51 "self": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/relationships/incoming_dids",
52 "related": "https://api.didww.com/v3/sms_trunk_groups/d2f4b6c8-3e5a-4b7d-9f1c-6a8e2d4b0c91/incoming_dids"
53 }
54 }
55 },
56 "meta": {
57 "sms_trunks_count": 0
58 }
59 }
60 ],
61 "meta": {
62 "api_version": "2026-11-19",
63 "total_records": 2
64 },
65 "links": {
66 "first": "https://api.didww.com/v3/sms_trunk_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
67 "last": "https://api.didww.com/v3/sms_trunk_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
68 }
69}
http
1GET /v3/sms_trunk_groups?include=sms_trunks HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
curl
1curl -i -X GET 'https://api.didww.com/v3/sms_trunk_groups?include=sms_trunks' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": [
6 {
7 "id": "c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46",
8 "type": "sms_trunk_groups",
9 "attributes": {
10 "name": "Inbound SMS",
11 "external_reference_id": null,
12 "created_at": "2026-10-22T09:15:42.118Z",
13 "updated_at": "2026-10-22T09:15:42.118Z"
14 },
15 "relationships": {
16 "sms_trunks": {
17 "links": {
18 "self": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/relationships/sms_trunks",
19 "related": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/sms_trunks"
20 },
21 "data": [
22 {
23 "type": "sms_trunks",
24 "id": "3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24"
25 },
26 {
27 "type": "sms_trunks",
28 "id": "0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90"
29 }
30 ]
31 },
32 "incoming_dids": {
33 "links": {
34 "self": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/relationships/incoming_dids",
35 "related": "https://api.didww.com/v3/sms_trunk_groups/c5e7a9b1-6d3f-4f2a-8c4e-9b1d7f3a5e46/incoming_dids"
36 }
37 }
38 },
39 "meta": {
40 "sms_trunks_count": 2
41 }
42 }
43 ],
44 "included": [
45 {
46 "id": "3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24",
47 "type": "sms_trunks",
48 "attributes": {
49 "name": "Inbound webhook",
50 "external_reference_id": null,
51 "blocked": false,
52 "priority": 10,
53 "allow_any_did_as_source": false,
54 "allow_in": true,
55 "allow_out": false,
56 "created_at": "2026-10-22T09:15:42.118Z",
57 "updated_at": "2026-10-22T09:15:42.118Z",
58 "configuration": {
59 "type": "http_in",
60 "attributes": {
61 "http_method": "post",
62 "url": "https://example.com/sms",
63 "query_parameters": null,
64 "headers": {
65 "X-Source": "didww"
66 },
67 "follow_redirect": false,
68 "validate_https_certificate": true,
69 "body_type": "json",
70 "body": "{\"text\":\"{SMS_TEXT}\",\"from\":\"{SMS_SRC_ADDR}\",\"to\":\"{SMS_DST_ADDR}\"}"
71 }
72 }
73 },
74 "relationships": {
75 "outgoing_dids": {
76 "links": {
77 "self": "https://api.didww.com/v3/sms_trunks/3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24/relationships/outgoing_dids",
78 "related": "https://api.didww.com/v3/sms_trunks/3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24/outgoing_dids"
79 }
80 },
81 "incoming_dids": {
82 "links": {
83 "self": "https://api.didww.com/v3/sms_trunks/3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24/relationships/incoming_dids",
84 "related": "https://api.didww.com/v3/sms_trunks/3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24/incoming_dids"
85 }
86 },
87 "sms_trunk_group": {
88 "links": {
89 "self": "https://api.didww.com/v3/sms_trunks/3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24/relationships/sms_trunk_group",
90 "related": "https://api.didww.com/v3/sms_trunks/3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24/sms_trunk_group"
91 }
92 },
93 "sender_id_verifications": {
94 "links": {
95 "self": "https://api.didww.com/v3/sms_trunks/3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24/relationships/sender_id_verifications",
96 "related": "https://api.didww.com/v3/sms_trunks/3c7e9a1d-2b4f-4e6a-8d5c-1f9b0a7e3c24/sender_id_verifications"
97 }
98 }
99 }
100 },
101 {
102 "id": "0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90",
103 "type": "sms_trunks",
104 "attributes": {
105 "name": "Inbound email",
106 "external_reference_id": null,
107 "blocked": false,
108 "priority": 20,
109 "allow_any_did_as_source": false,
110 "allow_in": true,
111 "allow_out": false,
112 "created_at": "2026-10-22T09:15:42.118Z",
113 "updated_at": "2026-10-22T09:15:42.118Z",
114 "configuration": {
115 "type": "sms_to_email",
116 "attributes": {
117 "send_to": "sms@example.com",
118 "subject": "New SMS from {SMS_SRC_ADDR}",
119 "message": "{SMS_TIME} {SMS_SRC_ADDR} -> {SMS_DST_ADDR}: {SMS_TEXT}"
120 }
121 }
122 },
123 "relationships": {
124 "outgoing_dids": {
125 "links": {
126 "self": "https://api.didww.com/v3/sms_trunks/0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90/relationships/outgoing_dids",
127 "related": "https://api.didww.com/v3/sms_trunks/0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90/outgoing_dids"
128 }
129 },
130 "incoming_dids": {
131 "links": {
132 "self": "https://api.didww.com/v3/sms_trunks/0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90/relationships/incoming_dids",
133 "related": "https://api.didww.com/v3/sms_trunks/0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90/incoming_dids"
134 }
135 },
136 "sms_trunk_group": {
137 "links": {
138 "self": "https://api.didww.com/v3/sms_trunks/0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90/relationships/sms_trunk_group",
139 "related": "https://api.didww.com/v3/sms_trunks/0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90/sms_trunk_group"
140 }
141 },
142 "sender_id_verifications": {
143 "links": {
144 "self": "https://api.didww.com/v3/sms_trunks/0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90/relationships/sender_id_verifications",
145 "related": "https://api.didww.com/v3/sms_trunks/0b1f6c2e-5d4a-4f8e-9c3b-7a2d1e6f4b90/sender_id_verifications"
146 }
147 }
148 }
149 }
150 ],
151 "meta": {
152 "api_version": "2026-11-19",
153 "total_records": 1
154 },
155 "links": {
156 "first": "https://api.didww.com/v3/sms_trunk_groups?include=sms_trunks&page%5Bnumber%5D=1&page%5Bsize%5D=50",
157 "last": "https://api.didww.com/v3/sms_trunk_groups?include=sms_trunks&page%5Bnumber%5D=1&page%5Bsize%5D=50"
158 }
159}
Other Responses#
Code |
Success |
Description |
|---|---|---|
400 |
No |
|
401 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |