Поделиться через

PhoneNumbersClient class

Пакет:
@azure/communication-phone-numbers

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

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

PhoneNumbersClient(string, KeyCredential, PhoneNumbersClientOptions)

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

Инициализирует новый экземпляр класса PhoneNumberAdministrationClient с помощью строки подключения.
PhoneNumbersClient(string, TokenCredential, PhoneNumbersClientOptions)

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

Методы

beginPurchasePhoneNumbers(string, BeginPurchasePhoneNumbersOptions)

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import {
  PhoneNumbersClient,
  SearchAvailablePhoneNumbersRequest,
} from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const searchRequest: SearchAvailablePhoneNumbersRequest = {
  countryCode: "US",
  phoneNumberType: "tollFree",
  assignmentType: "application",
  capabilities: {
    sms: "outbound",
    calling: "none",
  },
  quantity: 1,
};

const searchPoller = await client.beginSearchAvailablePhoneNumbers(searchRequest);

// The search is underway. Wait to receive searchId.
const { searchId, phoneNumbers } = await searchPoller.pollUntilDone();

const purchasePoller = await client.beginPurchasePhoneNumbers(searchId);

// Purchase is underway.
await purchasePoller.pollUntilDone();
console.log(`Successfully purchased ${phoneNumbers[0]}`);
beginReleasePhoneNumber(string, BeginReleasePhoneNumberOptions)

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const phoneNumberToRelease = "<phone-number-to-release>";

const releasePoller = await client.beginReleasePhoneNumber(phoneNumberToRelease);

// Release is underway.
await releasePoller.pollUntilDone();
console.log("Successfully release phone number.");
beginReservationPurchase(string, BeginReservationPurchaseOptions)

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const reservationId = "<reservation-id>";

const purchasePoller = await client.beginReservationPurchase(reservationId);

// Purchase is underway.
const purchaseResult = await purchasePoller.pollUntilDone();
console.log(`Successfully purchased phone numbers in reservation: ${reservationId}`);

Начинается покупка номеров телефонов в резервации с предоставленным ID.
beginSearchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest, BeginSearchAvailablePhoneNumbersOptions)

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import {
  PhoneNumbersClient,
  SearchAvailablePhoneNumbersRequest,
} from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const searchRequest: SearchAvailablePhoneNumbersRequest = {
  countryCode: "US",
  phoneNumberType: "tollFree",
  assignmentType: "application",
  capabilities: {
    sms: "outbound",
    calling: "none",
  },
  quantity: 1,
};

const searchPoller = await client.beginSearchAvailablePhoneNumbers(searchRequest);

// The search is underway. Wait to receive searchId.
const searchResults = await searchPoller.pollUntilDone();
console.log(`Found phone number: ${searchResults.phoneNumbers[0]}`);
console.log(`searchId: ${searchResults.searchId}`);
beginUpdatePhoneNumberCapabilities(string, PhoneNumberCapabilitiesRequest, BeginUpdatePhoneNumberCapabilitiesOptions)

Запускает обновление возможностей приобретенного номера телефона.

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

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

import { DefaultAzureCredential } from "@azure/identity";
import {
  PhoneNumbersClient,
  PhoneNumberCapabilitiesRequest,
} from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const phoneNumberToUpdate = "<phone-number-to-update>";

// This will update phone number to send and receive sms, but only send calls.
const updateRequest: PhoneNumberCapabilitiesRequest = {
  sms: "inbound+outbound",
  calling: "outbound",
};

const updatePoller = await client.beginUpdatePhoneNumberCapabilities(
  phoneNumberToUpdate,
  updateRequest,
);

// Update is underway.
const { capabilities } = await updatePoller.pollUntilDone();
console.log(`These are the update capabilities: ${capabilities}`);
browseAvailablePhoneNumbers(BrowseAvailableNumbersRequest, BrowseAvailableNumbersOptions)

Просматривает доступные номера телефонов для покупки.

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

