다음을 통해 공유

PhoneNumberAdministrationClient class

패키지:
@azure/communication-administration

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

생성자

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

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

PhoneNumberAdministrationClient 클래스의 새 인스턴스를 초기화합니다.
PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

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

메서드

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

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

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

사용 예:

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)

지정된 ID와 연결된 예약을 취소합니다.
configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

예를 들어 callbackUrl을 할당하기 위해 전화 번호를 구성합니다.
getAreaCodes(GetAreaCodesRequest, OperationOptions)

위치에 따라 지원되는 지역 번호 목록을 가져옵니다.
getCapabilitiesUpdate(string, OperationOptions)

지정된 ID와 연결된 업데이트 기능 요청을 가져옵니다.
getPhoneNumberConfiguration(string, OperationOptions)

지정된 전화 번호에 대한 구성을 가져옵니다.
getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

지정된 전화 요금제에 대한 위치 옵션을 가져옵니다.
getReservation(string, OperationOptions)

지정된 ID와 연결된 예약을 가져옵니다. 이 함수를 사용하여 전화 번호 예약의 상태를 쿼리합니다.
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)

전화 번호 목록에 대한 기능을 업데이트합니다. 응답에는 생성된 업데이트 기능 요청의 ID가 포함되며, getCapabilitiesUpdate에 대한 후속 호출에 대해 해당 ID를 기억하십시오.

생성자 세부 정보

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

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

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

options
PhoneNumberAdministrationClientOptions

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

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

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

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)

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

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

사용 예:

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

구매할 예약의 ID입니다.

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)

지정된 ID와 연결된 예약을 취소합니다.

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

매개 변수

reservationId

string

createReservation에서 반환된 예약의 ID입니다.

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)

지정된 ID와 연결된 업데이트 기능 요청을 가져옵니다.

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

매개 변수

capabilitiesUpdateId

string

요청과 연결된 ID입니다.

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)

지정된 ID와 연결된 예약을 가져옵니다. 이 함수를 사용하여 전화 번호 예약의 상태를 쿼리합니다.

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

매개 변수

reservationId

string

createReservation에서 반환된 예약의 ID입니다.

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)

전화 번호 목록에 대한 기능을 업데이트합니다. 응답에는 생성된 업데이트 기능 요청의 ID가 포함되며, getCapabilitiesUpdate에 대한 후속 호출에 대해 해당 ID를 기억하십시오.

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

매개 변수

phoneNumberCapabilitiesUpdates
PhoneNumberCapabilitiesUpdates

전화 번호 목록과 해당 기능 업데이트가 포함된 사전입니다.

options
UpdateCapabilitiesOptions

추가 요청 옵션입니다.

반환

Promise<UpdateNumbersCapabilitiesResponse>