Phone Numbers - Get By Number

Reference

Služba:: Communication

Verze rozhraní API:: 2025-02-11

Získá podrobnosti o daném zakoupeném telefonním čísle.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string url	Komunikační prostředek, například https://resourcename.communication.azure.com
phoneNumber	path	True	string	Zakoupené telefonní číslo, jehož podrobnosti se mají načíst ve formátu E.164, např. +11234567890.
api-version	query	True	string	Verze rozhraní API pro vyvolání

Odpovědi

Name	Typ	Description
200 OK	PurchasedPhoneNumber	Úspěch
Other Status Codes	CommunicationErrorResponse	Selhání

Příklady

Fetch purchased phone number

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
BillingFrequency	Frekvence, s jakou se náklady účtují.
CommunicationError	Chyba Komunikační služby.
CommunicationErrorResponse	Chyba Komunikační služby.
PhoneNumberAssignmentType	Představuje typ přiřazení nabídky.
PhoneNumberCapabilities	Možnosti telefonního čísla
PhoneNumberCapabilityType	Hodnota schopností pro volání
PhoneNumberCost	Náklady na jedno telefonní číslo.
PhoneNumberType	Představuje typ čísla nabídky.
PurchasedPhoneNumber	Představuje zakoupené telefonní číslo.

BillingFrequency

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

Name	Typ	Description
monthly	string

CommunicationError

Chyba Komunikační služby.

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

CommunicationErrorResponse

Chyba Komunikační služby.

Name	Typ	Description
error	CommunicationError	Chyba Komunikační služby.

PhoneNumberAssignmentType

Představuje typ přiřazení nabídky.

Name	Typ	Description
application	string
person	string

PhoneNumberCapabilities

Možnosti telefonního čísla

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

PhoneNumberCapabilityType

Hodnota schopností pro volání

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

PhoneNumberCost

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

Představuje typ čísla nabídky.

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 může být přiřazeno osobě nebo aplikaci.
capabilities	PhoneNumberCapabilities	Možnosti telefonního čísla
cost	PhoneNumberCost	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ř. 11234567890.
phoneNumber	string	Řetězec formátu E.164 telefonního čísla, např. +11234567890.
phoneNumberType	PhoneNumberType	Typ telefonního čísla, např. zeměpisné číslo, tollFree.
purchaseDate	string	Datum a čas zakoupení telefonního čísla.

Sdílet prostřednictvím