import { DefaultAzureCredential } from "@azure/identity";
import {
  PhoneNumbersClient,
  BrowseAvailableNumbersRequest,
} from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const browseAvailableNumberRequest: BrowseAvailableNumbersRequest = {
  countryCode: "US",
  phoneNumberType: "tollFree",
};
const browseAvailableNumbers = await client.browseAvailablePhoneNumbers(
  browseAvailableNumberRequest,
  {
    capabilities: {
      calling: "outbound",
    },
    assignmentType: "application",
  },
);
for (const phoneNumber of browseAvailableNumbers.phoneNumbers) {
  console.log("Found phone number: ", phoneNumber.phoneNumber);
}

Просмотр доступных номеров телефонов
createOrUpdateReservation(CreateOrUpdateReservationRequest, CreateOrUpdateReservationOptions)

Добавляет и удаляет номера телефонов из резервирования с указанным идентификатором. Ответ будет обновленным состоянием резервирования. Номера телефонов можно зарезервировать, включив их в полезные данные. Если число уже находится в резервировании, оно будет игнорироваться. Чтобы удалить номер телефона, задайте явно значение NULL в полезных данных запроса. Эта операция является идемпотентной. Если резервирование с тем же идентификатором уже существует, оно будет обновлено, в противном случае создается новый. Можно обновить только резервирования с состоянием "активный". Обновление резервирования расширяет срок действия резервирования до 15 минут после последнего изменения до 2 часов с момента создания. Частичный успех возможен, в этом случае ответ будет иметь код состояния 207.

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

import { DefaultAzureCredential } from "@azure/identity";
import {
  PhoneNumbersClient,
  BrowseAvailableNumbersRequest,
  AvailablePhoneNumber,
} from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const browseAvailableNumberRequest: BrowseAvailableNumbersRequest = {
  countryCode: "US",
  phoneNumberType: "tollFree",
};

const browseAvailableNumbers = await client.browseAvailablePhoneNumbers(
  browseAvailableNumberRequest,
  {
    capabilities: {
      calling: "outbound",
    },
    assignmentType: "application",
  },
);
const phoneNumbers = browseAvailableNumbers.phoneNumbers;
const phoneNumbersList = [phoneNumbers[0], phoneNumbers[1]];
const reservationResponse = await client.createOrUpdateReservation(
  {
    reservationId: "reservationId",
  },
  {
    add: phoneNumbersList,
  },
);
const numbersWithError: AvailablePhoneNumber[] = [];
for (const number of Object.values(reservationResponse.phoneNumbers || {})) {
  if (number != null && number.status === "error") {
    numbersWithError.push(number);
  }
}
if (numbersWithError.length > 0) {
  console.log("Errors occurred during reservation");
} else {
  console.log("Reservation operation completed without errors.");
}

Создайте или обновите резервацию.
deleteReservation(string, DeleteReservationOptions)

Удаляет резервацию по ее ID.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const reservationId = "<reservation-id>";
await client.deleteReservation(reservationId);

console.log(`Reservation with ID ${reservationId} has been deleted.`);

Удалите резервацию.
getPurchasedPhoneNumber(string, OperationOptions)

Возвращает сведения о приобретенном номере телефона. Включает номер телефона, стоимость, код страны и т. д.
getReservation(string, GetReservationOptions)

Извлекает резервирование с указанным идентификатором, включая все номера телефонов, связанные с ним.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const reservationId = "<reservation-id>";
const reservationResponse = await client.getReservation(reservationId);

console.log(`Phone numbers in reservation: ${reservationResponse.phoneNumbers}`);

Получите бронь.
listAvailableCountries(ListAvailableCountriesOptions)

Выполняет итерацию доступных стран.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const country of client.listAvailableCountries()) {
  console.log("country: ", country.localizedName);
}

Список всех доступных стран.
listAvailableGeographicAreaCodes(string, ListGeographicAreaCodesOptions)

Выполняет итерацию доступных кодов географических областей.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const areaCodeItem of client.listAvailableGeographicAreaCodes("US")) {
  console.log("area code: ", areaCodeItem.areaCode);
}

Список всех доступных кодов географических областей.
listAvailableLocalities(string, ListLocalitiesOptions)

