PhoneNumberAdministrationClient class

Balíček:: @azure/communication-administration

Třída klienta pro interakci se správou telefonního čísla Azure Communication Services.

Konstruktory

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)	Inicializuje novou instanci PhoneNumberAdministrationClient třídy pomocí Azure KeyCredential.
PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)	Inicializuje novou instanci třídy PhoneNumberAdministrationClient.
PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)	Inicializuje novou instanci PhoneNumberAdministrationClient třídy pomocí TokenCredential.

Metody

beginPurchaseReservation(string, BeginPurchaseReservationOptions)	Zahájí nákup telefonního čísla (čísel) v rezervaci spojeném s daným dokladem totožnosti. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud nebude operace dokončena. Příklad použití: `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)	Spustí vydání seznamu získaných telefonních čísel. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud nebude operace dokončena. Příklad použití: `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)	Spustí hledání telefonních čísel s určitými omezeními, jako je název nebo směrové číslo oblasti. Telefonní čísla, která jsou nalezena, jsou vyhrazena, dokud nezrušíte, zakoupíte nebo nevyprší platnost rezervace. Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud nebude operace dokončena. Příklad použití: `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)	Zruší rezervaci spojenou s daným ID.
configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)	Nakonfiguruje telefonní číslo, například pro přiřazení callbackUrl.
getAreaCodes(GetAreaCodesRequest, OperationOptions)	Získá seznam podporovaných směrových čísel oblastí na základě umístění.
getCapabilitiesUpdate(string, OperationOptions)	Získejte požadavek na možnosti aktualizace přidružený k danému ID.
getPhoneNumberConfiguration(string, OperationOptions)	Získá konfiguraci pro dané telefonní číslo.
getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)	Získá možnosti umístění pro daný telefonní tarif.
getReservation(string, OperationOptions)	Získá rezervaci přidruženou k danému ID. Tato funkce slouží k dotazu na stav rezervace telefonního čísla.
listPhoneNumbers(PageableLocalizationOptions)	Iteruje získaná telefonní čísla. Příklad použití: `let client = new PhoneNumberAdministrationClient(credentials); for await (const acquired of client.listPhoneNumbers()) { console.log("phone number: ", acquired.phoneNumber); }`
listPhonePlanGroups(string, ListPhonePlanGroupsOptions)	Iteruje dostupné skupiny telefonních tarifů pro danou zemi. Příklad použití: `let client = new PhoneNumberAdministrationClient(credentials); for await (const phonePlanGroup of client.listPhonePlanGroups("CA")) { console.log("plan group id: ", phonePlanGroup.phonePlanGroupId); }`
listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)	Iteruje telefonní tarif dostupný pro skupinu plánů. Příklad použití: `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)	Iteruje verze vytvořené prostředkem Azure. Příklad použití: `let client = new PhoneNumberAdministrationClient(credentials); for await (const entity of client.listReleases()) { console.log("id: ", entity.id); }` Získá všechny verze vytvořené prostředkem Azure.
listSearches(PageableOptions)	Iteruje vyhledávání vytvořená prostředkem Azure. Příklad použití: `let client = new PhoneNumberAdministrationClient(credentials); for await (const entity of client.listSearches()) { console.log("id: ", entity.id); }` Získá všechna hledání vytvořená prostředkem Azure.
listSupportedCountries(PageableLocalizationOptions)	Iteruje podporované země. Příklad použití: `let client = new PhoneNumberAdministrationClient(credentials); for await (const country of client.listSupportedCountries()) { console.log("country name: ", country.localizedName); }`
unconfigurePhoneNumber(string, OperationOptions)	Zrušte konfiguraci telefonního čísla a resetujte jeho konfiguraci.
updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)	Aktualizuje možnosti seznamu telefonních čísel. Odpověď obsahuje id vytvořeného požadavku na možnosti aktualizace, zapamatujte si toto id pro následná volání getCapabilitiesUpdate.

Podrobnosti konstruktoru

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

Inicializuje novou instanci PhoneNumberAdministrationClient třídy pomocí Azure KeyCredential.

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

Parametry

url: string

