DID Object

DID Object attributes.

Attributes

Name

Type

Description

blocked

boolean

Identifier for a blocked DID. Blocked DIDs are numbers that have expired, have been cancelled or have been suspended by DIDWW.

awaiting_registration

boolean

Identifier for a DID that is awaiting registration.

pending_removal

boolean

Indicates whether the DID is pending removal.

terminated

boolean

Identifier for terminated DIDs that will be removed from service at the end of the billing cycle.

description

string

Custom DID description for customers reference.

number

string

The actual DID number in the format [country code][area code][subscriber number].

capacity_limit

integer

The capacity limit (maximum number of simultaneous calls) for this DID.

channels_included_count

integer

The number of channels included with this DID.

dedicated_channels_count

integer

The number of channels from Capacity Pool.

expires_at

DateTime

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

DateTime

DID created at DateTime.

billing_cycles_count

integer

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

boolean

Indicates whether the DID is assigned to an Emergency Calling Service.

Relationships

Name

Type

Description

order

to-one

Order Object

voice_in_trunk

to-one

Inbound Trunk Object

voice_in_trunk_group

to-one

Inbound Trunk Group Object

capacity_pool

to-one

Capacity Pool Object

shared_capacity_group

to-one

Shared Capacity Group Object

did_group

to-one

DID Group Object

address_verification

to-one

Address Verifications Object

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.