Выполняет итерацию доступных мест.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const locality of client.listAvailableLocalities("US")) {
  console.log("locality: ", locality.localizedName);
}

Список всех доступных мест.
listAvailableMobileAreaCodes(string, ListMobileAreaCodesOptions)

Повторяет доступные коды мобильных телефонов.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const areaCodeItem of client.listAvailableMobileAreaCodes("IE")) {
  console.log("area code: ", areaCodeItem.areaCode);
}

Перечислите все доступные мобильные коды городов.
listAvailableOfferings(string, ListOfferingsOptions)

Выполняет итерацию доступных предложений.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const offering of client.listAvailableOfferings("US")) {
  console.log("phone number type: ", offering.phoneNumberType);
  console.log("cost: ", offering.cost.amount);
}

Список всех доступных предложений.
listAvailableTollFreeAreaCodes(string, ListTollFreeAreaCodesOptions)

Выполняет итерацию доступных кодов Toll-Free областей.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const areaCodeItem of client.listAvailableTollFreeAreaCodes("US")) {
  console.log("area code: ", areaCodeItem.areaCode);
}

Список всех доступных кодов Toll-Free областей.
listPurchasedPhoneNumbers(ListPurchasedPhoneNumbersOptions)

Выполняет итерацию приобретенных номеров телефонов.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const phoneNumbers = client.listPurchasedPhoneNumbers();

for await (const phoneNumber of phoneNumbers) {
  console.log(`The id is the same as the phone number: ${phoneNumber.id}`);
  console.log(`Phone number type is ${phoneNumber.phoneNumberType}`);
}

Список всех приобретенных номеров телефонов.
listReservations(ListReservationOptions)

Повторяет все резервирования телефонных номеров.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const reservation of client.listReservations()) {
  console.log(`Reservation id: ${reservation.id}`);
}

Перечислите все зарезервированные номера телефонов. Обратите внимание, что резервирования не будут заполнены номерами телефонов, связанными с ними.
searchOperatorInformation(string[], SearchOperatorInformationOptions)

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

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

PhoneNumbersClient(string, KeyCredential, PhoneNumbersClientOptions)

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

new PhoneNumbersClient(url: string, credential: KeyCredential, options?: PhoneNumbersClientOptions)

Параметры

url

string

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

credential
KeyCredential

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

options
PhoneNumbersClientOptions

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

PhoneNumbersClient(string, PhoneNumbersClientOptions)

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

new PhoneNumbersClient(connectionString: string, options?: PhoneNumbersClientOptions)

Параметры

connectionString

string

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

options
PhoneNumbersClientOptions

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

PhoneNumbersClient(string, TokenCredential, PhoneNumbersClientOptions)

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

new PhoneNumbersClient(url: string, credential: TokenCredential, options?: PhoneNumbersClientOptions)

Параметры

url

string

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

credential
TokenCredential

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

options
PhoneNumbersClientOptions

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

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

beginPurchasePhoneNumbers(string, BeginPurchasePhoneNumbersOptions)

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import {
  PhoneNumbersClient,
  SearchAvailablePhoneNumbersRequest,
} from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const searchRequest: SearchAvailablePhoneNumbersRequest = {
  countryCode: "US",
  phoneNumberType: "tollFree",
  assignmentType: "application",
  capabilities: {
    sms: "outbound",
    calling: "none",
  },
  quantity: 1,
};

const searchPoller = await client.beginSearchAvailablePhoneNumbers(searchRequest);

// The search is underway. Wait to receive searchId.
const { searchId, phoneNumbers } = await searchPoller.pollUntilDone();

const purchasePoller = await client.beginPurchasePhoneNumbers(searchId);

// Purchase is underway.
await purchasePoller.pollUntilDone();
console.log(`Successfully purchased ${phoneNumbers[0]}`);

function beginPurchasePhoneNumbers(searchId: string, options?: BeginPurchasePhoneNumbersOptions): Promise<PollerLike<PollOperationState<PurchasePhoneNumbersResult>, PurchasePhoneNumbersResult>>

