PhoneNumberReservation Class

Represents a phone number search.

Inheritance

Model

PhoneNumberReservation

Constructor

PhoneNumberReservation(*, reservation_id: Optional[str] = None, display_name: Optional[str] = None, created_at: Optional[datetime.datetime] = None, description: Optional[str] = None, phone_plan_ids: Optional[List[str]] = None, area_code: Optional[str] = None, quantity: Optional[int] = None, location_options: Optional[List[azure.communication.administration._phonenumber._generated.models._models_py3.LocationOptionsDetails]] = None, status: Optional[Union[str, azure.communication.administration._phonenumber._generated.models._phone_number_administration_service_enums.SearchStatus]] = None, phone_numbers: Optional[List[str]] = None, reservation_expiry_date: Optional[datetime.datetime] = None, error_code: Optional[int] = None, **kwargs)

Parameters

reservation_id

str

Required

The id of the search.

display_name

str

Required

The name of the search.

created_at

datetime

Required

The creation time of the search.

description

str

Required

The description of the search.

phone_plan_ids

list[str]

Required

The phone plan ids of the search.

area_code

str

Required

The area code of the search.

quantity

int

Required

The quantity of phone numbers in the search.

location_options

list[<xref:azure.communication.administration.models.LocationOptionsDetails>]

Required

The location options of the search.

status

str or <xref:azure.communication.administration.models.SearchStatus>

Required

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

phone_numbers

list[str]

Required

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

reservation_expiry_date

datetime

Required

The date that search expires and the numbers become available.

error_code

int

Required

The error code of the search.