Skip to main content

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

Interface: UpdatePhoneNumberRequest

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

Request body for updating a phone number via POST /v1/phone-numbers/:id

Properties

caller_id_name?

TypeScript
optional caller_id_name?: string;

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


caller_id_prefix?

TypeScript
optional caller_id_prefix?: string | null;

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

Prefix added to the inbound caller's display name (e.g. [Acme] John Smith, or [Acme] +14084806024 when the caller's name is unknown). Applies both to the device that answers and to calls forwarded out to an external number. Send null to clear.


caller_id_visibility?

TypeScript
optional caller_id_visibility?: "PUBLIC" | "PRIVATE";

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


config?

TypeScript
optional config?: DIDConfig | null;

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

Pass null to clear the per-DID config blob.


directory_listing_location?

TypeScript
optional directory_listing_location?: string;

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


directory_listing_location_id?

TypeScript
optional directory_listing_location_id?: string;

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

Deprecated

Use directory_listing_location. Retained for backwards compatibility.


directory_listing_name?

TypeScript
optional directory_listing_name?: string;

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


directory_listing_type?

TypeScript
optional directory_listing_type?: DirectoryListingType;

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


expires_at?

TypeScript
optional expires_at?: null;

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

Pass null to convert a temporary number to permanent. Extending the expiry is not supported.


fax_enabled?

TypeScript
optional fax_enabled?: boolean;

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


outbound_enabled?

TypeScript
optional outbound_enabled?: boolean;

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


status?

TypeScript
optional status?: "active" | "inactive";

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