SMS Trunk Group Object#

JSON:API object with type sms_trunk_groups.

Request#

URI Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique identifier of the SMS trunk group.

Data Attributes#

Name

Type

Description

name

string

Friendly name of the SMS trunk group. Must be unique among the SMS trunks and SMS trunk groups of the account.

external_reference_id

string

Optional identifier for the SMS trunk group in the customer’s external system. Maximum length is 100 characters. Can be null.

created_at

DateTime

Read-only. The date and time when the SMS trunk group was created.

updated_at

DateTime

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 priority defines the delivery order within the group.

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 sms_trunk_group relationship of the DID.

Object Meta#

Name

Type

Description

sms_trunks_count

integer

Number of trunks currently in the group. Returned on every SMS trunk group.