PhoneNumberAdministrationClient class

Paket:: @azure/communication-administration

Kelas klien untuk berinteraksi dengan Administrasi Nomor Telepon Azure Communication Services.

Konstruktor

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)	Menginisialisasi instans baru kelas PhoneNumberAdministrationClient menggunakan Azure KeyCredential.
PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)	Menginisialisasi instans baru dari kelas PhoneNumberAdministrationClient.
PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)	Menginisialisasi instans baru kelas PhoneNumberAdministrationClient menggunakan TokenCredential.

Metode

beginPurchaseReservation(string, BeginPurchaseReservationOptions)	Memulai pembelian nomor telepon dalam reservasi yang terkait dengan id tertentu. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda untuk menunggu tanpa batas waktu hingga operasi selesai. Contoh penggunaan: `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)	Memulai rilis daftar nomor telepon yang diperoleh. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda untuk menunggu tanpa batas waktu hingga operasi selesai. Contoh penggunaan: `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)	Memulai pencarian nomor telepon yang diberikan beberapa batasan seperti nama atau kode area. Nomor telepon yang ditemukan dicadangkan hingga Anda membatalkan, membeli, atau reservasi kedaluwarsa. Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda untuk menunggu tanpa batas waktu hingga operasi selesai. Contoh penggunaan: `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)	Membatalkan reservasi yang terkait dengan id tertentu.
configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)	Mengonfigurasi nomor telepon, misalnya untuk menetapkan callbackUrl.
getAreaCodes(GetAreaCodesRequest, OperationOptions)	Mendapatkan daftar kode area yang didukung berdasarkan lokasi.
getCapabilitiesUpdate(string, OperationOptions)	Dapatkan permintaan kemampuan pembaruan yang terkait dengan id tertentu.
getPhoneNumberConfiguration(string, OperationOptions)	Mendapatkan konfigurasi untuk nomor telepon tertentu.
getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)	Mendapatkan opsi lokasi untuk paket telepon tertentu.
getReservation(string, OperationOptions)	Mendapatkan reservasi yang terkait dengan id tertentu. Gunakan fungsi ini untuk mengkueri status reservasi nomor telepon.
listPhoneNumbers(PageableLocalizationOptions)	Mengulangi nomor telepon yang diperoleh. Contoh penggunaan: `let client = new PhoneNumberAdministrationClient(credentials); for await (const acquired of client.listPhoneNumbers()) { console.log("phone number: ", acquired.phoneNumber); }`
listPhonePlanGroups(string, ListPhonePlanGroupsOptions)	Mengulangi grup paket telepon yang tersedia untuk suatu negara. Contoh penggunaan: `let client = new PhoneNumberAdministrationClient(credentials); for await (const phonePlanGroup of client.listPhonePlanGroups("CA")) { console.log("plan group id: ", phonePlanGroup.phonePlanGroupId); }`
listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)	Mengulangi paket telepon yang tersedia untuk grup paket. Contoh penggunaan: `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)	Mengulangi rilis yang dibuat oleh sumber daya Azure. Contoh penggunaan: `let client = new PhoneNumberAdministrationClient(credentials); for await (const entity of client.listReleases()) { console.log("id: ", entity.id); }` Mendapatkan semua rilis yang dibuat oleh sumber daya Azure.
listSearches(PageableOptions)	Mengulangi pencarian yang dibuat oleh sumber daya Azure. Contoh penggunaan: `let client = new PhoneNumberAdministrationClient(credentials); for await (const entity of client.listSearches()) { console.log("id: ", entity.id); }` Mendapatkan semua pencarian yang dibuat oleh sumber daya Azure.
listSupportedCountries(PageableLocalizationOptions)	Mengulangi negara yang didukung. Contoh penggunaan: `let client = new PhoneNumberAdministrationClient(credentials); for await (const country of client.listSupportedCountries()) { console.log("country name: ", country.localizedName); }`
unconfigurePhoneNumber(string, OperationOptions)	Batalkan konfigurasi nomor telepon, atur ulang konfigurasinya.
updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)	Memperbarui kemampuan untuk daftar nomor telepon. Respons mencakup id permintaan kemampuan pembaruan yang dibuat, ingat id tersebut untuk panggilan berikutnya ke getCapabilitiesUpdate.

