PhoneNumberAdministrationClient class

Paket:

@azure/communication-administration

Azure İletişim Hizmetleri PhoneNumber Yönetimi ile etkileşim kurmak için istemci sınıfı.

Oluşturucular

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)	Bir Azure KeyCredential kullanarak PhoneNumberAdministrationClient sınıfının yeni bir örneğini başlatır.
PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)	PhoneNumberAdministrationClient sınıfının yeni bir örneğini başlatır.
PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)	TokenCredential kullanarak PhoneNumberAdministrationClient sınıfının yeni bir örneğini başlatır.

Yöntemler

beginPurchaseReservation(string, BeginPurchaseReservationOptions)	Rezervasyonda yer alan ve belirli bir kimlikle ilişkilendirilmiş telefon numaralarının satın alma işlemini başlatır. Bu işlev, işlem tamamlanana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür. Örnek kullanım: 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)	Alınan telefon numaralarının bir listesinin yayınlanmasını başlatır. Bu işlev, işlem tamamlanana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür. Örnek kullanım: 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)	Ad veya alan kodu gibi bazı kısıtlamalar verilip telefon numaraları için arama başlatır. Bulunan telefon numaraları, siz iptal edilene, satın alınana veya rezervasyonun süresi dolana kadar ayrılır. Bu işlev, işlem tamamlanana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür. Örnek kullanım: 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)	Belirli bir kimlikle ilişkili rezervasyonu iptal eder.
configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)	Örneğin, bir callbackUrl atamak için bir telefon numarası yapılandırır.
getAreaCodes(GetAreaCodesRequest, OperationOptions)	Konuma göre desteklenen alan kodlarının bir listesini alır.
getCapabilitiesUpdate(string, OperationOptions)	Belirli bir kimlikle ilişkili güncelleştirme özellikleri isteğini alın.
getPhoneNumberConfiguration(string, OperationOptions)	Belirli bir telefon numarasının yapılandırmasını alır.
getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)	Belirli bir telefon planı için konum seçeneklerini alır.
getReservation(string, OperationOptions)	Belirli bir kimlikle ilişkilendirilmiş rezervasyonu alır. Bir telefon numarası rezervasyonunun durumunu sorgulamak için bu işlevi kullanın.
listPhoneNumbers(PageableLocalizationOptions)	Alınan telefon numaralarını yineler. Örnek kullanım: let client = new PhoneNumberAdministrationClient(credentials); for await (const acquired of client.listPhoneNumbers()) { console.log("phone number: ", acquired.phoneNumber); }
listPhonePlanGroups(string, ListPhonePlanGroupsOptions)	Bir ülke için kullanılabilir telefon planı gruplarını yineler. Örnek kullanım: let client = new PhoneNumberAdministrationClient(credentials); for await (const phonePlanGroup of client.listPhonePlanGroups("CA")) { console.log("plan group id: ", phonePlanGroup.phonePlanGroupId); }
listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)	Bir plan grubu için kullanılabilir telefon planını yineler. Örnek kullanım: 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)	Azure kaynağı tarafından oluşturulan yayınları yineler. Örnek kullanım: let client = new PhoneNumberAdministrationClient(credentials); for await (const entity of client.listReleases()) { console.log("id: ", entity.id); } Azure kaynağı tarafından oluşturulan tüm yayınları alır.
listSearches(PageableOptions)	Azure kaynağı tarafından oluşturulan aramaları yineler. Örnek kullanım: let client = new PhoneNumberAdministrationClient(credentials); for await (const entity of client.listSearches()) { console.log("id: ", entity.id); } Azure kaynağı tarafından oluşturulan tüm aramaları alır.
listSupportedCountries(PageableLocalizationOptions)	Desteklenen ülkeleri yineler. Örnek kullanım: let client = new PhoneNumberAdministrationClient(credentials); for await (const country of client.listSupportedCountries()) { console.log("country name: ", country.localizedName); }
unconfigurePhoneNumber(string, OperationOptions)	Bir telefon numarasının yapılandırmasını kaldırın ve yapılandırmasını sıfırlayın.
updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)	Telefon numaraları listesinin özelliklerini güncelleştirir. Yanıt, oluşturulan güncelleştirme özellikleri isteğinin kimliğini içerir, sonraki getCapabilitiesUpdate çağrıları için bu kimliği unutmayın.

