Skip to main content

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

Interface: SearchAvailableNumbersOptions

Defined in: sdk/js/src/types/phone-number-ordering.ts:17

Properties​

areaCode?​

TypeScript
areaCode?: string;

Defined in: sdk/js/src/types/phone-number-ordering.ts:21

A local area code, or with numberType: 'toll_free', one toll-free code.


city?​

TypeScript
city?: string;

Defined in: sdk/js/src/types/phone-number-ordering.ts:36

A city name. Requires state.


contains?​

TypeScript
contains?: string;

Defined in: sdk/js/src/types/phone-number-ordering.ts:27

With numberType: 'toll_free', 4 to 7 letters or digits that the number's last seven digits spell on a phone keypad, anywhere in them (HELLO finds 1-844-75-HELLO). Case, spaces and hyphens are ignored.


country?​

TypeScript
country?: string;

Defined in: sdk/js/src/types/phone-number-ordering.ts:41

The two-letter country to search. Optional: worked out from state or areaCode when omitted; a state or areaCode outside it is refused.


numberType?​

TypeScript
numberType?: PhoneNumberType;

Defined in: sdk/js/src/types/phone-number-ordering.ts:19

Which numbers to search. Defaults to local.


quantity?​

TypeScript
quantity?: number;

Defined in: sdk/js/src/types/phone-number-ordering.ts:42


state?​

TypeScript
state?: string;

Defined in: sdk/js/src/types/phone-number-ordering.ts:34

A two-letter US state or Canadian province code (NC, ON, QC). A province searches Canadian numbers.


zip?​

TypeScript
zip?: string;

Defined in: sdk/js/src/types/phone-number-ordering.ts:29

A five-digit US ZIP code. Canadian postal codes can't be searched.