Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PhoneNumberSearch

Package version

Represents a phone number search

Hierarchy

  • PhoneNumberSearch

Index

Properties

Optional areaCode

areaCode: undefined | string

The area code of the search.

Optional createdAt

createdAt: Date

The creation time of the search.

Optional description

description: undefined | string

The description of the search.

Optional displayName

displayName: undefined | string

The name of the search.

Optional errorCode

errorCode: undefined | number

The error code of the search.

Optional locationOptions

locationOptions: LocationOptionsDetails[]

The location options of the search.

Optional phoneNumbers

phoneNumbers: string[]

The list of phone numbers in the search, in the case the status is reserved or success.

Optional phonePlanIds

phonePlanIds: string[]

The phone plan ids of the search.

Optional quantity

quantity: undefined | number

The quantity of phone numbers in the search.

Optional reservationExpiryDate

reservationExpiryDate: Date

The date that search expires and the numbers become available.

Optional searchId

searchId: undefined | string

The id of the search.

Optional status

status: SearchStatus

The status of the search. Possible values include: 'Pending', 'InProgress', 'Reserved', 'Expired', 'Expiring', 'Completing', 'Refreshing', 'Success', 'Manual', 'Cancelled', 'Cancelling', 'Error', 'PurchasePending'

Generated using TypeDoc