다음을 통해 공유

PhoneNumbersClient class

패키지:
@azure/communication-phone-numbers

Azure Communication Services 전화 번호 관리와 상호 작용하기 위한 클라이언트 클래스입니다.

생성자

PhoneNumbersClient(string, KeyCredential, PhoneNumbersClientOptions)

Azure KeyCredential을 사용하여 PhoneNumberAdministrationClient 클래스의 새 인스턴스를 초기화합니다.
PhoneNumbersClient(string, PhoneNumbersClientOptions)

연결 문자열을 사용하여 PhoneNumberAdministrationClient 클래스의 새 인스턴스를 초기화합니다.
PhoneNumbersClient(string, TokenCredential, PhoneNumbersClientOptions)

TokenCredential을 사용하여 PhoneNumberAdministrationClient 클래스의 새 인스턴스를 초기화합니다.

메서드

beginPurchasePhoneNumbers(string, BeginPurchasePhoneNumbersOptions)

지정된 ID와 연결된 검색에서 전화 번호 구매를 시작합니다.

이 함수는 작업이 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예:

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)

지정된 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>";

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)

지정된 ID를 사용하여 예약에서 전화 번호를 추가하고 제거합니다. 응답은 예약의 업데이트된 상태가 됩니다. 전화 번호는 페이로드에 포함하여 예약할 수 있습니다. 예약에 이미 있는 숫자가 있으면 무시됩니다. 전화 번호를 제거하려면 요청 페이로드에서 명시적으로 null로 설정합니다. 이 작업은 idempotent입니다. ID가 동일한 예약이 이미 있는 경우 업데이트되고, 그렇지 않으면 새 예약이 만들어집니다. '활성' 상태의 예약만 업데이트할 수 있습니다. 예약을 업데이트하면 예약의 만료 시간이 마지막 변경 후 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)

연결된 모든 전화 번호를 포함하여 지정된 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>";
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)

Azure KeyCredential을 사용하여 PhoneNumberAdministrationClient 클래스의 새 인스턴스를 초기화합니다.

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 Communication Service 리소스에 연결할 연결 문자열입니다. (예: 엔드포인트=https://contoso.eastus.communications.azure.net/; accesskey=secret)

options
PhoneNumbersClientOptions

선택적. HTTP 파이프라인을 구성하는 옵션입니다.

PhoneNumbersClient(string, TokenCredential, PhoneNumbersClientOptions)

TokenCredential을 사용하여 PhoneNumberAdministrationClient 클래스의 새 인스턴스를 초기화합니다.

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)

지정된 ID와 연결된 검색에서 전화 번호 구매를 시작합니다.

이 함수는 작업이 완료될 때까지 무기한 대기할 수 있는 장기 실행 작업 폴러를 반환합니다.

사용 예:

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

구매할 검색의 ID입니다. 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)

지정된 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>";

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

예약의 ID입니다.

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)

지정된 ID를 사용하여 예약에서 전화 번호를 추가하고 제거합니다. 응답은 예약의 업데이트된 상태가 됩니다. 전화 번호는 페이로드에 포함하여 예약할 수 있습니다. 예약에 이미 있는 숫자가 있으면 무시됩니다. 전화 번호를 제거하려면 요청 페이로드에서 명시적으로 null로 설정합니다. 이 작업은 idempotent입니다. ID가 동일한 예약이 이미 있는 경우 업데이트되고, 그렇지 않으면 새 예약이 만들어집니다. '활성' 상태의 예약만 업데이트할 수 있습니다. 예약을 업데이트하면 예약의 만료 시간이 마지막 변경 후 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

예약의 ID입니다.

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)

연결된 모든 전화 번호를 포함하여 지정된 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>";
const reservationResponse = await client.getReservation(reservationId);

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

예약을 받으세요.

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

매개 변수

reservationId

string

예약의 ID입니다.

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>