PhoneNumberAdministrationClient class

Пакет:
@azure/communication-administration

Класс клиента для взаимодействия с администрированием телефонных номеров Служб коммуникации Azure.

Конструкторы

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

Инициализирует новый экземпляр класса PhoneNumberAdministrationClient с помощью Azure KeyCredential.
PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

Инициализирует новый экземпляр класса PhoneNumberAdministrationClient.
PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

Инициализирует новый экземпляр класса PhoneNumberAdministrationClient с помощью TokenCredential.

Методы

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

Начинает покупку номера телефона в резервации, связанной с данным идентификатором.

Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время до завершения операции.

Пример использования:

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)

Запускает выпуск списка полученных телефонных номеров.

Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время до завершения операции.

Пример использования:

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)

Запускает поиск номеров телефонов с учетом некоторых ограничений, таких как имя или код области. Найденные номера телефонов зарезервированы до тех пор, пока не будет отменена, покупка или срок действия резервирования.

Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время до завершения операции.

Пример использования:

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)

Отменяет бронирование, связанное с заданным идентификатором.
configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

Настраивает номер телефона, например, для назначения callbackUrl.
getAreaCodes(GetAreaCodesRequest, OperationOptions)

Получает список поддерживаемых кодов городов в зависимости от местоположения.
getCapabilitiesUpdate(string, OperationOptions)

Получите запрос на возможности обновления, связанный с заданным идентификатором.
getPhoneNumberConfiguration(string, OperationOptions)

Получает конфигурацию для заданного номера телефона.
getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

Получает варианты местоположения для заданного тарифного плана.
getReservation(string, OperationOptions)

Получает резервирование, связанное с заданным идентификатором. Используйте эту функцию для запроса статуса резервированного номера телефона.
listPhoneNumbers(PageableLocalizationOptions)

Перебирает полученные телефонные номера.

Пример использования:

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

Итерация доступных групп тарифных планов для страны.

Пример использования:

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

Итерация доступного тарифного плана для группы планов.

Пример использования:

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.

Пример использования:

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

Получает все выпуски, созданные ресурсом Azure.
listSearches(PageableOptions)

Выполняет итерации поисковых запросов, созданных ресурсом Azure.

Пример использования:

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

Получает все поисковые запросы, созданные ресурсом Azure.
listSupportedCountries(PageableLocalizationOptions)

Перебирает поддерживаемые страны.

Пример использования:

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

Отключите телефонный номер, сбросив его конфигурацию.
updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

Обновляет возможности для списка телефонных номеров. Ответ включает в себя идентификатор созданного запроса на обновление возможностей, запомните этот идентификатор для последующих вызовов getCapabilitiesUpdate.

Сведения о конструкторе

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

Инициализирует новый экземпляр класса PhoneNumberAdministrationClient с помощью Azure KeyCredential.

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

Параметры

url

string

