Phone Numbers - Search Available Phone Numbers

Referência

Serviço:: Communication

Versão da API:: 2025-02-11

Pesquise números de telefone disponíveis para compra.

POST {endpoint}/availablePhoneNumbers/countries/{countryCode}/:search?api-version=2025-02-11

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
countryCode	path	True	string	O código de país ISO 3166-2, por exemplo, EUA.
endpoint	path	True	string url	O recurso de comunicação, por exemplo, https://resourcename.communication.azure.com
api-version	query	True	string	Versão da API a ser invocada

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
assignmentType	True	PhoneNumberAssignmentType	O tipo de atribuição dos números de telefone a serem pesquisados. Um número de telefone pode ser atribuído a uma pessoa ou a um aplicativo.
capabilities	True	PhoneNumberCapabilities	Funcionalidades de um número de telefone.
phoneNumberType	True	PhoneNumberType	O tipo de números de telefone a serem pesquisados, por exemplo, geográfico ou tollFree.
areaCode		string	O código de área do número de telefone desejado, por exemplo, 425.
quantity		integer	A quantidade de números de telefone desejados. O valor padrão é 1.

Respostas

Nome	Tipo	Description
202 Accepted	PhoneNumberSearchResult	O serviço aceitou a solicitação e iniciará o processamento posteriormente. Ele retornará "Aceito" imediatamente e incluirá cabeçalhos 'Operation-Location' e 'Location'. O lado do cliente deve consultar ainda mais o status da operação usando a URL especificada no cabeçalho 'Operation-Location'. Quando a operação for concluída, consulte com êxito o resultado final usando a URL especificada no cabeçalho 'Location'. Cabeçalhos Location: string Operation-Location: string operation-id: string search-id: string
Other Status Codes	CommunicationErrorResponse	Fracasso

Nome

Tipo

Description

202 Accepted

PhoneNumberSearchResult

O serviço aceitou a solicitação e iniciará o processamento posteriormente. Ele retornará "Aceito" imediatamente e incluirá cabeçalhos 'Operation-Location' e 'Location'. O lado do cliente deve consultar ainda mais o status da operação usando a URL especificada no cabeçalho 'Operation-Location'. Quando a operação for concluída, consulte com êxito o resultado final usando a URL especificada no cabeçalho 'Location'.

Cabeçalhos

Location: string
Operation-Location: string
operation-id: string
search-id: string

Other Status Codes

CommunicationErrorResponse

Fracasso

Exemplos

Search for phone numbers

Solicitação de exemplo

HTTP

POST https://resourcename.communication.azure.com//availablePhoneNumbers/countries/US/:search?api-version=2025-02-11

{
  "phoneNumberType": "tollFree",
  "assignmentType": "application",
  "capabilities": {
    "sms": "inbound+outbound",
    "calling": "none"
  },
  "areaCode": "425",
  "quantity": 1
}

Resposta de exemplo

Código de status:: 202

Operation-Location: /phoneNumbers/operations/search_378ddf60-81be-452a-ba4f-613198ea6c28
Location: /availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28
operation-id: search_378ddf60-81be-452a-ba4f-613198ea6c28
search-id: 378ddf60-81be-452a-ba4f-613198ea6c28

{
  "searchId": "378ddf60-81be-452a-ba4f-613198ea6c28",
  "phoneNumbers": [
    "+18001212121"
  ],
  "phoneNumberType": "tollFree",
  "assignmentType": "application",
  "capabilities": {
    "sms": "inbound+outbound",
    "calling": "none"
  },
  "cost": {
    "amount": 1.2,
    "currencyCode": "USD",
    "billingFrequency": "monthly"
  },
  "searchExpiresBy": "2020-11-19T16:31:49.048Z"
}

Definições

Nome	Description
BillingFrequency	A frequência com que o custo é cobrado.
CommunicationError	O erro dos Serviços de Comunicação.
CommunicationErrorResponse	O erro dos Serviços de Comunicação.
Error	Mapeando mensagens de erro para códigos
PhoneNumberAssignmentType	Representa o tipo de atribuição da oferta.
PhoneNumberCapabilities	Funcionalidades de um número de telefone.
PhoneNumberCapabilityType	Valor de funcionalidade para chamada.
PhoneNumberCost	O custo incorrido para um único número de telefone.
PhoneNumberSearchRequest	Representa uma solicitação de pesquisa de número de telefone para localizar números de telefone. Os números de telefone encontrados são temporariamente mantidos para uma compra a seguir.
PhoneNumberSearchResult	O resultado de uma operação de pesquisa de números de telefone.
PhoneNumberType	Representa o tipo de número da oferta.

