Phone Numbers - List Phone Numbers

Referência

Service:: Communication

API Version:: 2021-03-07

Obtém a lista de todos os números de telefone comprados.

GET {endpoint}/phoneNumbers?api-version=2021-03-07

With optional parameters:

GET {endpoint}/phoneNumbers?skip={skip}&top={top}&api-version=2021-03-07

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O recurso de comunicação, por exemplo https://resourcename.communication.azure.com.
api-version	query	True	string	Versão da API a invocar.
skip	query		integer int32	Um parâmetro opcional para quantas entradas ignorar, para fins de paginação. O valor predefinido é 0.
top	query		integer int32	Um parâmetro opcional para quantas entradas devem ser devolvidas, para fins de paginação. O valor predefinido é 100.

Respostas

Name	Tipo	Description
200 OK	PurchasedPhoneNumbers	Com êxito
Other Status Codes	CommunicationErrorResponse	Falha

Exemplos

List purchased phone numbers

Sample Request

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers?api-version=2021-03-07

Sample Response

Status code:: 200

{
  "phoneNumbers": [
    {
      "id": "11234567890",
      "phoneNumber": "+11234567890",
      "countryCode": "US",
      "assignmentType": "user",
      "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

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.
PhoneNumberAssignmentType	O tipo de atribuição dos números de telefone a procurar. Um número de telefone pode ser atribuído a uma pessoa ou a uma aplicação.
PhoneNumberCapabilities	Capacidades de um número de telefone.
PhoneNumberCapabilityType	Valor de capacidade para chamar.
PhoneNumberCost	O custo incorrido para um único número de telefone.
PhoneNumberType	O tipo de números de telefone a procurar, por exemplo, geográficos ou gratuitos.
PurchasedPhoneNumber	Representa um número de telefone comprado.
PurchasedPhoneNumbers	A lista de números de telefone comprados.

BillingFrequency

A frequência com que o custo é faturado.

Name	Tipo	Description
monthly	string

CommunicationError

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 este erro.
innererror	CommunicationError	O erro interno, se existir.
message	string	A mensagem de erro.
target	string	O destino do erro.

CommunicationErrorResponse

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

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

PhoneNumberAssignmentType

O tipo de atribuição dos números de telefone a procurar. Um número de telefone pode ser atribuído a uma pessoa ou a uma aplicação.

Name	Tipo	Description
application	string
person	string

PhoneNumberCapabilities

Capacidades de um número de telefone.

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

PhoneNumberCapabilityType

Valor de capacidade para chamar.

Name	Tipo	Description
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

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

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

PhoneNumberType

O tipo de números de telefone a procurar, por exemplo, geográficos ou gratuitos.

Name	Tipo	Description
geographic	string
tollFree	string

PurchasedPhoneNumber

Representa um número de telefone comprado.

Name	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 uma aplicação.
capabilities	PhoneNumberCapabilities	Capacidades 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, E.U.A.
id	string	O ID do número de telefone, por exemplo, 11234567890.
phoneNumber	string	Cadeia 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 hora em que o número de telefone foi comprado.

PurchasedPhoneNumbers

A lista de números de telefone comprados.

Name	Tipo	Description
nextLink	string	Representa a ligação do URL para a página seguinte dos resultados do número de telefone.
phoneNumbers	PurchasedPhoneNumber[]	Representa uma lista de números de telefone.

Share via