PhoneNumberAdministrationClient class

Pacote:

@azure/communication-administration

Classe de cliente para interagir com a Administração de Número de Telefone dos Serviços de Comunicação do Azure.

Construtores

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)	Inicializa uma nova instância da classe PhoneNumberAdministrationClient usando uma KeyCredential do Azure.
PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)	Inicializa uma nova instância da classe PhoneNumberAdministrationClient.
PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)	Inicializa uma nova instância da classe PhoneNumberAdministrationClient usando um TokenCredential.

Métodos

beginPurchaseReservation(string, BeginPurchaseReservationOptions)	Inicia a compra do(s) número(s) de telefone na reserva associado a um determinado ID. Esta função retorna um poller de operação de longa duração que permite que você aguarde indefinidamente até que a operação seja concluída. Exemplo de uso: 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)	Inicia o lançamento de uma lista de números de telefone adquiridos. Esta função retorna um poller de operação de longa duração que permite que você aguarde indefinidamente até que a operação seja concluída. Exemplo de uso: 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)	Inicia uma pesquisa por números de telefone com algumas restrições, como nome ou código de área. Os números de telefone encontrados são reservados até que você cancele, compre ou a reserva expire. Esta função retorna um poller de operação de longa duração que permite que você aguarde indefinidamente até que a operação seja concluída. Exemplo de uso: 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)	Cancela a reserva associada a um determinado ID.
configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)	Configura um número de telefone, por exemplo, para atribuir um callbackUrl.
getAreaCodes(GetAreaCodesRequest, OperationOptions)	Obtém uma lista dos códigos de área suportados com base na localização.
getCapabilitiesUpdate(string, OperationOptions)	Obtenha a solicitação de recursos de atualização associada a uma determinada id.
getPhoneNumberConfiguration(string, OperationOptions)	Obtém a configuração para um determinado número de telefone.
getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)	Obtém as opções de localização para um determinado plano de telefone.
getReservation(string, OperationOptions)	Obtém a reserva associada a um determinado id. Use esta função para consultar o status de uma reserva de número de telefone.
listPhoneNumbers(PageableLocalizationOptions)	Itera os números de telefone adquiridos. Exemplo de uso: let client = new PhoneNumberAdministrationClient(credentials); for await (const acquired of client.listPhoneNumbers()) { console.log("phone number: ", acquired.phoneNumber); }
listPhonePlanGroups(string, ListPhonePlanGroupsOptions)	Itera os grupos de planos telefónicos disponíveis para um país. Exemplo de uso: let client = new PhoneNumberAdministrationClient(credentials); for await (const phonePlanGroup of client.listPhonePlanGroups("CA")) { console.log("plan group id: ", phonePlanGroup.phonePlanGroupId); }
listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)	Itera o plano de telefone disponível para um grupo de planos. Exemplo de uso: 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)	Itera as versões criadas pelo recurso do Azure. Exemplo de uso: let client = new PhoneNumberAdministrationClient(credentials); for await (const entity of client.listReleases()) { console.log("id: ", entity.id); } Obtém todas as versões criadas pelo recurso do Azure.
listSearches(PageableOptions)	Itera as pesquisas criadas pelo recurso do Azure. Exemplo de uso: let client = new PhoneNumberAdministrationClient(credentials); for await (const entity of client.listSearches()) { console.log("id: ", entity.id); } Obtém todas as pesquisas criadas pelo recurso do Azure.
listSupportedCountries(PageableLocalizationOptions)	Itera os países suportados. Exemplo de uso: let client = new PhoneNumberAdministrationClient(credentials); for await (const country of client.listSupportedCountries()) { console.log("country name: ", country.localizedName); }
unconfigurePhoneNumber(string, OperationOptions)	Desconfigure um número de telefone, redefinindo sua configuração.
updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)	Atualiza os recursos de uma lista de números de telefone. A resposta inclui a id da solicitação de recursos de atualização criada, lembre-se dessa id para chamadas subsequentes para getCapabilitiesUpdate.

Detalhes do Construtor

PhoneNumberAdministrationClient(string, KeyCredential, PhoneNumberAdministrationClientOptions)

Inicializa uma nova instância da classe PhoneNumberAdministrationClient usando uma KeyCredential do Azure.

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

Parâmetros

url

string

