Skip to main content

@dialstack/sdk-dev / js/src / DIDItem

Interface: DIDItem

Defined in: sdk/js/src/types/phone-numbers.ts:50

Properties​

activated_at?​

TypeScript
activated_at?: string | null;

Defined in: sdk/js/src/types/phone-numbers.ts:73

When the number last went into service, or null until it first has. Moving the number to another account does not change it. A number can be disconnected 30 days after this time.


caller_id_name?​

TypeScript
caller_id_name?: string | null;

Defined in: sdk/js/src/types/phone-numbers.ts:77


caller_id_prefix?​

TypeScript
caller_id_prefix?: string | null;

Defined in: sdk/js/src/types/phone-numbers.ts:86

Prefix added to the inbound caller's display name (e.g. [Acme] John Smith, or [Acme] +14084806024 when the caller's name is unknown), for calls answered on behalf of a specific brand or business. Applies both to the device that answers and to calls forwarded out to an external number, so a forwarded business call can be told apart from a personal one. Affects only the caller ID presented for inbound calls, not call records.


config?​

TypeScript
config?: DIDConfig;

Defined in: sdk/js/src/types/phone-numbers.ts:76


country?​

TypeScript
country?: string;

Defined in: sdk/js/src/types/phone-numbers.ts:65

The number's ISO 3166-1 alpha-2 country: US or CA today, more as countries are added, so it is not a closed union. Toll-free numbers report US. A directory listing is available only for US numbers.


created_at​

TypeScript
created_at: string;

Defined in: sdk/js/src/types/phone-numbers.ts:103


directory_listing_location?​

TypeScript
directory_listing_location?: string | null;

Defined in: sdk/js/src/types/phone-numbers.ts:89


directory_listing_location_id?​

TypeScript
directory_listing_location_id?: string | null;

Defined in: sdk/js/src/types/phone-numbers.ts:91

Deprecated​

Use directory_listing_location. Retained for backwards compatibility.


directory_listing_name?​

TypeScript
directory_listing_name?: string | null;

Defined in: sdk/js/src/types/phone-numbers.ts:87


directory_listing_type?​

TypeScript
directory_listing_type?: DirectoryListingType;

Defined in: sdk/js/src/types/phone-numbers.ts:88


disconnected_at?​

TypeScript
disconnected_at?: string | null;

Defined in: sdk/js/src/types/phone-numbers.ts:67


expires_at?​

TypeScript
expires_at?: string | null;

Defined in: sdk/js/src/types/phone-numbers.ts:66


fax_enabled​

TypeScript
fax_enabled: boolean;

Defined in: sdk/js/src/types/phone-numbers.ts:75


id​

TypeScript
id: string;

Defined in: sdk/js/src/types/phone-numbers.ts:51


inbound_routing​

TypeScript
inbound_routing: InboundRouting;

Defined in: sdk/js/src/types/phone-numbers.ts:102

Inbound call handling. routing_target is null when this is drop.


location?​

TypeScript
location?: string | null;

Defined in: sdk/js/src/types/phone-numbers.ts:99

ID of this number's service location, used for tax jurisdiction and regulatory fees. When null the number resolves to the location it is the primary number for, else the account's main location — both correct answers rather than missing ones. Distinct from directory_listing_location, which is the address published in directory services.


number_class?​

TypeScript
number_class?: "account_owned" | "temporary";

Defined in: sdk/js/src/types/phone-numbers.ts:54


number_type?​

TypeScript
number_type?: PhoneNumberType;

Defined in: sdk/js/src/types/phone-numbers.ts:59

toll_free for an 8YY number. Toll-free numbers support no caller ID name, directory listing or outbound porting PIN.


outbound_enabled​

TypeScript
outbound_enabled: boolean;

Defined in: sdk/js/src/types/phone-numbers.ts:74


phone_number​

TypeScript
phone_number: string;

Defined in: sdk/js/src/types/phone-numbers.ts:52


routing_target?​

TypeScript
routing_target?: string | null;

Defined in: sdk/js/src/types/phone-numbers.ts:100


status​

TypeScript
status: "active" | "inactive" | "released";

Defined in: sdk/js/src/types/phone-numbers.ts:53


updated_at​

TypeScript
updated_at: string;

Defined in: sdk/js/src/types/phone-numbers.ts:104