PhoneNumberAdministrationClient class

Clientklasse voor interactie met Azure Communication Services PhoneNumber Administration.

Constructors

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

Initialiseert een nieuw exemplaar van de klasse PhoneNumberAdministrationClient met behulp van een Azure KeyCredential.

PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

Hiermee wordt een nieuw exemplaar van de klasse PhoneNumberAdministrationClient geïnitialiseerd.

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

Initialiseert een nieuw exemplaar van de klasse PhoneNumberAdministrationClient met behulp van een TokenCredential.

Methoden

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

Start de aankoop van het (de) telefoonnummer(s) in de reservering die aan een bepaalde ID is gekoppeld.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de bewerking is voltooid.

Voorbeeldgebruik:

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const purchasePoller = await client.beginPurchaseReservation(RESERVATION_ID);

// Serializing the poller
const serialized = purchasePoller.toString();

// Waiting until it's done
const results = await purchasePoller.pollUntilDone();
console.log(results);
beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

Start de vrijgave van een lijst met verkregen telefoonnummers.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de bewerking is voltooid.

Voorbeeldgebruik:

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const releasePoller = await client.beginReleasePhoneNumbers(PHONE_NUMBERS);

// Serializing the poller
const serialized = releasePoller.toString();

// Waiting until it's done
const results = await releasePoller.pollUntilDone();
console.log(results);
beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

Hiermee start u een zoekopdracht naar telefoonnummers op basis van bepaalde beperkingen, zoals naam of netnummer. De gevonden telefoonnummers zijn gereserveerd totdat u de reservering annuleert, aanschaft of verloopt.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de bewerking is voltooid.

Voorbeeldgebruik:

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const reservePoller = await client.beginReservePhoneNumbers(RESERVATION_REQUEST);

// Serializing the poller
const serialized = reservePoller.toString();

// Waiting until it's done
const results = await reservePoller.pollUntilDone();
console.log(results);
cancelReservation(string, OperationOptions)

Annuleert de reservering die is gekoppeld aan een bepaalde id.

configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

Configureert een telefoonnummer, bijvoorbeeld om een callbackUrl toe te wijzen.

getAreaCodes(GetAreaCodesRequest, OperationOptions)

Krijgt een lijst met de ondersteunde netnummers op basis van locatie.

getCapabilitiesUpdate(string, OperationOptions)

Haal de aanvraag voor updatemogelijkheden op die is gekoppeld aan een bepaalde id.

getPhoneNumberConfiguration(string, OperationOptions)

Hiermee haalt u de configuratie voor een bepaald telefoonnummer op.

getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

Hiermee haalt u de locatieopties voor een bepaald telefoonabonnement op.

getReservation(string, OperationOptions)

Hiermee haalt u de reservering op die aan een bepaalde id is gekoppeld. Gebruik deze functie om de status van een telefoonnummerreservering op te vragen.

listPhoneNumbers(PageableLocalizationOptions)

Itereert de verkregen telefoonnummers.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const acquired of client.listPhoneNumbers()) {
  console.log("phone number: ", acquired.phoneNumber);
}
listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

Itereert de beschikbare telefoonabonnementsgroepen voor een land.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const phonePlanGroup of client.listPhonePlanGroups("CA")) {
  console.log("plan group id: ", phonePlanGroup.phonePlanGroupId);
}
listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

Itereert het beschikbare telefoonabonnement voor een abonnementsgroep.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const phonePlan of client.listPhonePlanGroups(PLAN_GROUP_INFO)) {
  console.log("plan id: ", phonePlan.phonePlanId);
}

Gets all available phone plans for a given plan group.
@param planGroupInfo Information need to search for plans.
@param options Additional request options.
listReleases(PageableOptions)

Itereert de releases die zijn gemaakt door de Azure-resource.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const entity of client.listReleases()) {
  console.log("id: ", entity.id);
}

Hiermee haalt u alle releases op die zijn gemaakt door de Azure-resource.

listSearches(PageableOptions)

Itereert de zoekopdrachten die zijn gemaakt door de Azure-resource.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const entity of client.listSearches()) {
  console.log("id: ", entity.id);
}

Hiermee worden alle zoekopdrachten opgehaald die zijn gemaakt door de Azure-resource.