Параметры

searchId

string

Идентификатор поиска для покупки. Возвращено из beginSearchAvailablePhoneNumbers

options
BeginPurchasePhoneNumbersOptions

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

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

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

beginReleasePhoneNumber(string, BeginReleasePhoneNumberOptions)

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const phoneNumberToRelease = "<phone-number-to-release>";

const releasePoller = await client.beginReleasePhoneNumber(phoneNumberToRelease);

// Release is underway.
await releasePoller.pollUntilDone();
console.log("Successfully release phone number.");

function beginReleasePhoneNumber(phoneNumber: string, options?: BeginReleasePhoneNumberOptions): Promise<PollerLike<PollOperationState<ReleasePhoneNumberResult>, ReleasePhoneNumberResult>>

Параметры

phoneNumber

string

Выпущенный номер телефона в формате E.164. Ведущий плюс может быть либо +, либо закодирован как %2B.

options
BeginReleasePhoneNumberOptions

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

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

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

beginReservationPurchase(string, BeginReservationPurchaseOptions)

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const reservationId = "<reservation-id>";

const purchasePoller = await client.beginReservationPurchase(reservationId);

// Purchase is underway.
const purchaseResult = await purchasePoller.pollUntilDone();
console.log(`Successfully purchased phone numbers in reservation: ${reservationId}`);

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

function beginReservationPurchase(reservationId: string, options?: BeginReservationPurchaseOptions): Promise<PollerLike<PollOperationState<PurchasePhoneNumbersResult>, PurchasePhoneNumbersResult>>

Параметры

reservationId

string

Идентификатор резервирования.

options
BeginReservationPurchaseOptions

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

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

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

beginSearchAvailablePhoneNumbers(SearchAvailablePhoneNumbersRequest, BeginSearchAvailablePhoneNumbersOptions)

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

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

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

import { DefaultAzureCredential } from "@azure/identity";
import {
  PhoneNumbersClient,
  SearchAvailablePhoneNumbersRequest,
} from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const searchRequest: SearchAvailablePhoneNumbersRequest = {
  countryCode: "US",
  phoneNumberType: "tollFree",
  assignmentType: "application",
  capabilities: {
    sms: "outbound",
    calling: "none",
  },
  quantity: 1,
};

const searchPoller = await client.beginSearchAvailablePhoneNumbers(searchRequest);

// The search is underway. Wait to receive searchId.
const searchResults = await searchPoller.pollUntilDone();
console.log(`Found phone number: ${searchResults.phoneNumbers[0]}`);
console.log(`searchId: ${searchResults.searchId}`);

function beginSearchAvailablePhoneNumbers(search: SearchAvailablePhoneNumbersRequest, options?: BeginSearchAvailablePhoneNumbersOptions): Promise<PollerLike<PollOperationState<PhoneNumberSearchResult>, PhoneNumberSearchResult>>

Параметры

search
SearchAvailablePhoneNumbersRequest

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

options
BeginSearchAvailablePhoneNumbersOptions

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

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

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

beginUpdatePhoneNumberCapabilities(string, PhoneNumberCapabilitiesRequest, BeginUpdatePhoneNumberCapabilitiesOptions)

Запускает обновление возможностей приобретенного номера телефона.

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

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

import { DefaultAzureCredential } from "@azure/identity";
import {
  PhoneNumbersClient,
  PhoneNumberCapabilitiesRequest,
} from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const phoneNumberToUpdate = "<phone-number-to-update>";

// This will update phone number to send and receive sms, but only send calls.
const updateRequest: PhoneNumberCapabilitiesRequest = {
  sms: "inbound+outbound",
  calling: "outbound",
};

const updatePoller = await client.beginUpdatePhoneNumberCapabilities(
  phoneNumberToUpdate,
  updateRequest,
);

// Update is underway.
const { capabilities } = await updatePoller.pollUntilDone();
console.log(`These are the update capabilities: ${capabilities}`);

