DID Group Object#

DID Group Object attributes and meta attributes.

Meta attributes are not available through includes.

Note

In version 2026-11-19, the number_type attribute replaces the did_group_type relationship. Requests that include did_group_type, filter by did_group_type.id, sort by did_group_type.name, or request did_group_type in sparse fieldsets return 400 Bad Request.

Attributes#

Name

Type

Description

area_name

string

DID Group area name. This will be the name of the city, or a designation applicable to the area code such as National.

prefix

string

DID Group prefix (city or area calling code).

features

Array of strings

Features available for the DID Group. Supported values are voice_in, voice_out, t38, sms_in, p2p, a2p, emergency, and cnam_out. A DID Group may have multiple features.

is_metered

boolean

Defines if the DID Group supports metered services (per-minute billing).

allow_additional_channels

boolean

Defines if channel capacity may be added to this DID Group.

service_restrictions

string or null

Service restrictions message for the DID Group, if any restrictions apply.

number_type

string

Number type offered by the DID Group. Possible values are local, national, mobile, toll_free, shared_cost, and global.

is_demo

boolean

Defines if the DID Group is flagged as a demo group.

Meta Attributes#

Name

Type

Description

needs_registration

boolean

Defines if end-user registration is required for this DID Group.

is_available

boolean

Defines if numbers in this DID Group are currently in stock.

available_dids_enabled

boolean

Defines if the DID Group supports numbers selection feature.

total_count

integer

Defines current stock available.

Relationships#

Name

Type

Description

country

to-one

Country Object. Returns the country assigned to the DID Group.

region

to-one

Region Object. Returns the region assigned to the DID Group.

city

to-one

City Object. Returns the city assigned to the DID Group.

stock_keeping_units

to-many

A list of Stock Keeping Unit Objects returned for the DID Group.

address_requirement

to-one

Address Requirement Object. Returns the address requirement assigned to the DID Group.