SearchAvailablePhoneNumbersRequest interface

Package:

@azure/communication-phone-numbers

Represents a phone number search request to find phone numbers. Found phone numbers are temporarily held for a following purchase.

Extends

PhoneNumberSearchRequest

Properties

countryCode

The ISO 3166-2 country code, e.g. US, representing the location of the search.

Inherited Properties

areaCode	The area code of the desired phone number, e.g. 425.
assignmentType	The assignment type of the phone numbers to search for. A phone number can be assigned to a person, or to an application.
capabilities	Capabilities of a phone number.
phoneNumberType	The type of phone numbers to search for, e.g. geographic, tollFree, mobile.
quantity	The quantity of desired phone numbers. The default value is 1.

Property Details

countryCode

The ISO 3166-2 country code, e.g. US, representing the location of the search.

countryCode: string

Property Value

string

Inherited Property Details

areaCode

The area code of the desired phone number, e.g. 425.

areaCode?: string

Property Value

string

Inherited From PhoneNumberSearchRequest.areaCode

assignmentType

The assignment type of the phone numbers to search for. A phone number can be assigned to a person, or to an application.

assignmentType: PhoneNumberAssignmentType

Property Value

PhoneNumberAssignmentType

Inherited From PhoneNumberSearchRequest.assignmentType

capabilities

Capabilities of a phone number.

capabilities: PhoneNumberCapabilities

Property Value

PhoneNumberCapabilities

Inherited From PhoneNumberSearchRequest.capabilities

phoneNumberType

The type of phone numbers to search for, e.g. geographic, tollFree, mobile.

phoneNumberType: PhoneNumberType

Property Value

PhoneNumberType

Inherited From PhoneNumberSearchRequest.phoneNumberType

quantity

The quantity of desired phone numbers. The default value is 1.

quantity?: number

Property Value

number

Inherited From PhoneNumberSearchRequest.quantity