function beginUpdatePhoneNumberCapabilities(phoneNumber: string, request: PhoneNumberCapabilitiesRequest, options?: BeginUpdatePhoneNumberCapabilitiesOptions): Promise<PollerLike<PollOperationState<PurchasedPhoneNumber>, PurchasedPhoneNumber>>

Параметры

phoneNumber

string

Обновленный номер телефона в формате E.164. Ведущий плюс может быть либо +, либо закодирован как %2B.

request
PhoneNumberCapabilitiesRequest

Обновленные свойства, которые будут применены к номеру телефона.

options
BeginUpdatePhoneNumberCapabilitiesOptions

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

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

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

browseAvailablePhoneNumbers(BrowseAvailableNumbersRequest, BrowseAvailableNumbersOptions)

Просматривает доступные номера телефонов для покупки.

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

import { DefaultAzureCredential } from "@azure/identity";
import {
  PhoneNumbersClient,
  BrowseAvailableNumbersRequest,
} from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const browseAvailableNumberRequest: BrowseAvailableNumbersRequest = {
  countryCode: "US",
  phoneNumberType: "tollFree",
};
const browseAvailableNumbers = await client.browseAvailablePhoneNumbers(
  browseAvailableNumberRequest,
  {
    capabilities: {
      calling: "outbound",
    },
    assignmentType: "application",
  },
);
for (const phoneNumber of browseAvailableNumbers.phoneNumbers) {
  console.log("Found phone number: ", phoneNumber.phoneNumber);
}

Просмотр доступных номеров телефонов

function browseAvailablePhoneNumbers(request: BrowseAvailableNumbersRequest, options?: BrowseAvailableNumbersOptions): Promise<PhoneNumbersBrowseResult>

Параметры

request
BrowseAvailableNumbersRequest

Параметры запроса для просмотра доступных номеров телефонов.

options
BrowseAvailableNumbersOptions

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

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

Promise<PhoneNumbersBrowseResult>

createOrUpdateReservation(CreateOrUpdateReservationRequest, CreateOrUpdateReservationOptions)

Добавляет и удаляет номера телефонов из резервирования с указанным идентификатором. Ответ будет обновленным состоянием резервирования. Номера телефонов можно зарезервировать, включив их в полезные данные. Если число уже находится в резервировании, оно будет игнорироваться. Чтобы удалить номер телефона, задайте явно значение NULL в полезных данных запроса. Эта операция является идемпотентной. Если резервирование с тем же идентификатором уже существует, оно будет обновлено, в противном случае создается новый. Можно обновить только резервирования с состоянием "активный". Обновление резервирования расширяет срок действия резервирования до 15 минут после последнего изменения до 2 часов с момента создания. Частичный успех возможен, в этом случае ответ будет иметь код состояния 207.

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

import { DefaultAzureCredential } from "@azure/identity";
import {
  PhoneNumbersClient,
  BrowseAvailableNumbersRequest,
  AvailablePhoneNumber,
} from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const browseAvailableNumberRequest: BrowseAvailableNumbersRequest = {
  countryCode: "US",
  phoneNumberType: "tollFree",
};

const browseAvailableNumbers = await client.browseAvailablePhoneNumbers(
  browseAvailableNumberRequest,
  {
    capabilities: {
      calling: "outbound",
    },
    assignmentType: "application",
  },
);
const phoneNumbers = browseAvailableNumbers.phoneNumbers;
const phoneNumbersList = [phoneNumbers[0], phoneNumbers[1]];
const reservationResponse = await client.createOrUpdateReservation(
  {
    reservationId: "reservationId",
  },
  {
    add: phoneNumbersList,
  },
);
const numbersWithError: AvailablePhoneNumber[] = [];
for (const number of Object.values(reservationResponse.phoneNumbers || {})) {
  if (number != null && number.status === "error") {
    numbersWithError.push(number);
  }
}
if (numbersWithError.length > 0) {
  console.log("Errors occurred during reservation");
} else {
  console.log("Reservation operation completed without errors.");
}

Создайте или обновите резервацию.

