PhoneNumberSearchResult interface

Package:

@azure/communication-phone-numbers

The result of a phone number search operation.

Properties

assignmentType	Phone number's assignment type.
capabilities	Capabilities of a phone number.
cost	The incurred cost for a single phone number.
error	Mapping Error Messages to Codes
errorCode	The error code of the search.
isAgreementToNotResellRequired	Indicates if do not resell agreement is required. If true, the phone numbers cannot be acquired unless the customer provides explicit agreement to not resell them.
phoneNumbers	The phone numbers that are available. Can be fewer than the desired search quantity.
phoneNumberType	The phone number's type, e.g. geographic, tollFree, mobile.
searchExpiresBy	The date that this search result expires and phone numbers are no longer on hold. A search result expires in less than 15min, e.g. 2020-11-19T16:31:49.048Z.
searchId	The search id.

Property Details

assignmentType

Phone number's assignment type.

assignmentType: PhoneNumberAssignmentType

Property Value

PhoneNumberAssignmentType

capabilities

Capabilities of a phone number.

capabilities: PhoneNumberCapabilities

Property Value

PhoneNumberCapabilities

cost

The incurred cost for a single phone number.

cost: PhoneNumberCost

Property Value

PhoneNumberCost

error

Mapping Error Messages to Codes

error?: PhoneNumberSearchResultError

Property Value

PhoneNumberSearchResultError

errorCode

The error code of the search.

errorCode?: number

Property Value

number

isAgreementToNotResellRequired

Indicates if do not resell agreement is required. If true, the phone numbers cannot be acquired unless the customer provides explicit agreement to not resell them.

isAgreementToNotResellRequired?: boolean

Property Value

boolean

phoneNumbers

The phone numbers that are available. Can be fewer than the desired search quantity.

phoneNumbers: string[]

Property Value

string[]

phoneNumberType

The phone number's type, e.g. geographic, tollFree, mobile.

phoneNumberType: PhoneNumberType

Property Value

PhoneNumberType

searchExpiresBy

The date that this search result expires and phone numbers are no longer on hold. A search result expires in less than 15min, e.g. 2020-11-19T16:31:49.048Z.

searchExpiresBy: Date

Property Value

Date

searchId

The search id.

searchId: string

Property Value

string