PhoneNumberSearchResult Class

The result of a phone number search operation.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

PhoneNumberSearchResult

Constructor

PhoneNumberSearchResult(*, search_id: str, phone_numbers: List[str], phone_number_type: Union[str, azure.communication.phonenumbers._generated.models._phone_numbers_client_enums.PhoneNumberType], assignment_type: Union[str, azure.communication.phonenumbers._generated.models._phone_numbers_client_enums.PhoneNumberAssignmentType], capabilities: azure.communication.phonenumbers._generated.models._models_py3.PhoneNumberCapabilities, cost: azure.communication.phonenumbers._generated.models._models_py3.PhoneNumberCost, search_expires_by: datetime.datetime, **kwargs)

Parameters

search_id

str

Required

Required. The search id.

phone_numbers

list[str]

Required

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

phone_number_type

str or <xref:azure.communication.phonenumbers.models.PhoneNumberType>

Required

Required. The phone number's type, e.g. geographic, or tollFree. Possible values include: "geographic", "tollFree".

assignment_type

str or <xref:azure.communication.phonenumbers.models.PhoneNumberAssignmentType>

Required

Required. Phone number's assignment type. Possible values include: "person", "application".

capabilities

<xref:azure.communication.phonenumbers.models.PhoneNumberCapabilities>

Required

Required. Capabilities of a phone number.

cost

<xref:azure.communication.phonenumbers.models.PhoneNumberCost>

Required

Required. The incurred cost for a single phone number.

search_expires_by

datetime

Required

Required. 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.