Phone Numbers - Get Search Result

Serviço:

Communication

Versão da API:

2025-02-11

Obtém um resultado de pesquisa de número de telefone por ID de pesquisa.

GET {endpoint}/availablePhoneNumbers/searchResults/{searchId}?api-version=2025-02-11

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string url	O recurso de comunicação, por exemplo, https://resourcename.communication.azure.com
searchId	path	True	string	O ID da pesquisa.
api-version	query	True	string	Versão da API a invocar

Respostas

Name	Tipo	Description
200 OK	PhoneNumberSearchResult	Sucesso
Other Status Codes	CommunicationErrorResponse	Fracasso

Exemplos

Get PhoneNumber Search Result

Pedido de amostra

HTTP

GET https://resourcename.communication.azure.com//availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28?api-version=2025-02-11

Resposta da amostra

Código de estado:

200

{
  "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",
  "errorCode": 1000,
  "error": "OutOfStock"
}

Definições

Name	Description
BillingFrequency	A frequência com que o custo é faturado.
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	Capacidades de um número de telefone.
PhoneNumberCapabilityType	Valor de capacidade para chamadas.
PhoneNumberCost	O custo incorrido para um único número de telefone.
PhoneNumberSearchResult	O resultado de uma operação de pesquisa de número de telefone.
PhoneNumberType	Representa o tipo de número da oferta.

BillingFrequency

Enumeration

A frequência com que o custo é faturado.

Valor	Description
monthly

CommunicationError

Object

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

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

Name	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

Capacidades de um número de telefone.

Name	Tipo	Description
calling	PhoneNumberCapabilityType	Valor de capacidade para chamadas.
sms	PhoneNumberCapabilityType	Valor de capacidade para SMS.

PhoneNumberCapabilityType

Enumeration

Valor de capacidade para chamadas.

Valor	Description
inbound
inbound+outbound
none
outbound

PhoneNumberCost

Object

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

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

PhoneNumberSearchResult

Object

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

Name	Tipo	Description
assignmentType	PhoneNumberAssignmentType	Tipo de atribuição do número de telefone.
capabilities	PhoneNumberCapabilities	Capacidades 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 do 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	O id da pesquisa.

PhoneNumberType

Enumeration

Representa o tipo de número da oferta.

Valor	Description
geographic
tollFree