@dialstack/sdk / index / UpdatePhoneNumberRequest
Interface: UpdatePhoneNumberRequest
Defined in: sdk/src/types/phone-numbers.ts:96
Request body for updating a phone number via POST /v1/phone-numbers/:id
Properties
caller_id_name?
optional caller_id_name?: string;
Defined in: sdk/src/types/phone-numbers.ts:106
caller_id_prefix?
optional caller_id_prefix?: string | null;
Defined in: sdk/src/types/phone-numbers.ts:111
Prefix added to the inbound caller's display name shown on the answering
device (e.g. [Acme] John Smith). Send null to clear.
caller_id_visibility?
optional caller_id_visibility?: "PUBLIC" | "PRIVATE";
Defined in: sdk/src/types/phone-numbers.ts:112
config?
optional config?: DIDConfig | null;
Defined in: sdk/src/types/phone-numbers.ts:115
Pass null to clear the per-DID config blob.
directory_listing_location?
optional directory_listing_location?: string;
Defined in: sdk/src/types/phone-numbers.ts:103
directory_listing_location_id?
optional directory_listing_location_id?: string;
Defined in: sdk/src/types/phone-numbers.ts:105
Deprecated
Use directory_listing_location. Retained for backwards compatibility.
directory_listing_name?
optional directory_listing_name?: string;
Defined in: sdk/src/types/phone-numbers.ts:101
directory_listing_type?
optional directory_listing_type?: DirectoryListingType;
Defined in: sdk/src/types/phone-numbers.ts:102
expires_at?
optional expires_at?: null;
Defined in: sdk/src/types/phone-numbers.ts:100
Pass null to convert a temporary number to permanent. Extending the expiry is not supported.
fax_enabled?
optional fax_enabled?: boolean;
Defined in: sdk/src/types/phone-numbers.ts:113
outbound_enabled?
optional outbound_enabled?: boolean;
Defined in: sdk/src/types/phone-numbers.ts:97
status?
optional status?: "active" | "inactive";
Defined in: sdk/src/types/phone-numbers.ts:98