listSupportedCountries(PageableLocalizationOptions)

Itereert de ondersteunde landen.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const country of client.listSupportedCountries()) {
  console.log("country name: ", country.localizedName);
}
unconfigurePhoneNumber(string, OperationOptions)

Deconfigureer een telefoonnummer en reset de configuratie.

updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

Hiermee worden de mogelijkheden voor een lijst met telefoonnummers bijgewerkt. Het antwoord bevat de id van de gemaakte aanvraag voor updatemogelijkheden, onthoud die id voor volgende aanroepen naar getCapabilitiesUpdate.

Constructordetails

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

Initialiseert een nieuw exemplaar van de klasse PhoneNumberAdministrationClient met behulp van een Azure KeyCredential.

new PhoneNumberAdministrationClient(url: string, credential: KeyCredential, options?: PhoneNumberAdministrationClientOptions)

Parameters

url

string

Het eindpunt van de service (bijvoorbeeld: https://contoso.eastus.communications.azure.net).

credential
KeyCredential

Een object dat wordt gebruikt voor het verifiëren van aanvragen voor de service. Gebruik Azure KeyCredential of @azure/identity om een referentie te maken.

options
PhoneNumberAdministrationClientOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

Hiermee wordt een nieuw exemplaar van de klasse PhoneNumberAdministrationClient geïnitialiseerd.

new PhoneNumberAdministrationClient(connectionString: string, options?: PhoneNumberAdministrationClientOptions)

Parameters

connectionString

string

Verbindingsreeks om verbinding te maken met een Azure Communication Service-resource. Voorbeeld: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options
PhoneNumberAdministrationClientOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

Initialiseert een nieuw exemplaar van de klasse PhoneNumberAdministrationClient met behulp van een TokenCredential.

new PhoneNumberAdministrationClient(url: string, credential: TokenCredential, options?: PhoneNumberAdministrationClientOptions)

Parameters

url

string

Het eindpunt van de service (bijvoorbeeld: https://contoso.eastus.communications.azure.net).

credential
TokenCredential

TokenCredential die wordt gebruikt voor het verifiëren van aanvragen voor de service.

options
PhoneNumberAdministrationClientOptions

Facultatief. Opties voor het configureren van de HTTP-pijplijn.

Methodedetails

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

Start de aankoop van het (de) telefoonnummer(s) in de reservering die aan een bepaalde ID is gekoppeld.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de bewerking is voltooid.

Voorbeeldgebruik:

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const purchasePoller = await client.beginPurchaseReservation(RESERVATION_ID);

// Serializing the poller
const serialized = purchasePoller.toString();

// Waiting until it's done
const results = await purchasePoller.pollUntilDone();
console.log(results);
function beginPurchaseReservation(reservationId: string, options?: BeginPurchaseReservationOptions): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

reservationId

string

Het identiteitsbewijs van de te kopen reservering.

options
BeginPurchaseReservationOptions

Aanvullende aanvraagopties.

Retouren

Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>

beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

Start de vrijgave van een lijst met verkregen telefoonnummers.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de bewerking is voltooid.

Voorbeeldgebruik:

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const releasePoller = await client.beginReleasePhoneNumbers(PHONE_NUMBERS);

// Serializing the poller
const serialized = releasePoller.toString();

// Waiting until it's done
const results = await releasePoller.pollUntilDone();
console.log(results);
function beginReleasePhoneNumbers(phoneNumbers: string[], options?: BeginReleasePhoneNumbersOptions): Promise<PollerLike<PollOperationState<PhoneNumberRelease>, PhoneNumberRelease>>

Parameters

phoneNumbers

string[]

De telefoonnummers die moeten worden vrijgegeven.

options
BeginReleasePhoneNumbersOptions

Aanvullende aanvraagopties.

Retouren

Promise<PollerLike<@azure/core-lro.PollOperationState<PhoneNumberRelease>, PhoneNumberRelease>>

beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

Hiermee start u een zoekopdracht naar telefoonnummers op basis van bepaalde beperkingen, zoals naam of netnummer. De gevonden telefoonnummers zijn gereserveerd totdat u de reservering annuleert, aanschaft of verloopt.

Deze functie retourneert een poller voor langdurige bewerkingen waarmee u voor onbepaalde tijd kunt wachten totdat de bewerking is voltooid.

Voorbeeldgebruik:

const client = new PhoneNumberAdministrationClient(CONNECTION_STRING);
const reservePoller = await client.beginReservePhoneNumbers(RESERVATION_REQUEST);

// Serializing the poller
const serialized = reservePoller.toString();

// Waiting until it's done
const results = await reservePoller.pollUntilDone();
console.log(results);
function beginReservePhoneNumbers(reservationRequest: CreateReservationRequest, options?: BeginReservePhoneNumbersOptions): Promise<PollerLike<PollOperationState<PhoneNumberReservation>, PhoneNumberReservation>>

Parameters

reservationRequest
CreateReservationRequest

Eigenschappen aanvragen om het zoekbereik te beperken.

options
BeginReservePhoneNumbersOptions

Aanvullende aanvraagopties.

Retouren

Promise<PollerLike<@azure/core-lro.PollOperationState<PhoneNumberReservation>, PhoneNumberReservation>>

cancelReservation(string, OperationOptions)

Annuleert de reservering die is gekoppeld aan een bepaalde id.

function cancelReservation(reservationId: string, options?: OperationOptions): Promise<{ _response: HttpResponse }>

Parameters

reservationId

string

De id van de reservering die wordt geretourneerd door createReservation.

options
OperationOptions

Aanvullende aanvraagopties.

Retouren

Promise<{ _response: HttpResponse }>

configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

Configureert een telefoonnummer, bijvoorbeeld om een callbackUrl toe te wijzen.

function configurePhoneNumber(config: ConfigurePhoneNumberRequest, options?: ConfigurePhoneNumberOptions): Promise<{ _response: HttpResponse }>

Parameters

config
ConfigurePhoneNumberRequest

De details van de configuratie

options
ConfigurePhoneNumberOptions

Aanvullende aanvraagopties.

Retouren

Promise<{ _response: HttpResponse }>

getAreaCodes(GetAreaCodesRequest, OperationOptions)

Krijgt een lijst met de ondersteunde netnummers op basis van locatie.

function getAreaCodes(request: GetAreaCodesRequest, options?: OperationOptions): Promise<GetAreaCodesResponse>

Parameters

request
GetAreaCodesRequest

Eigenschappen aanvragen om het zoekbereik te beperken.

options
OperationOptions

Aanvullende aanvraagopties.

Retouren

getCapabilitiesUpdate(string, OperationOptions)

Haal de aanvraag voor updatemogelijkheden op die is gekoppeld aan een bepaalde id.

function getCapabilitiesUpdate(capabilitiesUpdateId: string, options?: OperationOptions): Promise<GetCapabilitiesUpdateResponse>

Parameters

capabilitiesUpdateId

string

De id die aan de aanvraag is gekoppeld.

options
OperationOptions

Aanvullende aanvraagopties.

Retouren

getPhoneNumberConfiguration(string, OperationOptions)

Hiermee haalt u de configuratie voor een bepaald telefoonnummer op.

function getPhoneNumberConfiguration(phoneNumber: string, options?: OperationOptions): Promise<GetPhoneNumberConfigurationResponse>

Parameters

phoneNumber

string

De E.164-weergave van het telefoonnummer waarvan de configuratie wordt opgevraagd.

options
OperationOptions

Aanvullende aanvraagopties.

Retouren

getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

Hiermee haalt u de locatieopties voor een bepaald telefoonabonnement op.

function getPhonePlanLocationOptions(request: GetPhonePlanLocationOptionsRequest, options?: PageableLocalizationOptions): Promise<GetPhonePlanLocationOptionsResponse>

Parameters

request
GetPhonePlanLocationOptionsRequest

Eigenschappen aanvragen om het zoekbereik te beperken.

options
PageableLocalizationOptions

Aanvullende aanvraagopties.

Retouren

getReservation(string, OperationOptions)

Hiermee haalt u de reservering op die aan een bepaalde id is gekoppeld. Gebruik deze functie om de status van een telefoonnummerreservering op te vragen.

function getReservation(reservationId: string, options?: OperationOptions): Promise<GetReservationResponse>

Parameters

reservationId

string

De id van de reservering die wordt geretourneerd door createReservation.

options
OperationOptions

Aanvullende aanvraagopties.

Retouren

listPhoneNumbers(PageableLocalizationOptions)

Itereert de verkregen telefoonnummers.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const acquired of client.listPhoneNumbers()) {
  console.log("phone number: ", acquired.phoneNumber);
}
function listPhoneNumbers(options?: PageableLocalizationOptions): PagedAsyncIterableIterator<AcquiredPhoneNumber, AcquiredPhoneNumber[], PageSettings>

Parameters

options
PageableLocalizationOptions

De optionele parameters.

Retouren

listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

Itereert de beschikbare telefoonabonnementsgroepen voor een land.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const phonePlanGroup of client.listPhonePlanGroups("CA")) {
  console.log("plan group id: ", phonePlanGroup.phonePlanGroupId);
}
function listPhonePlanGroups(countryCode: string, options?: ListPhonePlanGroupsOptions): PagedAsyncIterableIterator<PhonePlanGroup, PhonePlanGroup[], PageSettings>