function createOrUpdateReservation(request: CreateOrUpdateReservationRequest, options?: CreateOrUpdateReservationOptions): Promise<PhoneNumbersReservation>

Параметры

request
CreateOrUpdateReservationRequest

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

options
CreateOrUpdateReservationOptions

Параметры параметров.

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

Promise<PhoneNumbersReservation>

deleteReservation(string, DeleteReservationOptions)

Удаляет резервацию по ее ID.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const reservationId = "<reservation-id>";
await client.deleteReservation(reservationId);

console.log(`Reservation with ID ${reservationId} has been deleted.`);

Удалите резервацию.

function deleteReservation(reservationId: string, options?: DeleteReservationOptions): Promise<void>

Параметры

reservationId

string

Идентификатор резервирования.

options
DeleteReservationOptions

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

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

Promise<void>

getPurchasedPhoneNumber(string, OperationOptions)

Возвращает сведения о приобретенном номере телефона. Включает номер телефона, стоимость, код страны и т. д.

function getPurchasedPhoneNumber(phoneNumber: string, options?: OperationOptions): Promise<PurchasedPhoneNumber>

Параметры

phoneNumber

string

Отформатированный номер телефона E.164 извлекается. Ведущий плюс может быть либо +, либо закодирован как %2B.

options
OperationOptions

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

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

Promise<PurchasedPhoneNumber>

getReservation(string, GetReservationOptions)

Извлекает резервирование с указанным идентификатором, включая все номера телефонов, связанные с ним.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const reservationId = "<reservation-id>";
const reservationResponse = await client.getReservation(reservationId);

console.log(`Phone numbers in reservation: ${reservationResponse.phoneNumbers}`);

Получите бронь.

function getReservation(reservationId: string, options?: GetReservationOptions): Promise<PhoneNumbersReservation>

Параметры

reservationId

string

Идентификатор резервирования.

options
GetReservationOptions

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

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

Promise<PhoneNumbersReservation>

listAvailableCountries(ListAvailableCountriesOptions)

Выполняет итерацию доступных стран.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const country of client.listAvailableCountries()) {
  console.log("country: ", country.localizedName);
}

Список всех доступных стран.

function listAvailableCountries(options?: ListAvailableCountriesOptions): PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

Параметры

options
ListAvailableCountriesOptions

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

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

PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

listAvailableGeographicAreaCodes(string, ListGeographicAreaCodesOptions)

Выполняет итерацию доступных кодов географических областей.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const areaCodeItem of client.listAvailableGeographicAreaCodes("US")) {
  console.log("area code: ", areaCodeItem.areaCode);
}

Список всех доступных кодов географических областей.

function listAvailableGeographicAreaCodes(countryCode: string, options?: ListGeographicAreaCodesOptions): PagedAsyncIterableIterator<PhoneNumberAreaCode, PhoneNumberAreaCode[], PageSettings>

Параметры

countryCode

string

Код страны ISO 3166-2.

options
ListGeographicAreaCodesOptions

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

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

PagedAsyncIterableIterator<PhoneNumberAreaCode, PhoneNumberAreaCode[], PageSettings>

listAvailableLocalities(string, ListLocalitiesOptions)

Выполняет итерацию доступных мест.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const locality of client.listAvailableLocalities("US")) {
  console.log("locality: ", locality.localizedName);
}

Список всех доступных мест.

function listAvailableLocalities(countryCode: string, options?: ListLocalitiesOptions): PagedAsyncIterableIterator<PhoneNumberLocality, PhoneNumberLocality[], PageSettings>

Параметры

countryCode

string

Код страны ISO 3166-2.

options
ListLocalitiesOptions

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

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

PagedAsyncIterableIterator<PhoneNumberLocality, PhoneNumberLocality[], PageSettings>

listAvailableMobileAreaCodes(string, ListMobileAreaCodesOptions)

Повторяет доступные коды мобильных телефонов.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const areaCodeItem of client.listAvailableMobileAreaCodes("IE")) {
  console.log("area code: ", areaCodeItem.areaCode);
}

Перечислите все доступные мобильные коды городов.

