PhoneNumberAdministrationClient class

Paket:: @azure/communication-administration

Klientklass för att interagera med Azure Communication Services PhoneNumber Administration.

Konstruktorer

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)	Initierar en ny instans av klassen PhoneNumberAdministrationClient med hjälp av en Azure KeyCredential.
PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)	Initierar en ny instans av klassen PhoneNumberAdministrationClient.
PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)	Initierar en ny instans av klassen PhoneNumberAdministrationClient med hjälp av en TokenCredential.

Metoder

beginPurchaseReservation(string, BeginPurchaseReservationOptions)	Startar köpet av telefonnumren i reservationen som är kopplad till ett visst ID. Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts. Exempel på användning: `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)	Startar lanseringen av en lista över inhämtade telefonnummer. Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts. Exempel på användning: `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)	Startar en sökning efter telefonnummer med tanke på vissa begränsningar, till exempel namn eller riktnummer. De telefonnummer som hittas är reserverade tills du avbryter, köper eller reservationen upphör att gälla. Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts. Exempel på användning: `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)	Avbryter reservationen som är kopplad till ett visst ID.
configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)	Konfigurerar ett telefonnummer, till exempel för att tilldela en callbackUrl.
getAreaCodes(GetAreaCodesRequest, OperationOptions)	Hämtar en lista över de riktnummer som stöds baserat på plats.
getCapabilitiesUpdate(string, OperationOptions)	Hämta begäran om uppdateringsfunktioner som är associerade med ett visst ID.
getPhoneNumberConfiguration(string, OperationOptions)	Hämtar konfigurationen för ett visst telefonnummer.
getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)	Hämtar platsalternativen för ett visst telefonabonnemang.
getReservation(string, OperationOptions)	Hämtar reservationen som är associerad med ett visst ID. Använd den här funktionen för att fråga efter status för en telefonnummerreservation.
listPhoneNumbers(PageableLocalizationOptions)	Itererar de inhämtade telefonnummermen. Exempel på användning: `let client = new PhoneNumberAdministrationClient(credentials); for await (const acquired of client.listPhoneNumbers()) { console.log("phone number: ", acquired.phoneNumber); }`
listPhonePlanGroups(string, ListPhonePlanGroupsOptions)	Itererar de tillgängliga telefonabonnemangsgrupperna för ett land. Exempel på användning: `let client = new PhoneNumberAdministrationClient(credentials); for await (const phonePlanGroup of client.listPhonePlanGroups("CA")) { console.log("plan group id: ", phonePlanGroup.phonePlanGroupId); }`
listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)	Itererar det tillgängliga telefonabonnemanget för en abonnemangsgrupp. Exempel på användning: `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)	Itererar de versioner som skapats av Azure-resursen. Exempel på användning: `let client = new PhoneNumberAdministrationClient(credentials); for await (const entity of client.listReleases()) { console.log("id: ", entity.id); }` Hämtar alla versioner som skapats av Azure-resursen.
listSearches(PageableOptions)	Itererar sökningarna som skapats av Azure-resursen. Exempel på användning: `let client = new PhoneNumberAdministrationClient(credentials); for await (const entity of client.listSearches()) { console.log("id: ", entity.id); }` Hämtar alla sökningar som skapats av Azure-resursen.
listSupportedCountries(PageableLocalizationOptions)	Itererar de länder som stöds. Exempel på användning: `let client = new PhoneNumberAdministrationClient(credentials); for await (const country of client.listSupportedCountries()) { console.log("country name: ", country.localizedName); }`
unconfigurePhoneNumber(string, OperationOptions)	Avkonfigurera ett telefonnummer och återställ dess konfiguration.
updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)	Uppdaterar funktionerna för en lista med telefonnummer. Svaret innehåller id för den skapade begäran om uppdateringsfunktioner, kom ihåg det id:t för efterföljande anrop till getCapabilitiesUpdate.

Konstruktorinformation

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

Initierar en ny instans av klassen PhoneNumberAdministrationClient med hjälp av en Azure KeyCredential.

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

Parametrar

url: string

