AvailablePhoneNumber interface

Package:

@azure/communication-phone-numbers

Represents a phone number available in inventory

Properties

assignmentType	Represents the assignment type of the offering. Also known as the use case.
capabilities	Capabilities of a phone number.
cost	The incurred cost for this phone number.
countryCode	The ISO 3166-2 country code, e.g. US.
error	The Communication Services error.
id	The id of the phone number.
isAgreementToNotResellRequired	Indicates if do not resell agreement is required. If true, the phone number cannot be acquired unless the customer provides explicit agreement to not resell it.
phoneNumber	The phone number in E.164 format, e.g. +11234567890.
phoneNumberType	Represents the number type of the offering.
status	Represents the status of the phone number. Possible values include: 'available', 'reserved', 'expired', 'error', 'purchased'.

Property Details

assignmentType

Represents the assignment type of the offering. Also known as the use case.

assignmentType: PhoneNumberAssignmentType

Property Value

PhoneNumberAssignmentType

capabilities

Capabilities of a phone number.

capabilities: PhoneNumberCapabilities

Property Value

PhoneNumberCapabilities

cost

The incurred cost for this phone number.

cost?: PhoneNumberCost

Property Value

PhoneNumberCost

countryCode

The ISO 3166-2 country code, e.g. US.

countryCode: string

Property Value

string

error

The Communication Services error.

error?: CommunicationError

Property Value

CommunicationError

id

The id of the phone number.

id?: string

Property Value

string

isAgreementToNotResellRequired

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

isAgreementToNotResellRequired?: boolean

Property Value

boolean

phoneNumber

The phone number in E.164 format, e.g. +11234567890.

phoneNumber?: string

Property Value

string

phoneNumberType

Represents the number type of the offering.

phoneNumberType: PhoneNumberType

Property Value

PhoneNumberType

status

Represents the status of the phone number. Possible values include: 'available', 'reserved', 'expired', 'error', 'purchased'.

status?: PhoneNumberAvailabilityStatus

Property Value

PhoneNumberAvailabilityStatus