@azure/communication-administration package
Classes
| CommunicationIdentityClient |
Client class for interacting with Azure Communication Services User Token Management. |
| PhoneNumberAdministrationClient |
Client class for interacting with Azure Communication Services PhoneNumber Administration. |
Interfaces
| AcquiredPhoneNumber |
Represents an acquired phone number. |
| AcquiredPhoneNumbers |
A wrapper of list of phone numbers |
| AreaCodes |
Represents a list of area codes. |
| BeginPurchaseReservationOptions |
Additional request options for requesting the purchase of a phone number reservation. |
| BeginReleasePhoneNumbersOptions |
Additional request options for requesting the release of a list of phone numbers. |
| BeginReservePhoneNumbersOptions |
Additional request options for requesting the reservation of phone numbers. |
| CarrierDetails |
Represents carrier details. |
| CommunicationIdentityOptions |
Client options used to configure the CommunicationIdentity API requests. |
| CommunicationIdentityToken | |
| CommunicationTokenRequest | |
| CommunicationUserToken |
The issued token and the user it was issued for. |
| ConfigurePhoneNumberOptions |
Options for configuring a phone number. |
| ConfigurePhoneNumberRequest |
A request for configuring a phone number. |
| CreateReservationOptions |
Options for creating a search. |
| CreateReservationRequest |
Request to create phone number reservations. |
| CreateReservationResponse | |
| GetAreaCodesRequest |
Request to get available area codes. |
| GetPhonePlanLocationOptionsRequest |
Base options to pass a locale and pagination parameters in the same request. |
| ListPhonePlanGroupsOptions |
Options for querying plan groups by country. |
| ListPhonePlansRequest | |
| LocalizationOptions |
Base options to pass a locale that is used for localizing strings in the responses. |
| LocationOptions |
Represents a location options. |
| LocationOptionsDetails |
Represents location options details. |
| LocationOptionsQueries |
Represents a list of location option queries, used for fetching area codes. |
| LocationOptionsQuery |
Represents a location options parameter, used for fetching area codes. |
| LocationOptionsResponse |
Represents a wrapper around a list of location options. |
| NumberConfiguration |
Definition for number configuration |
| NumberConfigurationResponse |
Definition for number configuration |
| NumberUpdateCapabilities |
Represents an individual number capabilities update request |
| PageableLocalizationOptions |
Base options to pass a locale and pagination parameters in the same request. |
| PageableOptions |
Base options to pass pagination parameters. |
| PhoneNumberAdministrationClientOptions |
Client options used to configure the UserTokenClient API requests. |
| PhoneNumberCountries |
Represents a wrapper around a list of countries. |
| PhoneNumberCountry |
Represents a country. |
| PhoneNumberEntities |
Represents a list of searches or releases, as part of the response when fetching all searches or releases. |
| PhoneNumberEntity |
Represents a phone number entity, as part of the response when calling get all searches or releases. |
| PhoneNumberPollerOptionsBase |
Represents the optional parameters that can be passed to phone number pollers. |
| PhoneNumberRelease |
Represents a release |
| PhoneNumberReleaseDetails | |
| PhoneNumberReservation |
Represents a phone number search |
| PhonePlan |
Represents a phone plan. |
| PhonePlanGroup |
Represents a plan group. |
| PhonePlanGroups |
Represents a wrapper of list of plan groups. |
| PhonePlansResponse |
Represents a wrapper around a list of countries. |
| PstnConfiguration |
Definition for pstn number configuration |
| RateInformation |
Represents a wrapper of rate information |
| ReleaseResponse |
Represents a release response. |
| UpdateCapabilitiesOptions |
Additional options for updating phone numbers capabilities. |
| UpdateNumberCapabilitiesResponse |
Represents a number capability update response. |
| UpdatePhoneNumberCapabilitiesResponse |
Response for getting a phone number update capabilities. |
Type Aliases
| ActivationState |
Defines values for ActivationState. |
| AssignmentStatus |
Defines values for AssignmentStatus. |
| CancelReservationOptions |
Additional request option for the cancel phone number reservation operation. |
| CapabilitiesUpdateStatus |
Defines values for CapabilitiesUpdateStatus. |
| Capability |
Defines values for Capability. |
| CreatePhoneNumberReservationResponse |
Represents the response from starting a search for phone numbers. |
| CreateUserResponse |
Represents the response from creating a user |
| GetAreaCodesOptions |
Options for querying available area codes. |
| GetAreaCodesResponse |
Represents the response from getting a list of the supported area codes. |
| GetCapabilitiesUpdateOptions |
Additional request options for getting the update capabilities request. |
| GetCapabilitiesUpdateResponse |
Represents the response from getting the update capabilities request associated with a given id. |
| GetPhoneNumberConfigurationOptions |
Additional request options for getting the configuration of a phone number. |
| GetPhoneNumberConfigurationResponse |
Represents the response from getting the configuration for a given number. |
| GetPhonePlanLocationOptionsOptions |
Options for getting a plan location options |
| GetPhonePlanLocationOptionsResponse |
Represents the response from getting the location options for a given phone plan. |
| GetReleaseOptions |
Additional request options for getting a release. |
| GetReleaseResponse |
Represents the response from getting the release associated with a given id. |
| GetReservationOptions |
Additional request option for the get phone number reservation operation. |
| GetReservationResponse |
Represents the response from getting the search associated with a given id. |
| IssueTokenResponse |
Represents the response from issuing a token |
| ListPhoneNumbersOptions |
Options for listing acquired phone numbers. |
| ListPhonePlansOptions |
Options for listing phone plans. |
| ListSupportedCountriesOptions |
Options for querying supported countries. |
| LocationType |
Defines values for LocationType. |
| PhoneNumberAdministrationGetAllAreaCodesResponse |
Contains response data for the getAllAreaCodes operation. |
| PhoneNumberAdministrationGetCapabilitiesUpdateResponse |
Contains response data for the getCapabilitiesUpdate operation. |
| PhoneNumberAdministrationGetNumberConfigurationResponse |
Contains response data for the getNumberConfiguration operation. |
| PhoneNumberAdministrationGetPhonePlanLocationOptionsResponse |
Contains response data for the getPhonePlanLocationOptions operation. |
| PhoneNumberAdministrationGetReleaseByIdResponse |
Contains response data for the getReleaseById operation. |
| PhoneNumberAdministrationReleasePhoneNumbersResponse |
Contains response data for the releasePhoneNumbers operation. |
| PhoneNumberCapabilitiesUpdates |
The capabilities update for each of a set of phone numbers. |
| PhoneNumberReleaseStatus |
Defines values for PhoneNumberReleaseStatus. |
| PhoneNumberType |
Defines values for PhoneNumberType. |
| PurchaseReservationOptions |
Additional request option for the purchase reservation operation. |
| ReleasePhoneNumbersOptions |
Additional request options for requesting the release of a list of phone numbers. |
| ReleasePhoneNumbersResponse |
Represents the response from requesting the release of a list of acquired phone numbers. |
| ReleaseStatus |
Defines values for ReleaseStatus. |
| SearchStatus |
Defines values for SearchStatus. |
| TokenScope |
Represents the scope of the token. |
| UnconfigurePhoneNumberOptions |
Additional request options for unconfiguring a phone number. |
| UpdateNumbersCapabilitiesResponse |
Represents the response from updating the capabilities for a list of phone numbers. |
| VoidResponse |
Represents a generic HTTP response |
| WithResponse |
Represents an object with a non-enumerable _response property which provides information about the HTTP response. |