Oluşturucu Ayrıntıları

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

Bir Azure KeyCredential kullanarak PhoneNumberAdministrationClient sınıfının yeni bir örneğini başlatır.

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

Parametreler

url

string

Hizmetin uç noktası (ör. https://contoso.eastus.communications.azure.net).

credential

KeyCredential

Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılan bir nesne. Kimlik bilgisi oluşturmak için Azure KeyCredential veya @azure/identity kullanın.

options

PhoneNumberAdministrationClientOptions

Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.

PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

PhoneNumberAdministrationClient sınıfının yeni bir örneğini başlatır.

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

Parametreler

connectionString

string

Azure İletişim Hizmeti kaynağına bağlanmak için bağlantı dizesi. Örnek: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options

PhoneNumberAdministrationClientOptions

Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

TokenCredential kullanarak PhoneNumberAdministrationClient sınıfının yeni bir örneğini başlatır.

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

Parametreler

url

string

Hizmetin uç noktası (ör. https://contoso.eastus.communications.azure.net).

credential

TokenCredential

Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılan TokenCredential.

options

PhoneNumberAdministrationClientOptions

Opsiyonel. HTTP işlem hattını yapılandırma seçenekleri.

Yöntem Ayrıntıları

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

Rezervasyonda yer alan ve belirli bir kimlikle ilişkilendirilmiş telefon numaralarının satın alma işlemini başlatır.

Bu işlev, işlem tamamlanana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Örnek kullanım:

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

Parametreler

reservationId

string

Satın alınacak rezervasyonun kimliği.

options

BeginPurchaseReservationOptions

Ek istek seçenekleri.

Döndürülenler

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

beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

Alınan telefon numaralarının bir listesinin yayınlanmasını başlatır.

Bu işlev, işlem tamamlanana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Örnek kullanım:

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

Parametreler

phoneNumbers

string[]

Açıklanacak telefon numaraları.

options

BeginReleasePhoneNumbersOptions

Ek istek seçenekleri.

Döndürülenler

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

beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

Ad veya alan kodu gibi bazı kısıtlamalar verilip telefon numaraları için arama başlatır. Bulunan telefon numaraları, siz iptal edilene, satın alınana veya rezervasyonun süresi dolana kadar ayrılır.

Bu işlev, işlem tamamlanana kadar süresiz olarak beklemenize olanak tanıyan uzun süre çalışan bir İşlem poller döndürür.

Örnek kullanım:

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

Parametreler

reservationRequest

CreateReservationRequest

Arama kapsamını kısıtlamak için özellikler isteyin.

options

BeginReservePhoneNumbersOptions

Ek istek seçenekleri.

Döndürülenler

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

cancelReservation(string, OperationOptions)

Belirli bir kimlikle ilişkili rezervasyonu iptal eder.

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

Parametreler

reservationId

string

createReservation tarafından döndürülen rezervasyonun kimliği.

options

OperationOptions

Ek istek seçenekleri.

Döndürülenler

Promise<{ _response: HttpResponse }>

configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

Örneğin, bir callbackUrl atamak için bir telefon numarası yapılandırır.

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

Parametreler

config

ConfigurePhoneNumberRequest

Yapılandırma ayrıntıları

options

ConfigurePhoneNumberOptions

Ek istek seçenekleri.

Döndürülenler

Promise<{ _response: HttpResponse }>

getAreaCodes(GetAreaCodesRequest, OperationOptions)

Konuma göre desteklenen alan kodlarının bir listesini alır.

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

Parametreler

request

GetAreaCodesRequest

Arama kapsamını kısıtlamak için özellikler isteyin.

options

OperationOptions

Ek istek seçenekleri.

Döndürülenler

Promise<GetAreaCodesResponse>

getCapabilitiesUpdate(string, OperationOptions)

Belirli bir kimlikle ilişkili güncelleştirme özellikleri isteğini alın.

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

Parametreler

capabilitiesUpdateId

string

İstekle ilişkili kimlik.

options

OperationOptions

Ek istek seçenekleri.

Döndürülenler

Promise<GetCapabilitiesUpdateResponse>

getPhoneNumberConfiguration(string, OperationOptions)

Belirli bir telefon numarasının yapılandırmasını alır.

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

Parametreler

phoneNumber

string

Yapılandırması istenen telefon numarasının E.164 gösterimi.

options

OperationOptions

Ek istek seçenekleri.

Döndürülenler

Promise<GetPhoneNumberConfigurationResponse>

getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

Belirli bir telefon planı için konum seçeneklerini alır.

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

Parametreler

request

GetPhonePlanLocationOptionsRequest

Arama kapsamını kısıtlamak için özellikler isteyin.

options

PageableLocalizationOptions

Ek istek seçenekleri.

Döndürülenler

Promise<GetPhonePlanLocationOptionsResponse>

getReservation(string, OperationOptions)

Belirli bir kimlikle ilişkilendirilmiş rezervasyonu alır. Bir telefon numarası rezervasyonunun durumunu sorgulamak için bu işlevi kullanın.

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

Parametreler

reservationId

string

createReservation tarafından döndürülen rezervasyonun kimliği.

options

OperationOptions

Ek istek seçenekleri.

Döndürülenler

Promise<GetReservationResponse>

listPhoneNumbers(PageableLocalizationOptions)

Alınan telefon numaralarını yineler.

Örnek kullanım:

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>

Parametreler

options

PageableLocalizationOptions

İsteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<AcquiredPhoneNumber, AcquiredPhoneNumber[], PageSettings>

listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

Bir ülke için kullanılabilir telefon planı gruplarını yineler.

Örnek kullanım:

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>

Parametreler

countryCode

string

options

ListPhonePlanGroupsOptions

İsteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<PhonePlanGroup, PhonePlanGroup[], PageSettings>

listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

Bir plan grubu için kullanılabilir telefon planını yineler.

Örnek kullanım:

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>

Parametreler

planGroupInfo

ListPhonePlansRequest

options

PageableLocalizationOptions

Döndürülenler

PagedAsyncIterableIterator<PhonePlan, PhonePlan[], PageSettings>

listReleases(PageableOptions)

Azure kaynağı tarafından oluşturulan yayınları yineler.

Örnek kullanım:

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

Azure kaynağı tarafından oluşturulan tüm yayınları alır.

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

Parametreler

options

PageableOptions

Temel alınan HTTP isteği için isteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSearches(PageableOptions)

Azure kaynağı tarafından oluşturulan aramaları yineler.

Örnek kullanım:

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

Azure kaynağı tarafından oluşturulan tüm aramaları alır.

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

Parametreler

options

PageableOptions

Temel alınan HTTP isteği için isteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSupportedCountries(PageableLocalizationOptions)

Desteklenen ülkeleri yineler.

Örnek kullanım:

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>

Parametreler

options

PageableLocalizationOptions

İsteğe bağlı parametreler.

Döndürülenler

PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

unconfigurePhoneNumber(string, OperationOptions)

Bir telefon numarasının yapılandırmasını kaldırın ve yapılandırmasını sıfırlayın.

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

Parametreler

phoneNumber

string

Yapılandırılacak Telefon Numarası.

options

OperationOptions

Ek istek seçenekleri.

Döndürülenler

Promise<{ _response: HttpResponse }>

updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

Telefon numaraları listesinin özelliklerini güncelleştirir. Yanıt, oluşturulan güncelleştirme özellikleri isteğinin kimliğini içerir, sonraki getCapabilitiesUpdate çağrıları için bu kimliği unutmayın.

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

Parametreler

phoneNumberCapabilitiesUpdates

PhoneNumberCapabilitiesUpdates

Telefon numaralarının ve yetenek güncellemelerinin bir listesini içeren sözlük.

options

UpdateCapabilitiesOptions

Ek istek seçenekleri.

Döndürülenler

Promise<UpdateNumbersCapabilitiesResponse>