Parameters

countryCode

string

options
ListPhonePlanGroupsOptions

De optionele parameters.

Retouren

listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

Itereert het beschikbare telefoonabonnement voor een abonnementsgroep.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const phonePlan of client.listPhonePlanGroups(PLAN_GROUP_INFO)) {
  console.log("plan id: ", phonePlan.phonePlanId);
}

Gets all available phone plans for a given plan group.
@param planGroupInfo Information need to search for plans.
@param options Additional request options.
function listPhonePlans(planGroupInfo: ListPhonePlansRequest, options?: PageableLocalizationOptions): PagedAsyncIterableIterator<PhonePlan, PhonePlan[], PageSettings>

Parameters

planGroupInfo
ListPhonePlansRequest

Retouren

listReleases(PageableOptions)

Itereert de releases die zijn gemaakt door de Azure-resource.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const entity of client.listReleases()) {
  console.log("id: ", entity.id);
}

Hiermee haalt u alle releases op die zijn gemaakt door de Azure-resource.

function listReleases(options?: PageableOptions): PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

Parameters

options
PageableOptions

Optionele parameters voor het onderliggende HTTP-verzoek.

Retouren

listSearches(PageableOptions)

Itereert de zoekopdrachten die zijn gemaakt door de Azure-resource.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const entity of client.listSearches()) {
  console.log("id: ", entity.id);
}

