SMS Trunk Group Object#
JSON:API object with type sms_trunk_groups.
Request#
URI Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique identifier of the SMS trunk group. |
Data Attributes#
Name |
Type |
Description |
|---|---|---|
name |
|
Friendly name of the SMS trunk group. Must be unique among the SMS trunks and SMS trunk groups of the account. |
external_reference_id |
|
Optional identifier for the SMS trunk group in the customer’s external system. Maximum length is 100 characters. Can be |
created_at |
|
Read-only. The date and time when the SMS trunk group was created. |
updated_at |
|
Read-only. The date and time when the SMS trunk group was last updated. |
Object Relationships#
Name |
Type |
Description |
|---|---|---|
sms_trunks |
to-many |
SMS Trunk Object. The trunks in the group. Their |
incoming_dids |
to-many |
DID Object. Read-only. DIDs routed to the group for inbound messages. A DID is routed to a group through the |
Object Meta#
Name |
Type |
Description |
|---|---|---|
sms_trunks_count |
|
Number of trunks currently in the group. Returned on every SMS trunk group. |