DID Group Object
DID Group Object attributes and meta attributes.
Meta attributes are not available through includes.
Attributes
Name |
Type |
Description |
|---|---|---|
area_name |
|
DID Group area name. This will be the name of the city, or a designation applicable to the area code such as National. |
prefix |
|
DID Group prefix (city or area calling code). |
features |
Array of |
Features available for the DID Group. Supported values are |
is_metered |
|
Defines if the DID Group supports metered services (per-minute billing). |
allow_additional_channels |
|
Defines if channel capacity may be added to this DID Group. |
service_restrictions |
|
Service restrictions message for the DID Group, if any restrictions apply. |
Meta Attributes
Name |
Type |
Description |
|---|---|---|
needs_registration |
|
Defines if end-user registration is required for this DID Group. |
is_available |
|
Defines if numbers in this DID Group are currently in stock. |
available_dids_enabled |
|
Defines if the DID Group supports numbers selection feature. |
total_count |
|
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. |
did_group_type |
to-one |
DID Group Type Object. Returns the DID Group Type 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. |