Hiermee worden alle zoekopdrachten opgehaald die zijn gemaakt door de Azure-resource.

function listSearches(options?: PageableOptions): PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

Parameters

options
PageableOptions

Optionele parameters voor het onderliggende HTTP-verzoek.

Retouren

listSupportedCountries(PageableLocalizationOptions)

Itereert de ondersteunde landen.

Voorbeeldgebruik:

let client = new PhoneNumberAdministrationClient(credentials);
for await (const country of client.listSupportedCountries()) {
  console.log("country name: ", country.localizedName);
}
function listSupportedCountries(options?: PageableLocalizationOptions): PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

Parameters

options
PageableLocalizationOptions

De optionele parameters.

Retouren

unconfigurePhoneNumber(string, OperationOptions)

Deconfigureer een telefoonnummer en reset de configuratie.

function unconfigurePhoneNumber(phoneNumber: string, options?: OperationOptions): Promise<{ _response: HttpResponse }>

Parameters

phoneNumber

string

Telefoonnummer om de configuratie ongedaan te maken.

options
OperationOptions

Aanvullende aanvraagopties.

Retouren

Promise<{ _response: HttpResponse }>

updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

Hiermee worden de mogelijkheden voor een lijst met telefoonnummers bijgewerkt. Het antwoord bevat de id van de gemaakte aanvraag voor updatemogelijkheden, onthoud die id voor volgende aanroepen naar getCapabilitiesUpdate.

function updatePhoneNumbersCapabilities(phoneNumberCapabilitiesUpdates: PhoneNumberCapabilitiesUpdates, options?: UpdateCapabilitiesOptions): Promise<UpdateNumbersCapabilitiesResponse>

Parameters

phoneNumberCapabilitiesUpdates
PhoneNumberCapabilitiesUpdates

Woordenboek met een lijst met telefoonnummers en hun mogelijkheden, updates.

options
UpdateCapabilitiesOptions

Aanvullende aanvraagopties.

Retouren