@azure/communication-phone-numbers package
Classes
| PhoneNumbersClient |
Client class for interacting with Azure Communication Services Phone Number Administration. |
| SipRoutingClient |
Client class for interacting with Azure Communication Services SIP Routing Administration. |
Interfaces
| AvailablePhoneNumber |
Represents a phone number available in inventory |
| BeginPurchasePhoneNumbersOptions |
Additional options for the purchase phone number operation. |
| BeginReleasePhoneNumberOptions |
Additional options for the release phone number operation. |
| BeginReservationPurchaseOptions |
Additional options that can be passed to the begin purchase reservation request. |
| BeginSearchAvailablePhoneNumbersOptions |
Additional options for the search available phone numbers operation. |
| BeginUpdatePhoneNumberCapabilitiesOptions |
Additional options for the update phone number capabilities operation. |
| BrowseAvailableNumbersOptions |
Additional options for browse available phone numbers request. |
| BrowseAvailableNumbersRequest |
Represents mandatory fields for a phone number browse request. |
| CommunicationError |
The Communication Services error. |
| CreateOrUpdateReservationOptions |
Additional options for updating a phone numbers reservation. |
| CreateOrUpdateReservationRequest |
Required fields for create or update a phone numbers reservation. |
| DeleteReservationOptions |
Additional options for deleting a phone numbers reservation. |
| GetReservationOptions |
Additional options for getting a phone numbers reservation. |
| ListAvailableCountriesOptions |
Additional options that can be passed to the available countries request. |
| ListGeographicAreaCodesOptions |
Additional options that can be passed to the Geographic area codes request. |
| ListLocalitiesOptions |
Additional options that can be passed to the available localities request. |
| ListMobileAreaCodesOptions |
Additional options that can be passed to the Mobile area codes request. |
| ListOfferingsOptions |
Additional options that can be passed to the available offerings request. |
| ListPurchasedPhoneNumbersOptions |
Additional options that can be passed to the list phone numbers request. |
| ListReservationOptions |
Additional options for listing all phone numbers reservations. |
| ListSipRoutesOptions |
Additional options that can be passed to list SIP routes. |
| ListSipTrunksOptions |
Additional options that can be passed to list SIP trunks. |
| ListTollFreeAreaCodesOptions |
Additional options that can be passed to the Toll-Free area codes request. |
| OperatorDetails |
Represents metadata describing the operator of a phone number |
| OperatorInformation |
Represents metadata about a phone number that is controlled/provided by that phone number's operator. |
| OperatorInformationOptions |
Represents options to modify a search request for operator information |
| OperatorInformationResult |
Represents a search result containing format and operator information associated with the requested phone numbers |
| PhoneNumberAdministrativeDivision |
Represents an administrative division. e.g. state or province. |
| PhoneNumberAreaCode |
Represents an Area Code. |
| PhoneNumberCapabilities |
Capabilities of a phone number. |
| PhoneNumberCapabilitiesRequest |
Capabilities of a phone number. |
| PhoneNumberCost |
The incurred cost for a single phone number. |
| PhoneNumberCountry |
Represents a country. |
| PhoneNumberLocality |
Represents a locality. |
| PhoneNumberOffering |
Represents a phone number capability offering |
| PhoneNumberSearchRequest |
Represents a phone number search request to find phone numbers. Found phone numbers are temporarily held for a following purchase. |
| PhoneNumberSearchResult |
The result of a phone number search operation. |
| PhoneNumbersBrowseResult |
The result of a phone number browse operation. |
| PhoneNumbersClientOptions |
Client options used to configure the PhoneNumbersClient API requests. |
| PhoneNumbersListAreaCodesOptionalParams |
Optional parameters. |
| PhoneNumbersPurchaseReservationHeaders |
Defines headers for PhoneNumbers_purchaseReservation operation. |
| PhoneNumbersReservation |
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. |
| PurchasePhoneNumbersResult |
The result of the phone numbers purchase operation. |
| PurchasedPhoneNumber |
Represents a purchased phone number. |
| ReleasePhoneNumberResult |
The result of the phone number release operation. |
| SearchAvailablePhoneNumbersRequest |
Represents a phone number search request to find phone numbers. Found phone numbers are temporarily held for a following purchase. |
| SearchOperatorInformationOptions |
Additional options for the search operator information request. |
| SipRoutingClientOptions |
Client options used to configure the SipRoutingClient API requests. |
| SipRoutingError |
The Communication Services error. |
| SipTrunk |
Represents a SIP trunk for routing calls. See RFC 4904. |
| SipTrunkRoute |
Represents a trunk route for routing calls. |
Type Aliases
| GetPurchasedPhoneNumberOptions |
Additional options for the get phone number request. |
| OperatorNumberType |
Defines values for OperatorNumberType. |
| PhoneNumberAssignmentType |
Defines values for PhoneNumberAssignmentType. |
| PhoneNumberAvailabilityStatus |
Defines values for PhoneNumberAvailabilityStatus. |
| PhoneNumberCapabilityType |
Defines values for PhoneNumberCapabilityType. |
| PhoneNumberSearchResultError |
Defines values for PhoneNumberSearchResultError. |
| PhoneNumberType |
Defines values for PhoneNumberType. |
| PhoneNumbersPurchaseReservationResponse |
Contains response data for the purchaseReservation operation. |
| PurchaseReservationResult |
The result of the purchase reservation operation. |
| ReservationStatus |
Defines values for ReservationStatus. |