Detail Konstruktor

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

Menginisialisasi instans baru kelas PhoneNumberAdministrationClient menggunakan Azure KeyCredential.

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

Parameter

url: string

Titik akhir layanan (misalnya: https://contoso.eastus.communications.azure.net).

credential: KeyCredential

Objek yang digunakan untuk mengautentikasi permintaan ke layanan. Gunakan Azure KeyCredential atau @azure/identity untuk membuat kredensial.

options: PhoneNumberAdministrationClientOptions

Fakultatif. Opsi untuk mengonfigurasi alur HTTP.

PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

Menginisialisasi instans baru dari kelas PhoneNumberAdministrationClient.

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

Parameter

connectionString: string

String koneksi untuk menyambungkan ke sumber daya Azure Communication Service. Contoh: "titik akhir=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options: PhoneNumberAdministrationClientOptions

Fakultatif. Opsi untuk mengonfigurasi alur HTTP.

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

Menginisialisasi instans baru kelas PhoneNumberAdministrationClient menggunakan TokenCredential.

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

Parameter

url: string

Titik akhir layanan (misalnya: https://contoso.eastus.communications.azure.net).

credential: TokenCredential

TokenCredential yang digunakan untuk mengautentikasi permintaan ke layanan.

options: PhoneNumberAdministrationClientOptions

Fakultatif. Opsi untuk mengonfigurasi alur HTTP.

Detail Metode

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

Memulai pembelian nomor telepon dalam reservasi yang terkait dengan id tertentu.

Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda untuk menunggu tanpa batas waktu hingga operasi selesai.

Contoh penggunaan:

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

Parameter

reservationId: string

ID reservasi untuk membeli.

options: BeginPurchaseReservationOptions

Opsi permintaan tambahan.

Mengembalikan

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

beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

Memulai rilis daftar nomor telepon yang diperoleh.

Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda untuk menunggu tanpa batas waktu hingga operasi selesai.

Contoh penggunaan:

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

Parameter

phoneNumbers: string[]

Nomor telepon akan dirilis.

options: BeginReleasePhoneNumbersOptions

Opsi permintaan tambahan.

Mengembalikan

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

beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

Memulai pencarian nomor telepon yang diberikan beberapa batasan seperti nama atau kode area. Nomor telepon yang ditemukan dicadangkan hingga Anda membatalkan, membeli, atau reservasi kedaluwarsa.

Fungsi ini mengembalikan poller Operasi Jangka Panjang yang memungkinkan Anda untuk menunggu tanpa batas waktu hingga operasi selesai.

Contoh penggunaan:

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

Parameter

reservationRequest: CreateReservationRequest

Minta properti untuk membatasi cakupan pencarian.

options: BeginReservePhoneNumbersOptions

Opsi permintaan tambahan.

Mengembalikan

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

cancelReservation(string, OperationOptions)

Membatalkan reservasi yang terkait dengan id tertentu.

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

Parameter

reservationId: string

ID reservasi yang dikembalikan oleh createReservation.

options: OperationOptions

Opsi permintaan tambahan.

Mengembalikan

Promise<{ _response: HttpResponse }>

configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

Mengonfigurasi nomor telepon, misalnya untuk menetapkan callbackUrl.

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

Parameter

config: ConfigurePhoneNumberRequest

Detail konfigurasi

options: ConfigurePhoneNumberOptions

Opsi permintaan tambahan.

Mengembalikan

Promise<{ _response: HttpResponse }>

getAreaCodes(GetAreaCodesRequest, OperationOptions)

Mendapatkan daftar kode area yang didukung berdasarkan lokasi.

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

Parameter

request: GetAreaCodesRequest

Minta properti untuk membatasi cakupan pencarian.

options: OperationOptions

Opsi permintaan tambahan.

Mengembalikan

Promise<GetAreaCodesResponse>

getCapabilitiesUpdate(string, OperationOptions)

Dapatkan permintaan kemampuan pembaruan yang terkait dengan id tertentu.

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

Parameter

capabilitiesUpdateId: string

ID yang terkait dengan permintaan.

options: OperationOptions

Opsi permintaan tambahan.

Mengembalikan

Promise<GetCapabilitiesUpdateResponse>

getPhoneNumberConfiguration(string, OperationOptions)

Mendapatkan konfigurasi untuk nomor telepon tertentu.

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

Parameter

phoneNumber: string

Representasi E.164 dari nomor telepon yang konfigurasinya diminta.

options: OperationOptions

Opsi permintaan tambahan.

Mengembalikan

Promise<GetPhoneNumberConfigurationResponse>

getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

Mendapatkan opsi lokasi untuk paket telepon tertentu.

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

Parameter

request: GetPhonePlanLocationOptionsRequest

Minta properti untuk membatasi cakupan pencarian.

options: PageableLocalizationOptions

Opsi permintaan tambahan.

Mengembalikan

Promise<GetPhonePlanLocationOptionsResponse>

getReservation(string, OperationOptions)

Mendapatkan reservasi yang terkait dengan id tertentu. Gunakan fungsi ini untuk mengkueri status reservasi nomor telepon.

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

Parameter

reservationId: string

ID reservasi yang dikembalikan oleh createReservation.

options: OperationOptions

Opsi permintaan tambahan.

Mengembalikan

Promise<GetReservationResponse>

listPhoneNumbers(PageableLocalizationOptions)

Mengulangi nomor telepon yang diperoleh.

Contoh penggunaan:

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>

Parameter

options: PageableLocalizationOptions

Parameter opsional.

Mengembalikan

PagedAsyncIterableIterator<AcquiredPhoneNumber, AcquiredPhoneNumber[], PageSettings>

listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

Mengulangi grup paket telepon yang tersedia untuk suatu negara.

Contoh penggunaan:

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>

Parameter

countryCode: string

options: ListPhonePlanGroupsOptions

Parameter opsional.

Mengembalikan

PagedAsyncIterableIterator<PhonePlanGroup, PhonePlanGroup[], PageSettings>

listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

Mengulangi paket telepon yang tersedia untuk grup paket.

Contoh penggunaan:

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>

Parameter

planGroupInfo: ListPhonePlansRequest

options: PageableLocalizationOptions

Mengembalikan

PagedAsyncIterableIterator<PhonePlan, PhonePlan[], PageSettings>

listReleases(PageableOptions)

Mengulangi rilis yang dibuat oleh sumber daya Azure.

Contoh penggunaan:

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

Mendapatkan semua rilis yang dibuat oleh sumber daya Azure.

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

Parameter

options: PageableOptions

Parameter opsional untuk permintaan HTTP yang mendasarinya.

Mengembalikan

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSearches(PageableOptions)

Mengulangi pencarian yang dibuat oleh sumber daya Azure.

Contoh penggunaan:

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

Mendapatkan semua pencarian yang dibuat oleh sumber daya Azure.

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

Parameter

options: PageableOptions

Parameter opsional untuk permintaan HTTP yang mendasarinya.

Mengembalikan

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSupportedCountries(PageableLocalizationOptions)

Mengulangi negara yang didukung.

Contoh penggunaan:

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>

Parameter

options: PageableLocalizationOptions

Parameter opsional.

Mengembalikan

PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

unconfigurePhoneNumber(string, OperationOptions)

Batalkan konfigurasi nomor telepon, atur ulang konfigurasinya.

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

Parameter

phoneNumber: string

Nomor Telepon untuk membatalkan konfigurasi.

options: OperationOptions

Opsi permintaan tambahan.

Mengembalikan

Promise<{ _response: HttpResponse }>

updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

Memperbarui kemampuan untuk daftar nomor telepon. Respons mencakup id permintaan kemampuan pembaruan yang dibuat, ingat id tersebut untuk panggilan berikutnya ke getCapabilitiesUpdate.

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

Parameter

phoneNumberCapabilitiesUpdates: PhoneNumberCapabilitiesUpdates

Kamus yang berisi daftar nomor telepon dan pembaruan kemampuannya.

options: UpdateCapabilitiesOptions

Opsi permintaan tambahan.

Mengembalikan

Promise<UpdateNumbersCapabilitiesResponse>

Saran dan Komentar

Apakah halaman ini membantu?