Конечная точка службы (например, https://contoso.eastus.communications.azure.net).

credential
KeyCredential

Объект, используемый для проверки подлинности запросов к службе. Используйте Azure KeyCredential или @azure/identity для создания учетных данных.

options
PhoneNumberAdministrationClientOptions

Необязательно. Параметры настройки конвейера HTTP.

PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

Инициализирует новый экземпляр класса PhoneNumberAdministrationClient.

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

Параметры

connectionString

string

Строка подключения для подключения к ресурсу Службы коммуникации Azure. Пример: endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options
PhoneNumberAdministrationClientOptions

Необязательно. Параметры настройки конвейера HTTP.

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

Инициализирует новый экземпляр класса PhoneNumberAdministrationClient с помощью TokenCredential.

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

Параметры

url

string

Конечная точка службы (например, https://contoso.eastus.communications.azure.net).

credential
TokenCredential

TokenCredential, используемый для проверки подлинности запросов к службе.

options
PhoneNumberAdministrationClientOptions

Необязательно. Параметры настройки конвейера HTTP.

Сведения о методе

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

Начинает покупку номера телефона в резервации, связанной с данным идентификатором.

Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время до завершения операции.

Пример использования:

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

Параметры

reservationId

string

Идентификатор брони для покупки.

options
BeginPurchaseReservationOptions

Дополнительные параметры запроса.

Возвращаемое значение

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

beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

Запускает выпуск списка полученных телефонных номеров.

Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время до завершения операции.

Пример использования:

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

Параметры

phoneNumbers

string[]

Номера телефонов будут разглашены.

options
BeginReleasePhoneNumbersOptions

Дополнительные параметры запроса.

Возвращаемое значение

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

beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

Запускает поиск номеров телефонов с учетом некоторых ограничений, таких как имя или код области. Найденные номера телефонов зарезервированы до тех пор, пока не будет отменена, покупка или срок действия резервирования.

Эта функция возвращает средство опроса длительных операций, которое позволяет ждать неограниченное время до завершения операции.

Пример использования:

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

Параметры

reservationRequest
CreateReservationRequest

Запрос свойств для ограничения области поиска.

options
BeginReservePhoneNumbersOptions

Дополнительные параметры запроса.

Возвращаемое значение

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

cancelReservation(string, OperationOptions)

Отменяет бронирование, связанное с заданным идентификатором.

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

Параметры

reservationId

string

Идентификатор резервирования, возвращенный createReservation.

options
OperationOptions

Дополнительные параметры запроса.

Возвращаемое значение

Promise<{ _response: HttpResponse }>

configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

Настраивает номер телефона, например, для назначения callbackUrl.

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

Параметры

config
ConfigurePhoneNumberRequest

Детали конфигурации

options
ConfigurePhoneNumberOptions

Дополнительные параметры запроса.

Возвращаемое значение

Promise<{ _response: HttpResponse }>

getAreaCodes(GetAreaCodesRequest, OperationOptions)

Получает список поддерживаемых кодов городов в зависимости от местоположения.

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

Параметры

request
GetAreaCodesRequest

Запрос свойств для ограничения области поиска.

options
OperationOptions

Дополнительные параметры запроса.

Возвращаемое значение

Promise<GetAreaCodesResponse>

getCapabilitiesUpdate(string, OperationOptions)

Получите запрос на возможности обновления, связанный с заданным идентификатором.

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

Параметры

capabilitiesUpdateId

string

Идентификатор, связанный с запросом.

options
OperationOptions

Дополнительные параметры запроса.

Возвращаемое значение

Promise<GetCapabilitiesUpdateResponse>

getPhoneNumberConfiguration(string, OperationOptions)

Получает конфигурацию для заданного номера телефона.

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

Параметры

phoneNumber

string

Представление E.164 номера телефона, конфигурация которого запрашивается.

options
OperationOptions

Дополнительные параметры запроса.

Возвращаемое значение

Promise<GetPhoneNumberConfigurationResponse>

getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

Получает варианты местоположения для заданного тарифного плана.

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

Параметры

request
GetPhonePlanLocationOptionsRequest

Запрос свойств для ограничения области поиска.

options
PageableLocalizationOptions

Дополнительные параметры запроса.

Возвращаемое значение

Promise<GetPhonePlanLocationOptionsResponse>

getReservation(string, OperationOptions)

Получает резервирование, связанное с заданным идентификатором. Используйте эту функцию для запроса статуса резервированного номера телефона.

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

Параметры

reservationId

string

Идентификатор резервирования, возвращенный createReservation.

options
OperationOptions

Дополнительные параметры запроса.

Возвращаемое значение

Promise<GetReservationResponse>

listPhoneNumbers(PageableLocalizationOptions)

Перебирает полученные телефонные номера.

Пример использования:

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>

Параметры

options
PageableLocalizationOptions

Необязательные параметры.

Возвращаемое значение

PagedAsyncIterableIterator<AcquiredPhoneNumber, AcquiredPhoneNumber[], PageSettings>

listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

Итерация доступных групп тарифных планов для страны.

Пример использования:

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>

Параметры

countryCode

string

options
ListPhonePlanGroupsOptions

Необязательные параметры.

Возвращаемое значение

PagedAsyncIterableIterator<PhonePlanGroup, PhonePlanGroup[], PageSettings>

listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

Итерация доступного тарифного плана для группы планов.

Пример использования:

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>

Параметры

planGroupInfo
ListPhonePlansRequest
options
PageableLocalizationOptions

Возвращаемое значение

PagedAsyncIterableIterator<PhonePlan, PhonePlan[], PageSettings>

listReleases(PageableOptions)

Итерация выпусков, созданных ресурсом Azure.

Пример использования:

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

Получает все выпуски, созданные ресурсом Azure.

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

Параметры

options
PageableOptions

Необязательные параметры для базового HTTP-запроса.

Возвращаемое значение

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSearches(PageableOptions)

Выполняет итерации поисковых запросов, созданных ресурсом Azure.

Пример использования:

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

Получает все поисковые запросы, созданные ресурсом Azure.

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

Параметры

options
PageableOptions

Необязательные параметры для базового HTTP-запроса.

Возвращаемое значение

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSupportedCountries(PageableLocalizationOptions)

Перебирает поддерживаемые страны.

Пример использования:

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>

Параметры

options
PageableLocalizationOptions

Необязательные параметры.

Возвращаемое значение

PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

unconfigurePhoneNumber(string, OperationOptions)

Отключите телефонный номер, сбросив его конфигурацию.

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

Параметры

phoneNumber

string

Номер телефона для отмены.

options
OperationOptions

Дополнительные параметры запроса.

Возвращаемое значение

Promise<{ _response: HttpResponse }>

updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

Обновляет возможности для списка телефонных номеров. Ответ включает в себя идентификатор созданного запроса на обновление возможностей, запомните этот идентификатор для последующих вызовов getCapabilitiesUpdate.

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

Параметры

phoneNumberCapabilitiesUpdates
PhoneNumberCapabilitiesUpdates

Словарь, содержащий список телефонных номеров и обновления их возможностей.

options
UpdateCapabilitiesOptions

Дополнительные параметры запроса.

Возвращаемое значение

Promise<UpdateNumbersCapabilitiesResponse>