@dialstack/sdk-dev / js/src / UpdatePhoneNumberRequest
Interface: UpdatePhoneNumberRequest
Defined in: sdk/js/src/types/phone-numbers.ts:145
Request body for updating a phone number via POST /v1/phone-numbers/:id
Properties
caller_id_name?
caller_id_name?: string;
Defined in: sdk/js/src/types/phone-numbers.ts:165
caller_id_prefix?
caller_id_prefix?: string | null;
Defined in: sdk/js/src/types/phone-numbers.ts:172
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?
caller_id_visibility?: "PUBLIC" | "PRIVATE";
Defined in: sdk/js/src/types/phone-numbers.ts:173
config?
config?: DIDConfig | null;
Defined in: sdk/js/src/types/phone-numbers.ts:176
Pass null to clear the per-DID config blob.
directory_listing_location?
directory_listing_location?: string;
Defined in: sdk/js/src/types/phone-numbers.ts:160
directory_listing_location_id?
directory_listing_location_id?: string;
Defined in: sdk/js/src/types/phone-numbers.ts:162
Deprecated
Use directory_listing_location. Retained for backwards compatibility.
directory_listing_name?
directory_listing_name?: string;
Defined in: sdk/js/src/types/phone-numbers.ts:158
directory_listing_type?
directory_listing_type?: DirectoryListingType;
Defined in: sdk/js/src/types/phone-numbers.ts:159
expires_at?
expires_at?: null;
Defined in: sdk/js/src/types/phone-numbers.ts:157
Pass null to convert a temporary number to permanent. Extending the expiry is not supported.
fax_enabled?
fax_enabled?: boolean;
Defined in: sdk/js/src/types/phone-numbers.ts:174
location?
location?: string | null;
Defined in: sdk/js/src/types/phone-numbers.ts:164
Assign the number's service location, or null to clear it.
outbound_enabled?
outbound_enabled?: boolean;
Defined in: sdk/js/src/types/phone-numbers.ts:146
status?
status?: "active" | "inactive";
Defined in: sdk/js/src/types/phone-numbers.ts:155
'active' on a released number recovers it. Sending the number's current
status changes nothing; any other change is rejected by the API. Disconnect
a number to take it out of service.
'inactive' is deprecated: it is accepted only as that no-op and will be
removed, so omit status instead.