did

API Docs by APIMATIC

DID

Fields

NameDescription
id
Number

The unique ID of the DID on the platform

number
String

The DID number

country
String

The country the DID belongs to

city
String

Name of the city or rate center for the DID

state
String

Name of the state or province if the country the DID belongs to has states or provinces

country_short_name
String

2 letter ISO code of the country

label
String

Label assigned to the DID

status
added
Date

The date the DID was added to the account

seconds
Number

Duration of all inbound calls to the DID in the current month, in seconds

paid_until
Date

The date when the next monthly DID charge is due

channels
Decimal

Number of inbound channels on the DID

activation_fee
Number

Activation fee for the DID, in cents

monthly_fee
Number

Monthly fee for the DID, in cents

sms_enabled
Boolean

Indicates if the DID is SMS enabled

per_min
Number

Price per minute for inbound call, in cents

free_min
Decimal

Amount of free inbound minutes for the DID

unlimited
Boolean

Indicates if all inbound calls are free of charge

cnam
Boolean

Indicates if CNAM dips are enabled on the DID

destination

A list of destinations for inbound call routing

require_docs

Types of documents required for the DID activation

documents

A list of uploaded documents

{
  "id": null,
  "number": null,
  "country": null,
  "city": null,
  "state": null,
  "country_short_name": null,
  "label": null,
  "status": null,
  "added": null,
  "seconds": null,
  "paid_until": null,
  "channels": null,
  "activation_fee": null,
  "monthly_fee": null,
  "sms_enabled": null,
  "per_min": null,
  "free_min": null,
  "unlimited": null,
  "cnam": null,
  "destination": null,
  "require_docs": null,
  "documents": null
}