Skip to main content

@dialstack/sdk / index / UpdatePhoneNumberRequest

Interface: UpdatePhoneNumberRequest

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

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:68


caller_id_visibility?

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

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


config?

optional config?: DIDConfig | null;

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

Pass null to clear the per-DID config blob.


directory_listing_location_id?

optional directory_listing_location_id?: string;

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


directory_listing_name?

optional directory_listing_name?: string;

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


directory_listing_type?

optional directory_listing_type?: DirectoryListingType;

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


expires_at?

optional expires_at?: null;

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

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:70


outbound_enabled?

optional outbound_enabled?: boolean;

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


status?

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

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