DID Object#
DID Object attributes.
Attributes#
Name |
Type |
Description |
|---|---|---|
blocked |
|
Identifier for a blocked DID. Blocked DIDs are numbers that have expired, have been cancelled or have been suspended by DIDWW. |
awaiting_registration |
|
Identifier for a DID that is awaiting registration. |
terminated |
|
Identifier for terminated DIDs that will be removed from service at the end of the billing cycle. |
description |
|
Custom DID description for customers reference. |
number |
|
The actual DID number in the format [country code][area code][subscriber number]. |
capacity_limit |
|
The capacity limit (maximum number of simultaneous calls) for this DID. |
channels_included_count |
|
The number of channels included with this DID. |
dedicated_channels_count |
|
The number of channels from Capacity Pool. |
expires_at |
|
DateTime when the DID expired or will expire. DateTime is in the ISO 8601 format ‘yyyy-MM-dd’T’HH:mm:ss.SSS’Z’, where ‘SSS’ are milliseconds and ‘Z’ denotes Zulu time (UTC) |
created_at |
|
DID created at DateTime. |
billing_cycles_count |
|
Specifies how many renewal cycles remain before the DID expires. A value of null indicates unlimited automatic renewals; setting it to 0 disables auto-renewal. Each billing period decrements this count by one (max value: 999). |
emergency_enabled |
|
Indicates whether the DID is assigned to an Emergency Calling Service. |
Relationships#
Name |
Type |
Description |
|---|---|---|
order |
to-one |
|
voice_in_trunk |
to-one |
|
voice_in_trunk_group |
to-one |
|
sms_trunk |
to-one |
SMS Trunk Object. Returns the SMS trunk that receives inbound SMS for the DID. Empty when the DID is routed to an SMS trunk group or has no inbound SMS route. |
sms_trunk_group |
to-one |
SMS Trunk Group Object. Returns the SMS trunk group that receives inbound SMS for the DID. Empty when the DID is routed to a single SMS trunk or has no inbound SMS route. |
capacity_pool |
to-one |
|
shared_capacity_group |
to-one |
|
did_group |
to-one |
|
address_verification |
to-one |
|
identity |
to-one |
Identity Object. Represents the main identity assigned to the DID, or the porting identity as a fallback. |
emergency_calling_service |
to-one |
Emergency Calling Service Object. Returns the Emergency Calling Service assigned to the DID. |
emergency_verification |
to-one |
Emergency Verification resource. Returns the Emergency Verification related to the DID. |