function listAvailableMobileAreaCodes(countryCode: string, options?: ListMobileAreaCodesOptions): PagedAsyncIterableIterator<PhoneNumberAreaCode, PhoneNumberAreaCode[], PageSettings>

Параметры

countryCode

string

Код страны ISO 3166-2.

options
ListMobileAreaCodesOptions

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

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

PagedAsyncIterableIterator<PhoneNumberAreaCode, PhoneNumberAreaCode[], PageSettings>

listAvailableOfferings(string, ListOfferingsOptions)

Выполняет итерацию доступных предложений.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const offering of client.listAvailableOfferings("US")) {
  console.log("phone number type: ", offering.phoneNumberType);
  console.log("cost: ", offering.cost.amount);
}

Список всех доступных предложений.

function listAvailableOfferings(countryCode: string, options?: ListOfferingsOptions): PagedAsyncIterableIterator<PhoneNumberOffering, PhoneNumberOffering[], PageSettings>

Параметры

countryCode

string

Код страны ISO 3166-2.

options
ListOfferingsOptions

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

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

PagedAsyncIterableIterator<PhoneNumberOffering, PhoneNumberOffering[], PageSettings>

listAvailableTollFreeAreaCodes(string, ListTollFreeAreaCodesOptions)

Выполняет итерацию доступных кодов Toll-Free областей.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const areaCodeItem of client.listAvailableTollFreeAreaCodes("US")) {
  console.log("area code: ", areaCodeItem.areaCode);
}

Список всех доступных кодов Toll-Free областей.

function listAvailableTollFreeAreaCodes(countryCode: string, options?: ListTollFreeAreaCodesOptions): PagedAsyncIterableIterator<PhoneNumberAreaCode, PhoneNumberAreaCode[], PageSettings>

Параметры

countryCode

string

Код страны ISO 3166-2.

options
ListTollFreeAreaCodesOptions

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

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

PagedAsyncIterableIterator<PhoneNumberAreaCode, PhoneNumberAreaCode[], PageSettings>

listPurchasedPhoneNumbers(ListPurchasedPhoneNumbersOptions)

Выполняет итерацию приобретенных номеров телефонов.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

const phoneNumbers = client.listPurchasedPhoneNumbers();

for await (const phoneNumber of phoneNumbers) {
  console.log(`The id is the same as the phone number: ${phoneNumber.id}`);
  console.log(`Phone number type is ${phoneNumber.phoneNumberType}`);
}

Список всех приобретенных номеров телефонов.

function listPurchasedPhoneNumbers(options?: ListPurchasedPhoneNumbersOptions): PagedAsyncIterableIterator<PurchasedPhoneNumber, PurchasedPhoneNumber[], PageSettings>

Параметры

options
ListPurchasedPhoneNumbersOptions

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

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

PagedAsyncIterableIterator<PurchasedPhoneNumber, PurchasedPhoneNumber[], PageSettings>

listReservations(ListReservationOptions)

Повторяет все резервирования телефонных номеров.

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

import { DefaultAzureCredential } from "@azure/identity";
import { PhoneNumbersClient } from "@azure/communication-phone-numbers";

const credential = new DefaultAzureCredential();
const client = new PhoneNumbersClient("<endpoint-from-resource>", credential);

for await (const reservation of client.listReservations()) {
  console.log(`Reservation id: ${reservation.id}`);
}

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

function listReservations(options?: ListReservationOptions): PagedAsyncIterableIterator<PhoneNumbersReservation, PhoneNumbersReservation[], PageSettings>

Параметры

options
ListReservationOptions

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

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

PagedAsyncIterableIterator<PhoneNumbersReservation, PhoneNumbersReservation[], PageSettings>

searchOperatorInformation(string[], SearchOperatorInformationOptions)

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

function searchOperatorInformation(phoneNumbers: string[], options?: SearchOperatorInformationOptions): Promise<OperatorInformationResult>

Параметры

phoneNumbers

string[]

Номера телефонов для поиска.

options
SearchOperatorInformationOptions

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

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

Promise<OperatorInformationResult>