Koncový bod služby (např. https://contoso.eastus.communications.azure.net).

credential: KeyCredential

Objekt, který se používá k ověření požadavků na službu. K vytvoření přihlašovacích údajů použijte Azure KeyCredential nebo @azure/identity.

options: PhoneNumberAdministrationClientOptions

Volitelný. Možnosti konfigurace kanálu HTTP

PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

Inicializuje novou instanci třídy PhoneNumberAdministrationClient.

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

Parametry

connectionString: string

Připojovací řetězec pro připojení k prostředku služby Azure Communication Service. Příklad: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options: PhoneNumberAdministrationClientOptions

Volitelný. Možnosti konfigurace kanálu HTTP

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

Inicializuje novou instanci PhoneNumberAdministrationClient třídy pomocí TokenCredential.

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

Parametry

url: string

Koncový bod služby (např. https://contoso.eastus.communications.azure.net).

credential: TokenCredential

TokenCredential, který slouží k ověřování požadavků na službu.

options: PhoneNumberAdministrationClientOptions

Volitelný. Možnosti konfigurace kanálu HTTP

Podrobnosti metody

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

Zahájí nákup telefonního čísla (čísel) v rezervaci spojeném s daným dokladem totožnosti.

Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud nebude operace dokončena.

Příklad použití:

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

Parametry

reservationId: string

ID rezervace k nákupu.

options: BeginPurchaseReservationOptions

Další možnosti žádosti.

Návraty

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

beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

Spustí vydání seznamu získaných telefonních čísel.

Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud nebude operace dokončena.

Příklad použití:

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

Parametry

phoneNumbers: string[]

Telefonní čísla, která mají být zveřejněna.

options: BeginReleasePhoneNumbersOptions

Další možnosti žádosti.

Návraty

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

beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

Spustí hledání telefonních čísel s určitými omezeními, jako je název nebo směrové číslo oblasti. Telefonní čísla, která jsou nalezena, jsou vyhrazena, dokud nezrušíte, zakoupíte nebo nevyprší platnost rezervace.

Tato funkce vrátí poller dlouhotrvající operace, která umožňuje čekat na neomezenou dobu, dokud nebude operace dokončena.

Příklad použití:

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

Parametry

reservationRequest: CreateReservationRequest

Vyžádejte si vlastnosti, které omezí obor vyhledávání.

options: BeginReservePhoneNumbersOptions

Další možnosti žádosti.

Návraty

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

cancelReservation(string, OperationOptions)

Zruší rezervaci spojenou s daným ID.

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

Parametry

reservationId: string

ID rezervace vrácené createReservation.

options: OperationOptions

Další možnosti žádosti.

Návraty

Promise<{ _response: HttpResponse }>

configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

Nakonfiguruje telefonní číslo, například pro přiřazení callbackUrl.

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

Parametry

config: ConfigurePhoneNumberRequest

Podrobnosti o konfiguraci

options: ConfigurePhoneNumberOptions

Další možnosti žádosti.

Návraty

Promise<{ _response: HttpResponse }>

getAreaCodes(GetAreaCodesRequest, OperationOptions)

Získá seznam podporovaných směrových čísel oblastí na základě umístění.

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

Parametry

request: GetAreaCodesRequest

Vyžádejte si vlastnosti, které omezí obor vyhledávání.

options: OperationOptions

Další možnosti žádosti.

Návraty

Promise<GetAreaCodesResponse>

getCapabilitiesUpdate(string, OperationOptions)

Získejte požadavek na možnosti aktualizace přidružený k danému ID.

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

Parametry

capabilitiesUpdateId: string

ID přidružené k požadavku.

options: OperationOptions

Další možnosti žádosti.

Návraty

Promise<GetCapabilitiesUpdateResponse>

getPhoneNumberConfiguration(string, OperationOptions)

Získá konfiguraci pro dané telefonní číslo.

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

Parametry

phoneNumber: string

Reprezentace E.164 telefonního čísla, jehož konfigurace je požadována.

options: OperationOptions

Další možnosti žádosti.

Návraty

Promise<GetPhoneNumberConfigurationResponse>

getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

Získá možnosti umístění pro daný telefonní tarif.

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

Parametry

request: GetPhonePlanLocationOptionsRequest

Vyžádejte si vlastnosti, které omezí obor vyhledávání.

options: PageableLocalizationOptions

Další možnosti žádosti.

Návraty

Promise<GetPhonePlanLocationOptionsResponse>

getReservation(string, OperationOptions)

Získá rezervaci přidruženou k danému ID. Tato funkce slouží k dotazu na stav rezervace telefonního čísla.

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

Parametry

reservationId: string

ID rezervace vrácené createReservation.

options: OperationOptions

Další možnosti žádosti.

Návraty

Promise<GetReservationResponse>

listPhoneNumbers(PageableLocalizationOptions)

Iteruje získaná telefonní čísla.

Příklad použití:

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>

Parametry

options: PageableLocalizationOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<AcquiredPhoneNumber, AcquiredPhoneNumber[], PageSettings>

listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

Iteruje dostupné skupiny telefonních tarifů pro danou zemi.

Příklad použití:

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>

Parametry

countryCode: string

options: ListPhonePlanGroupsOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<PhonePlanGroup, PhonePlanGroup[], PageSettings>

listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

Iteruje telefonní tarif dostupný pro skupinu plánů.

Příklad použití:

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>

Parametry

planGroupInfo: ListPhonePlansRequest

options: PageableLocalizationOptions

Návraty

PagedAsyncIterableIterator<PhonePlan, PhonePlan[], PageSettings>

listReleases(PageableOptions)

Iteruje verze vytvořené prostředkem Azure.

Příklad použití:

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

Získá všechny verze vytvořené prostředkem Azure.

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

Parametry

options: PageableOptions

Volitelné parametry pro základní požadavek HTTP.

Návraty

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSearches(PageableOptions)

Iteruje vyhledávání vytvořená prostředkem Azure.

Příklad použití:

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

Získá všechna hledání vytvořená prostředkem Azure.

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

Parametry

options: PageableOptions

Volitelné parametry pro základní požadavek HTTP.

Návraty

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSupportedCountries(PageableLocalizationOptions)

Iteruje podporované země.

Příklad použití:

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>

Parametry

options: PageableLocalizationOptions

Volitelné parametry.

Návraty

PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

unconfigurePhoneNumber(string, OperationOptions)

Zrušte konfiguraci telefonního čísla a resetujte jeho konfiguraci.

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

Parametry

phoneNumber: string

Telefonní číslo ke zrušení konfigurace.

options: OperationOptions

Další možnosti žádosti.

Návraty

Promise<{ _response: HttpResponse }>

updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

Aktualizuje možnosti seznamu telefonních čísel. Odpověď obsahuje id vytvořeného požadavku na možnosti aktualizace, zapamatujte si toto id pro následná volání getCapabilitiesUpdate.

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

Parametry

phoneNumberCapabilitiesUpdates: PhoneNumberCapabilitiesUpdates

Slovník obsahující seznam telefonních čísel a jejich možnosti, aktualizace.

options: UpdateCapabilitiesOptions

Další možnosti žádosti.

Návraty

Promise<UpdateNumbersCapabilitiesResponse>

Váš názor

Byla tato stránka užitečná?

Sdílet prostřednictvím

PhoneNumberAdministrationClient class

Konstruktory

Metody

Podrobnosti konstruktoru

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

Parametry

PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

Parametry

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

Parametry

Podrobnosti metody

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

Parametry

Návraty

beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

Parametry

Návraty

beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

Parametry

Návraty

cancelReservation(string, OperationOptions)

Parametry

Návraty

configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

Parametry

Návraty

getAreaCodes(GetAreaCodesRequest, OperationOptions)

Parametry

Návraty

getCapabilitiesUpdate(string, OperationOptions)

Parametry

Návraty

getPhoneNumberConfiguration(string, OperationOptions)

Parametry

Návraty

getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

Parametry

Návraty

getReservation(string, OperationOptions)

Parametry

Návraty

listPhoneNumbers(PageableLocalizationOptions)

Parametry

Návraty

listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

Parametry

Návraty

listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

Parametry

Návraty

listReleases(PageableOptions)

Parametry

Návraty

listSearches(PageableOptions)

Parametry

Návraty

listSupportedCountries(PageableLocalizationOptions)

Parametry

Návraty

unconfigurePhoneNumber(string, OperationOptions)

Parametry

Návraty

updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

Parametry

Návraty

Váš názor