Phone Numbers - List Phone Numbers

Reference

Service:: Communication

API Version:: 2021-03-07

Získá seznam všech zakoupených telefonních čísel.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Komunikační prostředek, například https://resourcename.communication.azure.com.
api-version	query	True	string	Verze rozhraní API, která se má vyvolat.
skip	query		integer int32	Volitelný parametr pro počet položek, které se mají přeskočit, pro účely stránkování. Výchozí hodnota je 0.
top	query		integer int32	Volitelný parametr pro počet položek, které se mají vrátit, pro účely stránkování. Výchozí hodnota je 100.

Odpovědi

Name	Typ	Description
200 OK	PurchasedPhoneNumbers	Success
Other Status Codes	CommunicationErrorResponse	Selhání

Příklady

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"
      }
    }
  ]
}

Definice

Name	Description
BillingFrequency	Frekvence, s jakou se náklady účtují.
CommunicationError	Chyba komunikačních služeb.
CommunicationErrorResponse	Chyba komunikačních služeb.
PhoneNumberAssignmentType	Typ zadání telefonních čísel, která chcete vyhledat. Telefonní číslo lze přiřadit osobě nebo aplikaci.
PhoneNumberCapabilities	Možnosti telefonního čísla
PhoneNumberCapabilityType	Hodnota schopnosti pro volání.
PhoneNumberCost	Vzniklé náklady na jedno telefonní číslo
PhoneNumberType	Typ telefonních čísel, která chcete vyhledat, například zeměpisná nebo tollFree.
PurchasedPhoneNumber	Představuje zakoupené telefonní číslo.
PurchasedPhoneNumbers	Seznam zakoupených telefonních čísel.

BillingFrequency

Frekvence, s jakou se náklady účtují.

Name	Typ	Description
monthly	string

CommunicationError

Chyba komunikačních služeb.

Name	Typ	Description
code	string	Kód chyby
details	CommunicationError[]	Další podrobnosti o konkrétních chybách, které k této chybě vedly.
innererror	CommunicationError	Vnitřní chyba, pokud existuje.
message	string	Chybová zpráva
target	string	Cíl chyby.

CommunicationErrorResponse

Chyba komunikačních služeb.

Name	Typ	Description
error	CommunicationError	Chyba komunikačních služeb.

PhoneNumberAssignmentType

Typ zadání telefonních čísel, která chcete vyhledat. Telefonní číslo lze přiřadit osobě nebo aplikaci.

Name	Typ	Description
application	string
person	string

PhoneNumberCapabilities

Možnosti telefonního čísla

Name	Typ	Description
calling	PhoneNumberCapabilityType	Hodnota schopnosti pro volání.
sms	PhoneNumberCapabilityType	Hodnota schopnosti pro SMS.

PhoneNumberCapabilityType

Hodnota schopnosti pro volání.

Name	Typ	Description
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

Vzniklé náklady na jedno telefonní číslo

Name	Typ	Description
amount	number	Částka nákladů.
billingFrequency	BillingFrequency	Frekvence, s jakou se náklady účtují.
currencyCode	string	Kód měny ISO 4217 pro částku nákladů, např. USD.

PhoneNumberType

Typ telefonních čísel, která chcete vyhledat, například zeměpisná nebo tollFree.

Name	Typ	Description
geographic	string
tollFree	string

PurchasedPhoneNumber

Představuje zakoupené telefonní číslo.

Name	Typ	Description
assignmentType	PhoneNumberAssignmentType	Typ zadání telefonního čísla. Telefonní číslo lze přiřadit osobě nebo aplikaci.
capabilities	PhoneNumberCapabilities	Možnosti telefonního čísla
cost	PhoneNumberCost	Vzniklé náklady na jedno telefonní číslo
countryCode	string	Kód ISO 3166-2 země telefonního čísla, např. USA.
id	string	ID telefonního čísla, například 11234567890.
phoneNumber	string	Řetězec telefonního čísla ve formátu E.164, například +11234567890.
phoneNumberType	PhoneNumberType	Typ telefonního čísla, např. Zeměpisné číslo, TollFree.
purchaseDate	string	Datum a čas zakoupení telefonního čísla.

PurchasedPhoneNumbers

Seznam zakoupených telefonních čísel.

Name	Typ	Description
nextLink	string	Představuje odkaz URL na další stránku výsledků telefonního čísla.
phoneNumbers	PurchasedPhoneNumber[]	Představuje seznam telefonních čísel.

Sdílet prostřednictvím