Phone Numbers - Get By Number

Serviço:

Communication

Versão da API:

2025-02-11

Obtém os detalhes do número de telefone comprado determinado.

GET {endpoint}/phoneNumbers/{phoneNumber}?api-version=2025-02-11

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string url	O recurso de comunicação, por exemplo, https://resourcename.communication.azure.com
phoneNumber	path	True	string	O número de telefone comprado cujos detalhes devem ser buscados no formato E.164, por exemplo, +11234567890.
api-version	query	True	string	Versão da API a ser invocada

Respostas

Nome	Tipo	Description
200 OK	PurchasedPhoneNumber	Êxito
Other Status Codes	CommunicationErrorResponse	Fracasso

Exemplos

Fetch purchased phone number

Solicitação de exemplo

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers/+11234567890?api-version=2025-02-11

Resposta de exemplo

Código de status:

200

{
  "id": "11234567890",
  "phoneNumber": "+11234567890",
  "countryCode": "US",
  "assignmentType": "person",
  "phoneNumberType": "geographic",
  "capabilities": {
    "calling": "inbound+outbound",
    "sms": "inbound"
  },
  "purchaseDate": "2020-11-19T16:31:49.048Z",
  "cost": {
    "amount": 0.8,
    "currencyCode": "USD",
    "billingFrequency": "monthly"
  }
}

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.
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.
PhoneNumberType	Representa o tipo de número da oferta.
PurchasedPhoneNumber	Representa um número de telefone comprado.

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.

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.

PhoneNumberType

Enumeration

Representa o tipo de número da oferta.

Valor	Description
geographic
tollFree

PurchasedPhoneNumber

Object

Representa um número de telefone comprado.

Nome	Tipo	Description
assignmentType	PhoneNumberAssignmentType	O tipo de atribuição do número de telefone. 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.
cost	PhoneNumberCost	O custo incorrido para um único número de telefone.
countryCode	string	O código ISO 3166-2 do país do número de telefone, por exemplo, EUA.
id	string	A ID do número de telefone, por exemplo, 11234567890.
phoneNumber	string	Cadeia de caracteres do formato E.164 do número de telefone, por exemplo, +11234567890.
phoneNumberType	PhoneNumberType	O tipo do número de telefone, por exemplo, geográfico, tollFree.
purchaseDate	string	A data e a hora em que o número de telefone foi comprado.