O ponto de extremidade do serviço (por exemplo: https://contoso.eastus.communications.azure.net).

credential

KeyCredential

Um objeto que é usado para autenticar solicitações para o serviço. Use o Azure KeyCredential ou @azure/identity para criar uma credencial.

options

PhoneNumberAdministrationClientOptions

Opcional. Opções para configurar o pipeline HTTP.

PhoneNumberAdministrationClient(string, PhoneNumberAdministrationClientOptions)

Inicializa uma nova instância da classe PhoneNumberAdministrationClient.

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

Parâmetros

connectionString

string

Cadeia de conexão para se conectar a um recurso do Serviço de Comunicação do Azure. Exemplo: "endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options

PhoneNumberAdministrationClientOptions

Opcional. Opções para configurar o pipeline HTTP.

PhoneNumberAdministrationClient(string, TokenCredential, PhoneNumberAdministrationClientOptions)

Inicializa uma nova instância da classe PhoneNumberAdministrationClient usando um TokenCredential.

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

Parâmetros

url

string

O ponto de extremidade do serviço (por exemplo: https://contoso.eastus.communications.azure.net).

credential

TokenCredential

TokenCredential que é usado para autenticar solicitações para o serviço.

options

PhoneNumberAdministrationClientOptions

Opcional. Opções para configurar o pipeline HTTP.

Detalhes de Método

beginPurchaseReservation(string, BeginPurchaseReservationOptions)

Inicia a compra do(s) número(s) de telefone na reserva associado a um determinado ID.

Esta função retorna um poller de operação de longa duração que permite que você aguarde indefinidamente até que a operação seja concluída.

Exemplo de uso:

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

Parâmetros

reservationId

string

O id da reserva para compra.

options

BeginPurchaseReservationOptions

Opções de solicitação adicionais.

Devoluções

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

beginReleasePhoneNumbers(string[], BeginReleasePhoneNumbersOptions)

Inicia o lançamento de uma lista de números de telefone adquiridos.

Esta função retorna um poller de operação de longa duração que permite que você aguarde indefinidamente até que a operação seja concluída.

Exemplo de uso:

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

Parâmetros

phoneNumbers

string[]

Os números de telefone a serem divulgados.

options

BeginReleasePhoneNumbersOptions

Opções de solicitação adicionais.

Devoluções

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

beginReservePhoneNumbers(CreateReservationRequest, BeginReservePhoneNumbersOptions)

Inicia uma pesquisa por números de telefone com algumas restrições, como nome ou código de área. Os números de telefone encontrados são reservados até que você cancele, compre ou a reserva expire.

Esta função retorna um poller de operação de longa duração que permite que você aguarde indefinidamente até que a operação seja concluída.

Exemplo de uso:

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

Parâmetros

reservationRequest

CreateReservationRequest

Solicite propriedades para restringir o escopo da pesquisa.

options

BeginReservePhoneNumbersOptions

Opções de solicitação adicionais.

Devoluções

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

cancelReservation(string, OperationOptions)

Cancela a reserva associada a um determinado ID.

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

Parâmetros

reservationId

string

O id da reserva retornado por createReservation.

options

OperationOptions

Opções de solicitação adicionais.

Devoluções

Promise<{ _response: HttpResponse }>

configurePhoneNumber(ConfigurePhoneNumberRequest, ConfigurePhoneNumberOptions)

Configura um número de telefone, por exemplo, para atribuir um callbackUrl.

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

Parâmetros

config

ConfigurePhoneNumberRequest

Os detalhes da configuração

options

ConfigurePhoneNumberOptions

Opções de solicitação adicionais.

Devoluções

Promise<{ _response: HttpResponse }>

getAreaCodes(GetAreaCodesRequest, OperationOptions)

Obtém uma lista dos códigos de área suportados com base na localização.

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

Parâmetros

request

GetAreaCodesRequest

Solicite propriedades para restringir o escopo da pesquisa.

options

OperationOptions

Opções de solicitação adicionais.

Devoluções

Promise<GetAreaCodesResponse>

getCapabilitiesUpdate(string, OperationOptions)

Obtenha a solicitação de recursos de atualização associada a uma determinada id.

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

Parâmetros

capabilitiesUpdateId

string

O id associado à solicitação.

options

OperationOptions

Opções de solicitação adicionais.

Devoluções

Promise<GetCapabilitiesUpdateResponse>

getPhoneNumberConfiguration(string, OperationOptions)

Obtém a configuração para um determinado número de telefone.

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

Parâmetros

phoneNumber

string

A representação E.164 do número de telefone cuja configuração é solicitada.

options

OperationOptions

Opções de solicitação adicionais.

Devoluções

Promise<GetPhoneNumberConfigurationResponse>

getPhonePlanLocationOptions(GetPhonePlanLocationOptionsRequest, PageableLocalizationOptions)

Obtém as opções de localização para um determinado plano de telefone.

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

Parâmetros

request

GetPhonePlanLocationOptionsRequest

Solicite propriedades para restringir o escopo da pesquisa.

options

PageableLocalizationOptions

Opções de solicitação adicionais.

Devoluções

Promise<GetPhonePlanLocationOptionsResponse>

getReservation(string, OperationOptions)

Obtém a reserva associada a um determinado id. Use esta função para consultar o status de uma reserva de número de telefone.

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

Parâmetros

reservationId

string

O id da reserva retornado por createReservation.

options

OperationOptions

Opções de solicitação adicionais.

Devoluções

Promise<GetReservationResponse>

listPhoneNumbers(PageableLocalizationOptions)

Itera os números de telefone adquiridos.

Exemplo de uso:

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>

Parâmetros

options

PageableLocalizationOptions

Os parâmetros opcionais.

Devoluções

PagedAsyncIterableIterator<AcquiredPhoneNumber, AcquiredPhoneNumber[], PageSettings>

listPhonePlanGroups(string, ListPhonePlanGroupsOptions)

Itera os grupos de planos telefónicos disponíveis para um país.

Exemplo de uso:

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>

Parâmetros

countryCode

string

options

ListPhonePlanGroupsOptions

Os parâmetros opcionais.

Devoluções

PagedAsyncIterableIterator<PhonePlanGroup, PhonePlanGroup[], PageSettings>

listPhonePlans(ListPhonePlansRequest, PageableLocalizationOptions)

Itera o plano de telefone disponível para um grupo de planos.

Exemplo de uso:

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>

Parâmetros

planGroupInfo

ListPhonePlansRequest

options

PageableLocalizationOptions

Devoluções

PagedAsyncIterableIterator<PhonePlan, PhonePlan[], PageSettings>

listReleases(PageableOptions)

Itera as versões criadas pelo recurso do Azure.

Exemplo de uso:

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

Obtém todas as versões criadas pelo recurso do Azure.

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

Parâmetros

options

PageableOptions

Parâmetros opcionais para a solicitação HTTP subjacente.

Devoluções

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSearches(PageableOptions)

Itera as pesquisas criadas pelo recurso do Azure.

Exemplo de uso:

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

Obtém todas as pesquisas criadas pelo recurso do Azure.

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

Parâmetros

options

PageableOptions

Parâmetros opcionais para a solicitação HTTP subjacente.

Devoluções

PagedAsyncIterableIterator<PhoneNumberEntity, PhoneNumberEntity[], PageSettings>

listSupportedCountries(PageableLocalizationOptions)

Itera os países suportados.

Exemplo de uso:

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>

Parâmetros

options

PageableLocalizationOptions

Os parâmetros opcionais.

Devoluções

PagedAsyncIterableIterator<PhoneNumberCountry, PhoneNumberCountry[], PageSettings>

unconfigurePhoneNumber(string, OperationOptions)

Desconfigure um número de telefone, redefinindo sua configuração.

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

Parâmetros

phoneNumber

string

Número de telefone para desconfigurar.

options

OperationOptions

Opções de solicitação adicionais.

Devoluções

Promise<{ _response: HttpResponse }>

updatePhoneNumbersCapabilities(PhoneNumberCapabilitiesUpdates, UpdateCapabilitiesOptions)

Atualiza os recursos de uma lista de números de telefone. A resposta inclui a id da solicitação de recursos de atualização criada, lembre-se dessa id para chamadas subsequentes para getCapabilitiesUpdate.

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

Parâmetros

phoneNumberCapabilitiesUpdates

PhoneNumberCapabilitiesUpdates

Dicionário contendo uma lista de números de telefone e suas atualizações de recursos.

options

UpdateCapabilitiesOptions

Opções de solicitação adicionais.

Devoluções

Promise<UpdateNumbersCapabilitiesResponse>