BillingFrequency

Enumeration

A frequência com que o custo é cobrado.

Valor	Description
monthly

CommunicationError

Object

O erro dos Serviços de Comunicação.

Nome	Tipo	Description
code	string	O código de erro.
details	CommunicationError[]	Mais detalhes sobre erros específicos que levaram a esse erro.
innererror	CommunicationError	O erro interno, se houver.
message	string	A mensagem de erro.
target	string	O destino do erro.

CommunicationErrorResponse

Object

O erro dos Serviços de Comunicação.

Nome	Tipo	Description
error	CommunicationError	O erro dos Serviços de Comunicação.

Error

Enumeration

Mapeando mensagens de erro para códigos

Valor	Description
AllNumbersNotAcquired
AuthorizationDenied
BillingUnavailable
InvalidAddress
InvalidOfferModel
MissingAddress
NoError
NoWallet
NotEnoughCredit
NotEnoughLicenses
NumbersPartiallyAcquired
OutOfStock
ProvisioningFailed
PurchaseFailed
ReservationExpired
UnknownErrorCode
UnknownSearchError

PhoneNumberAssignmentType

Enumeration

Representa o tipo de atribuição da oferta.

Valor	Description
application
person

PhoneNumberCapabilities

Object

Funcionalidades de um número de telefone.

Nome	Tipo	Description
calling	PhoneNumberCapabilityType	Valor de funcionalidade para chamada.
sms	PhoneNumberCapabilityType	Valor da funcionalidade para SMS.

PhoneNumberCapabilityType

Enumeration

Valor de funcionalidade para chamada.

Valor	Description
inbound
inbound+outbound
none
outbound

PhoneNumberCost

Object

O custo incorrido para um único número de telefone.

Nome	Tipo	Description
amount	number	O valor do custo.
billingFrequency	BillingFrequency	A frequência com que o custo é cobrado.
currencyCode	string	O código de moeda ISO 4217 para o valor do custo, por exemplo, USD.

PhoneNumberSearchRequest

Object

Representa uma solicitação de pesquisa de número de telefone para localizar números de telefone. Os números de telefone encontrados são temporariamente mantidos para uma compra a seguir.

Nome	Tipo	Valor padrão	Description
areaCode	string		O código de área do número de telefone desejado, por exemplo, 425.
assignmentType	PhoneNumberAssignmentType		O tipo de atribuição dos números de telefone a serem pesquisados. Um número de telefone pode ser atribuído a uma pessoa ou a um aplicativo.
capabilities	PhoneNumberCapabilities		Funcionalidades de um número de telefone.
phoneNumberType	PhoneNumberType		O tipo de números de telefone a serem pesquisados, por exemplo, geográfico ou tollFree.
quantity	integer	1	A quantidade de números de telefone desejados. O valor padrão é 1.

PhoneNumberSearchResult

Object

O resultado de uma operação de pesquisa de números de telefone.

Nome	Tipo	Description
assignmentType	PhoneNumberAssignmentType	Tipo de atribuição do número de telefone.
capabilities	PhoneNumberCapabilities	Funcionalidades de um número de telefone.
cost	PhoneNumberCost	O custo incorrido para um único número de telefone.
error	Error	Mapeando mensagens de erro para códigos
errorCode	integer	O código de erro da pesquisa.
phoneNumberType	PhoneNumberType	O tipo do número de telefone, por exemplo, geográfico ou tollFree.
phoneNumbers	string[]	Os números de telefone disponíveis. Pode ser menor que a quantidade de pesquisa desejada.
searchExpiresBy	string	A data em que esse resultado da pesquisa expira e os números de telefone não estão mais em espera. Um resultado de pesquisa expira em menos de 15min, por exemplo, 2020-11-19T16:31:49.048Z.
searchId	string	A ID da pesquisa.

PhoneNumberType

Enumeration

Representa o tipo de número da oferta.

Valor	Description
geographic
tollFree

Compartilhar via

Phone Numbers - Search Available Phone Numbers

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Search for phone numbers

Solicitação de exemplo

Resposta de exemplo

Definições

BillingFrequency

CommunicationError

CommunicationErrorResponse

Error

PhoneNumberAssignmentType

PhoneNumberCapabilities

PhoneNumberCapabilityType

PhoneNumberCost

PhoneNumberSearchRequest

PhoneNumberSearchResult

PhoneNumberType

Recursos adicionais