SMS Trunk Object#
JSON:API object with type sms_trunks.
The trunk type is defined by data.attributes.configuration.type. The configuration
attributes depend on the type. See Configuration.
Request#
URI Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique identifier of the SMS trunk. |
Data Attributes#
Name |
Type |
Description |
|---|---|---|
name |
|
Friendly name of the SMS trunk. Must be unique among the SMS trunks and SMS trunk groups of the account. |
external_reference_id |
|
Optional identifier for the SMS trunk in the customer’s external system. Maximum length is 100 characters. Can be |
blocked |
|
When |
priority |
|
Routing priority of the trunk within its SMS Trunk Group. The range is 0-32767. Defaults to |
allow_any_did_as_source |
|
When |
allow_in |
|
Read-only. |
allow_out |
|
Read-only. |
configuration |
|
Trunk configuration object with |
created_at |
|
Read-only. The date and time when the SMS trunk was created. |
updated_at |
|
Read-only. The date and time when the SMS trunk was last updated. |
Object Relationships#
Name |
Type |
Description |
|---|---|---|
outgoing_dids |
to-many |
DID Object. DIDs allowed as the source address of messages sent through the trunk. Empty while |
incoming_dids |
to-many |
DID Object. Read-only. DIDs routed to the trunk for inbound messages. A DID is routed to a trunk through the |
sms_trunk_group |
to-one |
SMS Trunk Group Object. The group the trunk belongs to. Can be |
sender_id_verifications |
to-many |
Sender ID Verification Object. Read-only. Sender ID verifications routed through the trunk. A verification is routed through a trunk with its |
Object Meta#
Name |
Type |
Description |
|---|---|---|
host |
|
Full URL of the endpoint to which outbound messages are submitted, for example |
Configuration#
The configuration object contains:
Name |
Type |
Description |
|---|---|---|
type |
|
Configuration type. Possible values: |
attributes |
|
Configuration attributes. Their set depends on |
The configuration type defines what the trunk can do:
Type |
|
|
Can join a group |
Generated credentials |
|---|---|---|---|---|
|
|
|
Yes |
None |
|
|
|
Yes |
None |
|
|
|
No |
|
|
|
|
Yes |
|
|
|
|
Yes |
None |
Read-only attributes are generated by DIDWW and cannot be sent in requests. Generated credentials can be replaced with Regenerate SMS Trunk Credentials.
sms_to_email#
DIDWW forwards inbound messages as email. See SMS to Email trunk.
Name |
Type |
Nullable |
Read-only |
Description |
|---|---|---|---|---|
send_to |
|
No |
No |
Recipient email address. |
subject |
|
No |
No |
Email subject template. |
message |
|
No |
No |
Email body template. |
http_in#
DIDWW delivers inbound messages as an HTTP request. The query parameters, headers, and body
can use the placeholders {SMS_TEXT}, {SMS_TEXT_BASE64_ENCODED}, {SMS_SRC_ADDR},
{SMS_DST_ADDR}, and {SMS_TIME}. See SMS IN HTTP specification
and SMS to HTTP IN trunk.
Name |
Type |
Nullable |
Read-only |
Description |
|---|---|---|---|---|
url |
|
No |
No |
Endpoint the request is sent to. |
http_method |
|
No |
No |
HTTP method of the request. Possible values: |
query_parameters |
|
Yes |
No |
Query parameters added to the request, as an object of string names and string values. |
headers |
|
Yes |
No |
Headers added to the request, as an object of string names and string values. |
body_type |
|
Yes |
No |
How |
body |
|
Yes |
No |
Request body template. A JSON object encoded as a string when |
follow_redirect |
|
No |
No |
When |
validate_https_certificate |
|
No |
No |
When |
http_out#
The customer submits outbound messages to DIDWW over HTTP, to the endpoint URL returned in
meta.host. See SMS OUT HTTP specification and
SMS to HTTP OUT trunk.
Name |
Type |
Nullable |
Read-only |
Description |
|---|---|---|---|---|
callback_url |
|
Yes |
No |
HTTP(S) URL to which DIDWW sends the status events of messages submitted through the trunk. See SMS OUT callbacks. |
allowed_ips |
Array of |
Yes |
No |
IP addresses from which messages are accepted, in the format (IPv4|IPv6)[/mask]. Up to 15 unique entries. Single addresses are returned as /32 (IPv4) or /128 (IPv6) networks; IPv6 addresses are returned in full (uncompressed) notation. When empty, messages are accepted from any address. |
auth_name |
|
Yes |
Yes |
Generated HTTP authentication username. See SMS OUT authentication. |
auth_password |
|
Yes |
Yes |
Generated HTTP authentication password. |
smpp_esme#
The customer connects and binds to DIDWW as an SMPP ESME. See SMPP specification, SMPP over TLS, and SMPP ESME trunk.
Name |
Type |
Nullable |
Read-only |
Description |
|---|---|---|---|---|
system_type |
|
Yes |
No |
SMPP |
allowed_ips |
Array of |
Yes |
No |
IP addresses from which the ESME may bind, in the format (IPv4|IPv6)[/mask]. Up to 15 unique entries. Single addresses are returned as /32 (IPv4) or /128 (IPv6) networks; IPv6 addresses are returned in full (uncompressed) notation. When empty, binding is allowed from any address. |
server_location |
|
No |
No |
Location of the DIDWW SMPP server the trunk is served from. Possible values: |
system_id |
|
No |
Yes |
Generated SMPP |
password |
|
No |
Yes |
Generated SMPP bind password. |
smpp_smsc#
DIDWW connects and binds to the customer’s SMSC as an SMPP client. See SMPP specification and SMPP SMSC trunk.
Name |
Type |
Nullable |
Read-only |
Description |
|---|---|---|---|---|
host |
|
No |
No |
SMSC host DIDWW binds to. |
tx_port |
|
No |
No |
Transmitter port. Default value is |
rx_port |
|
No |
No |
Receiver port. Default value is |
transceiver_mode |
|
No |
No |
When |
connection_timeout |
|
No |
No |
Bind timeout in seconds. Default value is |
use_ssl |
|
No |
No |
When |
system_id |
|
No |
No |
SMPP |
system_type |
|
Yes |
No |
SMPP |
password |
|
No |
No |
SMPP bind password. Maximum length is 8 characters. |
server_location |
|
No |
No |
Location of the DIDWW SMPP server that connects to the SMSC. Possible values: |