Tjänstens slutpunkt (till exempel https://contoso.eastus.communications.azure.net).

credential: KeyCredential

Ett objekt som används för att autentisera begäranden till tjänsten. Använd Azure KeyCredential eller @azure/identity för att skapa en autentiseringsuppgift.

options: PhoneNumberAdministrationClientOptions

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

Initierar en ny instans av klassen PhoneNumberAdministrationClient.

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

Parametrar

connectionString: string

Anslutningssträng för att ansluta till en Azure Communication Service-resurs. Exempel: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options: PhoneNumberAdministrationClientOptions

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

Initierar en ny instans av klassen PhoneNumberAdministrationClient med hjälp av en TokenCredential.

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

Parametrar

url: string

Tjänstens slutpunkt (till exempel https://contoso.eastus.communications.azure.net).

credential: TokenCredential

TokenCredential som används för att autentisera begäranden till tjänsten.

options: PhoneNumberAdministrationClientOptions

Valfritt. Alternativ för att konfigurera HTTP-pipelinen.

Metodinformation

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

Startar köpet av telefonnumren i reservationen som är kopplad till ett visst ID.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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

Parametrar

reservationId: string

ID:t för reservationen som ska köpas.

options: BeginPurchaseReservationOptions

Ytterligare alternativ för begäran.

Returer

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

beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

Startar lanseringen av en lista över inhämtade telefonnummer.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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

Parametrar

phoneNumbers: string[]

Telefonnumren som ska släppas.

options: BeginReleasePhoneNumbersOptions

Ytterligare alternativ för begäran.

Returer

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

beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

Startar en sökning efter telefonnummer med tanke på vissa begränsningar, till exempel namn eller riktnummer. De telefonnummer som hittas är reserverade tills du avbryter, köper eller reservationen upphör att gälla.

Den här funktionen returnerar en poller för tidskrävande åtgärder som gör att du kan vänta på obestämd tid tills åtgärden har slutförts.

Exempel på användning:

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

Parametrar

reservationRequest: CreateReservationRequest

Begär egenskaper för att begränsa sökomfånget.

options: BeginReservePhoneNumbersOptions

Ytterligare alternativ för begäran.

Returer

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

cancelReservation(string, OperationOptions)

Avbryter reservationen som är kopplad till ett visst ID.

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

Parametrar

reservationId: string

ID:t för reservationen som returneras av createReservation.

options: OperationOptions

Ytterligare alternativ för begäran.

Returer

Promise<{ _response: HttpResponse }>

configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

Konfigurerar ett telefonnummer, till exempel för att tilldela en callbackUrl.

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

Parametrar

config: ConfigurePhoneNumberRequest

Konfigurations information

options: ConfigurePhoneNumberOptions

Ytterligare alternativ för begäran.

Returer

Promise<{ _response: HttpResponse }>

getAreaCodes(GetAreaCodesRequest, OperationOptions)

Hämtar en lista över de riktnummer som stöds baserat på plats.

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

Parametrar

request: GetAreaCodesRequest

Begär egenskaper för att begränsa sökomfånget.

options: OperationOptions

Ytterligare alternativ för begäran.

Returer

Promise<GetAreaCodesResponse>

getCapabilitiesUpdate(string, OperationOptions)

Hämta begäran om uppdateringsfunktioner som är associerade med ett visst ID.

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

Parametrar

capabilitiesUpdateId: string

Det ID som är associerat med begäran.

options: OperationOptions

Ytterligare alternativ för begäran.

Returer

Promise<GetCapabilitiesUpdateResponse>

getPhoneNumberConfiguration(string, OperationOptions)

Hämtar konfigurationen för ett visst telefonnummer.

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

Parametrar

phoneNumber: string

E.164-representationen av telefonnumret vars konfiguration begärs.

options: OperationOptions

Ytterligare alternativ för begäran.

Returer

Promise<GetPhoneNumberConfigurationResponse>

getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

Hämtar platsalternativen för ett visst telefonabonnemang.

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

Parametrar

request: GetPhonePlanLocationOptionsRequest

Begär egenskaper för att begränsa sökomfånget.

options: PageableLocalizationOptions

Ytterligare alternativ för begäran.

Returer

Promise<GetPhonePlanLocationOptionsResponse>

getReservation(string, OperationOptions)

Hämtar reservationen som är associerad med ett visst ID. Använd den här funktionen för att fråga efter status för en telefonnummerreservation.

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

Parametrar

reservationId: string

ID:t för reservationen som returneras av createReservation.

options: OperationOptions

Ytterligare alternativ för begäran.

Returer

Promise<GetReservationResponse>

listPhoneNumbers(PageableLocalizationOptions)

Itererar de inhämtade telefonnummermen.

Exempel på användning:

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>

Parametrar

options: PageableLocalizationOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<AcquiredPhoneNumber, AcquiredPhoneNumber[], PageSettings>

listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

Itererar de tillgängliga telefonabonnemangsgrupperna för ett land.

Exempel på användning:

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>

Parametrar

countryCode: string

options: ListPhonePlanGroupsOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<PhonePlanGroup, PhonePlanGroup[], PageSettings>

listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

Itererar det tillgängliga telefonabonnemanget för en abonnemangsgrupp.

Exempel på användning:

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>

Parametrar

planGroupInfo: ListPhonePlansRequest

options: PageableLocalizationOptions

Returer

PagedAsyncIterableIterator<PhonePlan, PhonePlan[], PageSettings>

listReleases(PageableOptions)

Itererar de versioner som skapats av Azure-resursen.

Exempel på användning:

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

Hämtar alla versioner som skapats av Azure-resursen.

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

Parametrar

options: PageableOptions

Valfria parametrar för den underliggande HTTP-begäran.

Returer

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSearches(PageableOptions)

Itererar sökningarna som skapats av Azure-resursen.

Exempel på användning:

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

Hämtar alla sökningar som skapats av Azure-resursen.

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

Parametrar

options: PageableOptions

Valfria parametrar för den underliggande HTTP-begäran.

Returer

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSupportedCountries(PageableLocalizationOptions)

Itererar de länder som stöds.

Exempel på användning:

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>

Parametrar

options: PageableLocalizationOptions

De valfria parametrarna.

Returer

PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

unconfigurePhoneNumber(string, OperationOptions)

Avkonfigurera ett telefonnummer och återställ dess konfiguration.

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

Parametrar

phoneNumber: string

Telefonnummer som ska avkonfigureras.

options: OperationOptions

Ytterligare alternativ för begäran.

Returer

Promise<{ _response: HttpResponse }>

updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

Uppdaterar funktionerna för en lista med telefonnummer. Svaret innehåller id för den skapade begäran om uppdateringsfunktioner, kom ihåg det id:t för efterföljande anrop till getCapabilitiesUpdate.

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

Parametrar

phoneNumberCapabilitiesUpdates: PhoneNumberCapabilitiesUpdates

Ordlista som innehåller en lista över telefonnummer och deras funktionsuppdateringar.

options: UpdateCapabilitiesOptions

Ytterligare alternativ för begäran.

Returer

Promise<UpdateNumbersCapabilitiesResponse>

Feedback

Var den här sidan till hjälp?