Skip to main content

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

Interface: PhoneNumberItem

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

A unified phone number item merging data from DIDs, number orders, and port orders

Properties​

caller_id_name?​

TypeScript
optional caller_id_name?: string | null;

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

caller_id_prefix?​

TypeScript
optional caller_id_prefix?: string | null;

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

Prefix added to the inbound caller's display name (see DIDItem). Read from the DID record. Rows for an in-flight order or port leave it unset even where a backing DID exists, since no tab shows a prefix for a number that isn't live yet.

carrier?​

TypeScript
optional carrier?: string;

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

created_at​

TypeScript
created_at: string;

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

did?​

TypeScript
optional did?: string;

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

did_id?​

TypeScript
optional did_id?: string;

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

Deprecated​

Use did. Retained for backwards compatibility.

disconnected_at?​

TypeScript
optional disconnected_at?: string | null;

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

expires_at?​

TypeScript
optional expires_at?: string | null;

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

fax_enabled?​

TypeScript
optional fax_enabled?: boolean;

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

inbound_routing​

TypeScript
inbound_routing: InboundRouting;

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

Inbound call handling. routing_target is null when this is drop. Number-order and port-order rows are not yet DIDs and are always default.

number_class?​

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

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

order?​

TypeScript
optional order?: string;

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

order_id?​

TypeScript
optional order_id?: string;

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

Deprecated​

Use order. Retained for backwards compatibility.

outbound_enabled​

TypeScript
outbound_enabled: boolean | null;

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

phone_number​

TypeScript
phone_number: string;

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

port_order?​

TypeScript
optional port_order?: string;

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

port_order_id?​

TypeScript
optional port_order_id?: string;

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

Deprecated​

Use port_order. Retained for backwards compatibility.

routing_target?​

TypeScript
optional routing_target?: string | null;

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

source​

TypeScript
source: "did" | "number_order" | "port_order";

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

status​

TypeScript
status: PhoneNumberStatus;

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

transfer_date?​

TypeScript
optional transfer_date?: string;

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

updated_at​

TypeScript
updated_at: string;

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

On this page