Get SMS Trunk#

Returns a single SMS trunk owned by the account.

On an http_out trunk, meta.host contains the full URL of the endpoint to which outbound messages are submitted.

Request#

HTTP Method: GET

URI Path: /v3/sms_trunks/{id}

Note

For all returned data attributes, see SMS Trunk Object.

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique identifier of the SMS trunk.

include

string

No

Inclusion

fields[sms_trunks]

string

No

Sparse fieldsets

Includes#

Value

Description

outgoing_dids

DID Object. DIDs allowed as the source address of outbound messages.

incoming_dids

DID Object. DIDs routed to the trunk for inbound messages.

sms_trunk_group

SMS Trunk Group Object

sender_id_verifications

Sender ID Verification Object. Sender ID verifications routed through the trunk.

Examples#

http

1GET /v3/sms_trunks/6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13 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_trunks/6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13 -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    "id": "6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13",
 7    "type": "sms_trunks",
 8    "attributes": {
 9      "name": "Outbound HTTP",
10      "external_reference_id": null,
11      "blocked": false,
12      "priority": null,
13      "allow_any_did_as_source": false,
14      "allow_in": false,
15      "allow_out": true,
16      "created_at": "2026-10-22T09:15:42.118Z",
17      "updated_at": "2026-10-22T09:15:42.118Z",
18      "configuration": {
19        "type": "http_out",
20        "attributes": {
21          "callback_url": "https://example.com/sms/status",
22          "allowed_ips": [
23            "203.0.113.10/32"
24          ],
25          "auth_name": "k3v9xq2m7p",
26          "auth_password": "w8r2c5n1zt"
27        }
28      }
29    },
30    "relationships": {
31      "outgoing_dids": {
32        "links": {
33          "self": "https://api.didww.com/v3/sms_trunks/6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13/relationships/outgoing_dids",
34          "related": "https://api.didww.com/v3/sms_trunks/6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13/outgoing_dids"
35        }
36      },
37      "incoming_dids": {
38        "links": {
39          "self": "https://api.didww.com/v3/sms_trunks/6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13/relationships/incoming_dids",
40          "related": "https://api.didww.com/v3/sms_trunks/6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13/incoming_dids"
41        }
42      },
43      "sms_trunk_group": {
44        "links": {
45          "self": "https://api.didww.com/v3/sms_trunks/6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13/relationships/sms_trunk_group",
46          "related": "https://api.didww.com/v3/sms_trunks/6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13/sms_trunk_group"
47        }
48      },
49      "sender_id_verifications": {
50        "links": {
51          "self": "https://api.didww.com/v3/sms_trunks/6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13/relationships/sender_id_verifications",
52          "related": "https://api.didww.com/v3/sms_trunks/6a2d4f8b-1c3e-4b7a-9e5f-2d8c0b6a4f13/sender_id_verifications"
53        }
54      }
55    },
56    "meta": {
57      "host": "https://us.sms-out.didww.com/outbound_messages"
58    }
59  },
60  "meta": {
61    "api_version": "2026-11-19"
62  }
63}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.