PhoneNumbersReservation interface

Package:

@azure/communication-phone-numbers

Represents a reservation for phone numbers. A reservation is a temporary hold on phone numbers that can later be purchased. The reservation has a limited lifetime after which the phone numbers are released if not purchased. Reservations older than 1 month are automatically deleted.

Properties

expiresAt	The time at which the reservation will expire. If a reservation is not purchased before this time, all of the reserved phone numbers will be released and made available for others to purchase.
id	The id of the reservation.
phoneNumbers	A dictionary containing the reservation phone numbers. The key is the ID of the phone number (digits only) and values are AvailablePhoneNumber objects. Not populated when retrieving PhoneNumbersReservation collections.
status	Represents the status of the reservation. Possible values include: 'active', 'submitted', 'completed', 'expired'.

Property Details

expiresAt

The time at which the reservation will expire. If a reservation is not purchased before this time, all of the reserved phone numbers will be released and made available for others to purchase.

expiresAt?: Date

Property Value

Date

id

The id of the reservation.

id?: string

Property Value

string

phoneNumbers

A dictionary containing the reservation phone numbers. The key is the ID of the phone number (digits only) and values are AvailablePhoneNumber objects. Not populated when retrieving PhoneNumbersReservation collections.

phoneNumbers?: {[propertyName: string]: AvailablePhoneNumber | null}

Property Value

{[propertyName: string]: AvailablePhoneNumber | null}

status

Represents the status of the reservation. Possible values include: 'active', 'submitted', 'completed', 'expired'.

status?: ReservationStatus

Property Value

ReservationStatus