PhoneNumberAdministration | @azure/communication-administration

Class representing a PhoneNumberAdministration.

Hierarchy

PhoneNumberAdministration

Constructors

constructor

new PhoneNumberAdministration(client: PhoneNumberRestClientContext): PhoneNumberAdministration

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:19
Create a PhoneNumberAdministration.

Parameters
- client: PhoneNumberRestClientContext
  
  Reference to the service client.
Returns PhoneNumberAdministration

Methods

cancelSearch

cancelSearch(searchId: string, options?: coreHttp.RequestOptionsBase): Promise<coreHttp.RestResponse>
cancelSearch(searchId: string, callback: coreHttp.ServiceCallback<void>): void
cancelSearch(searchId: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<void>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:822
summary

Cancels the search. This means existing numbers in the search will be made available.

Parameters
- searchId: string
  
  The search id to be canceled
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<coreHttp.RestResponse>

Promise<coreHttp.RestResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:830
Parameters
- searchId: string
  
  The search id to be canceled
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:836
Parameters
- searchId: string
  
  The search id to be canceled
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

configureNumber

configureNumber(pstnConfiguration: PstnConfiguration, phoneNumber: string, options?: coreHttp.RequestOptionsBase): Promise<coreHttp.RestResponse>
configureNumber(pstnConfiguration: PstnConfiguration, phoneNumber: string, callback: coreHttp.ServiceCallback<void>): void
configureNumber(pstnConfiguration: PstnConfiguration, phoneNumber: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<void>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:305
summary

Endpoint for configuring a pstn number

Parameters
- pstnConfiguration: PstnConfiguration
- phoneNumber: string
  
  The phone number to configure
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<coreHttp.RestResponse>

Promise<coreHttp.RestResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:315
Parameters
- pstnConfiguration: PstnConfiguration
- phoneNumber: string
  
  The phone number to configure
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:326
Parameters
- pstnConfiguration: PstnConfiguration
- phoneNumber: string
  
  The phone number to configure
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

createSearch

createSearch(displayName: string, description: string, phonePlanIds: string[], areaCode: string, options?: Models.PhoneNumberAdministrationCreateSearchOptionalParams): Promise<Models.PhoneNumberAdministrationCreateSearchResponse>
createSearch(displayName: string, description: string, phonePlanIds: string[], areaCode: string, callback: coreHttp.ServiceCallback<CreateSearchResponse>): void
createSearch(displayName: string, description: string, phonePlanIds: string[], areaCode: string, options: PhoneNumberAdministrationCreateSearchOptionalParams, callback: coreHttp.ServiceCallback<CreateSearchResponse>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:721
summary

Creates a phone number search

Parameters
- displayName: string
  
  Display name of the search.
- description: string
  
  Description of the search.
- phonePlanIds: string[]
  
  The plan subtype ids from which to create the search.
- areaCode: string
  
  The area code from which to create the search.
- Optional options: Models.PhoneNumberAdministrationCreateSearchOptionalParams
Returns Promise<Models.PhoneNumberAdministrationCreateSearchResponse>

Promise<Models.PhoneNumberAdministrationCreateSearchResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:735
Parameters
- displayName: string
  
  Display name of the search.
- description: string
  
  Description of the search.
- phonePlanIds: string[]
  
  The plan subtype ids from which to create the search.
- areaCode: string
  
  The area code from which to create the search.
- callback: coreHttp.ServiceCallback<CreateSearchResponse>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:750
Parameters
- displayName: string
  
  Display name of the search.
- description: string
  
  Description of the search.
- phonePlanIds: string[]
  
  The plan subtype ids from which to create the search.
- areaCode: string
  
  The area code from which to create the search.
- options: PhoneNumberAdministrationCreateSearchOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<CreateSearchResponse>
  
  The callback
Returns void

getAllAreaCodes

getAllAreaCodes(locationType: string, countryCode: string, phonePlanId: string, options?: Models.PhoneNumberAdministrationGetAllAreaCodesOptionalParams): Promise<Models.PhoneNumberAdministrationGetAllAreaCodesResponse>
getAllAreaCodes(locationType: string, countryCode: string, phonePlanId: string, callback: coreHttp.ServiceCallback<AreaCodes>): void
getAllAreaCodes(locationType: string, countryCode: string, phonePlanId: string, options: PhoneNumberAdministrationGetAllAreaCodesOptionalParams, callback: coreHttp.ServiceCallback<AreaCodes>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:72
summary

Gets a list of the supported area codes

Parameters
- locationType: string
  
  The type of location information required by the plan.
- countryCode: string
  
  The ISO 3166-2 country code
- phonePlanId: string
  
  The plan id from which to search area codes.
- Optional options: Models.PhoneNumberAdministrationGetAllAreaCodesOptionalParams
Returns Promise<Models.PhoneNumberAdministrationGetAllAreaCodesResponse>

Promise<Models.PhoneNumberAdministrationGetAllAreaCodesResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:84
Parameters
- locationType: string
  
  The type of location information required by the plan.
- countryCode: string
  
  The ISO 3166-2 country code
- phonePlanId: string
  
  The plan id from which to search area codes.
- callback: coreHttp.ServiceCallback<AreaCodes>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:97
Parameters
- locationType: string
  
  The type of location information required by the plan.
- countryCode: string
  
  The ISO 3166-2 country code
- phonePlanId: string
  
  The plan id from which to search area codes.
- options: PhoneNumberAdministrationGetAllAreaCodesOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<AreaCodes>
  
  The callback
Returns void

getAllPhoneNumbers

getAllPhoneNumbers(options?: Models.PhoneNumberAdministrationGetAllPhoneNumbersOptionalParams): Promise<Models.PhoneNumberAdministrationGetAllPhoneNumbersResponse>
getAllPhoneNumbers(callback: coreHttp.ServiceCallback<AcquiredPhoneNumbers>): void
getAllPhoneNumbers(options: PhoneNumberAdministrationGetAllPhoneNumbersOptionalParams, callback: coreHttp.ServiceCallback<AcquiredPhoneNumbers>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:34
summary

Gets the list of the acquired phone numbers.

Parameters
- Optional options: Models.PhoneNumberAdministrationGetAllPhoneNumbersOptionalParams
Returns Promise<Models.PhoneNumberAdministrationGetAllPhoneNumbersResponse>

Promise<Models.PhoneNumberAdministrationGetAllPhoneNumbersResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:40
Parameters
- callback: coreHttp.ServiceCallback<AcquiredPhoneNumbers>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:45
Parameters
- options: PhoneNumberAdministrationGetAllPhoneNumbersOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<AcquiredPhoneNumbers>
  
  The callback
Returns void

getAllReleases

getAllReleases(options?: Models.PhoneNumberAdministrationGetAllReleasesOptionalParams): Promise<Models.PhoneNumberAdministrationGetAllReleasesResponse>
getAllReleases(callback: coreHttp.ServiceCallback<PhoneNumberEntities>): void
getAllReleases(options: PhoneNumberAdministrationGetAllReleasesOptionalParams, callback: coreHttp.ServiceCallback<PhoneNumberEntities>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:639
summary

Gets a list of all releases

Parameters
- Optional options: Models.PhoneNumberAdministrationGetAllReleasesOptionalParams
Returns Promise<Models.PhoneNumberAdministrationGetAllReleasesResponse>

Promise<Models.PhoneNumberAdministrationGetAllReleasesResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:645
Parameters
- callback: coreHttp.ServiceCallback<PhoneNumberEntities>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:650
Parameters
- options: PhoneNumberAdministrationGetAllReleasesOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<PhoneNumberEntities>
  
  The callback
Returns void

getAllSearches

getAllSearches(options?: Models.PhoneNumberAdministrationGetAllSearchesOptionalParams): Promise<Models.PhoneNumberAdministrationGetAllSearchesResponse>
getAllSearches(callback: coreHttp.ServiceCallback<PhoneNumberEntities>): void
getAllSearches(options: PhoneNumberAdministrationGetAllSearchesOptionalParams, callback: coreHttp.ServiceCallback<PhoneNumberEntities>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:786
summary

Gets a list of all searches

Parameters
- Optional options: Models.PhoneNumberAdministrationGetAllSearchesOptionalParams
Returns Promise<Models.PhoneNumberAdministrationGetAllSearchesResponse>

Promise<Models.PhoneNumberAdministrationGetAllSearchesResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:792
Parameters
- callback: coreHttp.ServiceCallback<PhoneNumberEntities>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:797
Parameters
- options: PhoneNumberAdministrationGetAllSearchesOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<PhoneNumberEntities>
  
  The callback
Returns void

getAllSupportedCountries

getAllSupportedCountries(options?: Models.PhoneNumberAdministrationGetAllSupportedCountriesOptionalParams): Promise<Models.PhoneNumberAdministrationGetAllSupportedCountriesResponse>
getAllSupportedCountries(callback: coreHttp.ServiceCallback<PhoneNumberCountries>): void
getAllSupportedCountries(options: PhoneNumberAdministrationGetAllSupportedCountriesOptionalParams, callback: coreHttp.ServiceCallback<PhoneNumberCountries>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:223
summary

Gets a list of supported countries

Parameters
- Optional options: Models.PhoneNumberAdministrationGetAllSupportedCountriesOptionalParams
Returns Promise<Models.PhoneNumberAdministrationGetAllSupportedCountriesResponse>

Promise<Models.PhoneNumberAdministrationGetAllSupportedCountriesResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:229
Parameters
- callback: coreHttp.ServiceCallback<PhoneNumberCountries>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:234
Parameters
- options: PhoneNumberAdministrationGetAllSupportedCountriesOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<PhoneNumberCountries>
  
  The callback
Returns void

getCapabilitiesUpdate

getCapabilitiesUpdate(capabilitiesUpdateId: string, options?: coreHttp.RequestOptionsBase): Promise<Models.PhoneNumberAdministrationGetCapabilitiesUpdateResponse>
getCapabilitiesUpdate(capabilitiesUpdateId: string, callback: coreHttp.ServiceCallback<UpdatePhoneNumberCapabilitiesResponse>): void
getCapabilitiesUpdate(capabilitiesUpdateId: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<UpdatePhoneNumberCapabilitiesResponse>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:131
summary

Get capabilities by capabilities update id.

Parameters
- capabilitiesUpdateId: string
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.PhoneNumberAdministrationGetCapabilitiesUpdateResponse>

Promise<Models.PhoneNumberAdministrationGetCapabilitiesUpdateResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:139
Parameters
- capabilitiesUpdateId: string
- callback: coreHttp.ServiceCallback<UpdatePhoneNumberCapabilitiesResponse>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:148
Parameters
- capabilitiesUpdateId: string
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<UpdatePhoneNumberCapabilitiesResponse>
  
  The callback
Returns void

getNumberConfiguration

getNumberConfiguration(phoneNumber: string, options?: coreHttp.RequestOptionsBase): Promise<Models.PhoneNumberAdministrationGetNumberConfigurationResponse>
getNumberConfiguration(phoneNumber: string, callback: coreHttp.ServiceCallback<NumberConfigurationResponse>): void
getNumberConfiguration(phoneNumber: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<NumberConfigurationResponse>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:259
summary

Endpoint for getting number configurations

Parameters
- phoneNumber: string
  
  The phone number in the E.164 format
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.PhoneNumberAdministrationGetNumberConfigurationResponse>

Promise<Models.PhoneNumberAdministrationGetNumberConfigurationResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:267
Parameters
- phoneNumber: string
  
  The phone number in the E.164 format
- callback: coreHttp.ServiceCallback<NumberConfigurationResponse>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:276
Parameters
- phoneNumber: string
  
  The phone number in the E.164 format
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<NumberConfigurationResponse>
  
  The callback
Returns void

getPhonePlanGroups

getPhonePlanGroups(countryCode: string, options?: Models.PhoneNumberAdministrationGetPhonePlanGroupsOptionalParams): Promise<Models.PhoneNumberAdministrationGetPhonePlanGroupsResponse>
getPhonePlanGroups(countryCode: string, callback: coreHttp.ServiceCallback<PhonePlanGroups>): void
getPhonePlanGroups(countryCode: string, options: PhoneNumberAdministrationGetPhonePlanGroupsOptionalParams, callback: coreHttp.ServiceCallback<PhonePlanGroups>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:395
summary

Gets a list of phone plan groups for the given country

Parameters
- countryCode: string
  
  The ISO 3166-2 country code.
- Optional options: Models.PhoneNumberAdministrationGetPhonePlanGroupsOptionalParams
Returns Promise<Models.PhoneNumberAdministrationGetPhonePlanGroupsResponse>

Promise<Models.PhoneNumberAdministrationGetPhonePlanGroupsResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:403
Parameters
- countryCode: string
  
  The ISO 3166-2 country code.
- callback: coreHttp.ServiceCallback<PhonePlanGroups>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:412
Parameters
- countryCode: string
  
  The ISO 3166-2 country code.
- options: PhoneNumberAdministrationGetPhonePlanGroupsOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<PhonePlanGroups>
  
  The callback
Returns void

getPhonePlanLocationOptions

getPhonePlanLocationOptions(countryCode: string, phonePlanGroupId: string, phonePlanId: string, options?: Models.PhoneNumberAdministrationGetPhonePlanLocationOptionsOptionalParams): Promise<Models.PhoneNumberAdministrationGetPhonePlanLocationOptionsResponse>
getPhonePlanLocationOptions(countryCode: string, phonePlanGroupId: string, phonePlanId: string, callback: coreHttp.ServiceCallback<LocationOptionsResponse>): void
getPhonePlanLocationOptions(countryCode: string, phonePlanGroupId: string, phonePlanId: string, options: PhoneNumberAdministrationGetPhonePlanLocationOptionsOptionalParams, callback: coreHttp.ServiceCallback<LocationOptionsResponse>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:495
summary

Gets a list of location options for a phone plan

Parameters
- countryCode: string
  
  The ISO 3166-2 country code.
- phonePlanGroupId: string
- phonePlanId: string
- Optional options: Models.PhoneNumberAdministrationGetPhonePlanLocationOptionsOptionalParams
Returns Promise<Models.PhoneNumberAdministrationGetPhonePlanLocationOptionsResponse>

Promise<Models.PhoneNumberAdministrationGetPhonePlanLocationOptionsResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:507
Parameters
- countryCode: string
  
  The ISO 3166-2 country code.
- phonePlanGroupId: string
- phonePlanId: string
- callback: coreHttp.ServiceCallback<LocationOptionsResponse>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:520
Parameters
- countryCode: string
  
  The ISO 3166-2 country code.
- phonePlanGroupId: string
- phonePlanId: string
- options: PhoneNumberAdministrationGetPhonePlanLocationOptionsOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<LocationOptionsResponse>
  
  The callback
Returns void

getPhonePlans

getPhonePlans(countryCode: string, phonePlanGroupId: string, options?: Models.PhoneNumberAdministrationGetPhonePlansOptionalParams): Promise<Models.PhoneNumberAdministrationGetPhonePlansResponse>
getPhonePlans(countryCode: string, phonePlanGroupId: string, callback: coreHttp.ServiceCallback<PhonePlansResponse>): void
getPhonePlans(countryCode: string, phonePlanGroupId: string, options: PhoneNumberAdministrationGetPhonePlansOptionalParams, callback: coreHttp.ServiceCallback<PhonePlansResponse>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:441
summary

Gets a list of phone plans for a phone plan group

Parameters
- countryCode: string
  
  The ISO 3166-2 country code.
- phonePlanGroupId: string
- Optional options: Models.PhoneNumberAdministrationGetPhonePlansOptionalParams
Returns Promise<Models.PhoneNumberAdministrationGetPhonePlansResponse>

Promise<Models.PhoneNumberAdministrationGetPhonePlansResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:451
Parameters
- countryCode: string
  
  The ISO 3166-2 country code.
- phonePlanGroupId: string
- callback: coreHttp.ServiceCallback<PhonePlansResponse>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:462
Parameters
- countryCode: string
  
  The ISO 3166-2 country code.
- phonePlanGroupId: string
- options: PhoneNumberAdministrationGetPhonePlansOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<PhonePlansResponse>
  
  The callback
Returns void

getReleaseById

getReleaseById(releaseId: string, options?: coreHttp.RequestOptionsBase): Promise<Models.PhoneNumberAdministrationGetReleaseByIdResponse>
getReleaseById(releaseId: string, callback: coreHttp.ServiceCallback<PhoneNumberRelease>): void
getReleaseById(releaseId: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<PhoneNumberRelease>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:554
summary

Gets a release by a release id

Parameters
- releaseId: string
  
  Represents the release id
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.PhoneNumberAdministrationGetReleaseByIdResponse>

Promise<Models.PhoneNumberAdministrationGetReleaseByIdResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:562
Parameters
- releaseId: string
  
  Represents the release id
- callback: coreHttp.ServiceCallback<PhoneNumberRelease>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:571
Parameters
- releaseId: string
  
  Represents the release id
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<PhoneNumberRelease>
  
  The callback
Returns void

getSearchById

getSearchById(searchId: string, options?: coreHttp.RequestOptionsBase): Promise<Models.PhoneNumberAdministrationGetSearchByIdResponse>
getSearchById(searchId: string, callback: coreHttp.ServiceCallback<PhoneNumberSearch>): void
getSearchById(searchId: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<PhoneNumberSearch>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:675
summary

Get search by search id

Parameters
- searchId: string
  
  The search id to be searched for
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.PhoneNumberAdministrationGetSearchByIdResponse>

Promise<Models.PhoneNumberAdministrationGetSearchByIdResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:683
Parameters
- searchId: string
  
  The search id to be searched for
- callback: coreHttp.ServiceCallback<PhoneNumberSearch>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:692
Parameters
- searchId: string
  
  The search id to be searched for
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<PhoneNumberSearch>
  
  The callback
Returns void

purchaseSearch

purchaseSearch(searchId: string, options?: coreHttp.RequestOptionsBase): Promise<coreHttp.RestResponse>
purchaseSearch(searchId: string, callback: coreHttp.ServiceCallback<void>): void
purchaseSearch(searchId: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<void>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:862
summary

Purchases the phone number search.

Parameters
- searchId: string
  
  The search id to be purchased
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<coreHttp.RestResponse>

Promise<coreHttp.RestResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:870
Parameters
- searchId: string
  
  The search id to be purchased
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:876
Parameters
- searchId: string
  
  The search id to be purchased
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

releasePhoneNumbers

releasePhoneNumbers(phoneNumbers: string[], options?: coreHttp.RequestOptionsBase): Promise<Models.PhoneNumberAdministrationReleasePhoneNumbersResponse>
releasePhoneNumbers(phoneNumbers: string[], callback: coreHttp.ServiceCallback<ReleaseResponse>): void
releasePhoneNumbers(phoneNumbers: string[], options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<ReleaseResponse>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:597
summary

Creates a release for the given phone numbers

Parameters
- phoneNumbers: string[]
  
  The list of phone numbers in the release request.
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.PhoneNumberAdministrationReleasePhoneNumbersResponse>

Promise<Models.PhoneNumberAdministrationReleasePhoneNumbersResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:605
Parameters
- phoneNumbers: string[]
  
  The list of phone numbers in the release request.
- callback: coreHttp.ServiceCallback<ReleaseResponse>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:614
Parameters
- phoneNumbers: string[]
  
  The list of phone numbers in the release request.
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<ReleaseResponse>
  
  The callback
Returns void

unconfigureNumber

unconfigureNumber(phoneNumber: string, options?: coreHttp.RequestOptionsBase): Promise<coreHttp.RestResponse>
unconfigureNumber(phoneNumber: string, callback: coreHttp.ServiceCallback<void>): void
unconfigureNumber(phoneNumber: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<void>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:355
summary

Endpoint for unconfiguring a pstn number by removing the configuration

Parameters
- phoneNumber: string
  
  The phone number in the E.164 format
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<coreHttp.RestResponse>

Promise<coreHttp.RestResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:363
Parameters
- phoneNumber: string
  
  The phone number in the E.164 format
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:369
Parameters
- phoneNumber: string
  
  The phone number in the E.164 format
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

updateCapabilities

updateCapabilities(phoneNumberCapabilitiesUpdate: {}, options?: coreHttp.RequestOptionsBase): Promise<Models.PhoneNumberAdministrationUpdateCapabilitiesResponse>
updateCapabilities(phoneNumberCapabilitiesUpdate: {}, callback: coreHttp.ServiceCallback<UpdateNumberCapabilitiesResponse>): void
updateCapabilities(phoneNumberCapabilitiesUpdate: {}, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<UpdateNumberCapabilitiesResponse>): void

- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:177
summary

Adds or removes phone number capabilities

Parameters
- phoneNumberCapabilitiesUpdate: {}
  
  The map of phone numbers to the capabilities update applied to the phone number.
  - [propertyName: string]: NumberUpdateCapabilities
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.PhoneNumberAdministrationUpdateCapabilitiesResponse>

Promise<Models.PhoneNumberAdministrationUpdateCapabilitiesResponse>
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:186
Parameters
- phoneNumberCapabilitiesUpdate: {}
  
  The map of phone numbers to the capabilities update applied to the phone number.
  - [propertyName: string]: NumberUpdateCapabilities
- callback: coreHttp.ServiceCallback<UpdateNumberCapabilitiesResponse>
  
  The callback
Returns void
- Defined in phoneNumber/generated/src/operations/phoneNumberAdministration.ts:196
Parameters
- phoneNumberCapabilitiesUpdate: {}
  
  The map of phone numbers to the capabilities update applied to the phone number.
  - [propertyName: string]: NumberUpdateCapabilities
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<UpdateNumberCapabilitiesResponse>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: PhoneNumberRestClientContext

Returns PhoneNumberAdministration

Methods

cancelSearch

Parameters

searchId: string

Optional options: coreHttp.RequestOptionsBase

Returns Promise<coreHttp.RestResponse>

Parameters

searchId: string

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

searchId: string

options: coreHttp.RequestOptionsBase

callback: coreHttp.ServiceCallback<void>

Returns void

configureNumber

Parameters

pstnConfiguration: PstnConfiguration

phoneNumber: string

Optional options: coreHttp.RequestOptionsBase

Returns Promise<coreHttp.RestResponse>

Parameters

pstnConfiguration: PstnConfiguration

phoneNumber: string

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

pstnConfiguration: PstnConfiguration

phoneNumber: string

options: coreHttp.RequestOptionsBase

callback: coreHttp.ServiceCallback<void>

Returns void

createSearch

Parameters

displayName: string

description: string

phonePlanIds: string[]

areaCode: string

Optional options: Models.PhoneNumberAdministrationCreateSearchOptionalParams

Returns Promise<Models.PhoneNumberAdministrationCreateSearchResponse>

Parameters

displayName: string

description: string

phonePlanIds: string[]

areaCode: string

callback: coreHttp.ServiceCallback<CreateSearchResponse>

Returns void

Parameters

displayName: string

description: string

phonePlanIds: string[]

areaCode: string

options: PhoneNumberAdministrationCreateSearchOptionalParams

callback: coreHttp.ServiceCallback<CreateSearchResponse>

Returns void

getAllAreaCodes

Parameters

locationType: string

countryCode: string

phonePlanId: string

Optional options: Models.PhoneNumberAdministrationGetAllAreaCodesOptionalParams

Returns Promise<Models.PhoneNumberAdministrationGetAllAreaCodesResponse>

Parameters

locationType: string

countryCode: string

phonePlanId: string

callback: coreHttp.ServiceCallback<AreaCodes>

Returns void

Parameters

locationType: string

countryCode: string