Phone Numbers - Get By Number

Dienst:

Communication

API-Version:

2022-12-01

Ruft die Details der angegebenen gekauften Telefonnummer ab.

GET {endpoint}/phoneNumbers/{phoneNumber}?api-version=2022-12-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (url)	Die Kommunikationsressource, z. B. https://resourcename.communication.azure.com
phoneNumber	path	True	string	Die erworbene Telefonnummer, deren Details im E.164-Format abgerufen werden sollen, z. B. +11234567890.
api-version	query	True	string	Version der API, die aufgerufen werden soll

Antworten

Name	Typ	Beschreibung
200 OK	PurchasedPhoneNumber	Erfolg
Other Status Codes	CommunicationErrorResponse	Versagen

Beispiele

Fetch purchased phone number

Beispielanforderung

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers/+11234567890?api-version=2022-12-01

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
BillingFrequency	Die Häufigkeit, mit der die Kosten in Rechnung gestellt werden.
CommunicationError	Der Kommunikationsdienstfehler.
CommunicationErrorResponse	Der Kommunikationsdienstfehler.
PhoneNumberAssignmentType	Stellt den Zuordnungstyp des Angebots dar.
PhoneNumberCapabilities	Funktionen einer Telefonnummer.
PhoneNumberCapabilityType	Funktionswert für Anrufe.
PhoneNumberCost	Die entstandenen Kosten für eine einzelne Telefonnummer.
PhoneNumberType	Stellt den Nummerntyp des Angebots dar.
PurchasedPhoneNumber	Stellt eine erworbene Telefonnummer dar.

BillingFrequency

Enumeration

Die Häufigkeit, mit der die Kosten in Rechnung gestellt werden.

Wert	Beschreibung
monthly

CommunicationError

Objekt

Der Kommunikationsdienstfehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CommunicationError[]	Weitere Details zu bestimmten Fehlern, die zu diesem Fehler geführt haben.
innererror	CommunicationError	Der innere Fehler( falls vorhanden).
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

CommunicationErrorResponse

Objekt

Der Kommunikationsdienstfehler.

Name	Typ	Beschreibung
error	CommunicationError	Der Kommunikationsdienstfehler.

PhoneNumberAssignmentType

Enumeration

Stellt den Zuordnungstyp des Angebots dar.

Wert	Beschreibung
application
person

PhoneNumberCapabilities

Objekt

Funktionen einer Telefonnummer.

Name	Typ	Beschreibung
calling	PhoneNumberCapabilityType	Funktionswert für Anrufe.
sms	PhoneNumberCapabilityType	Funktionswert für SMS.

PhoneNumberCapabilityType

Enumeration

Funktionswert für Anrufe.

Wert	Beschreibung
inbound
inbound+outbound
none
outbound

PhoneNumberCost

Objekt

Die entstandenen Kosten für eine einzelne Telefonnummer.

Name	Typ	Beschreibung
amount	number (double)	Der Kostenbetrag.
billingFrequency	BillingFrequency	Die Häufigkeit, mit der die Kosten in Rechnung gestellt werden.
currencyCode	string	Der ISO 4217-Währungscode für den Kostenbetrag, z. B. USD.

PhoneNumberType

Enumeration

Stellt den Nummerntyp des Angebots dar.

Wert	Beschreibung
geographic
tollFree

PurchasedPhoneNumber

Objekt

Stellt eine erworbene Telefonnummer dar.

Name	Typ	Beschreibung
assignmentType	PhoneNumberAssignmentType	Der Zuordnungstyp der Telefonnummer. Eine Telefonnummer kann einer Person oder einer Anwendung zugewiesen werden.
capabilities	PhoneNumberCapabilities	Funktionen einer Telefonnummer.
cost	PhoneNumberCost	Die entstandenen Kosten für eine einzelne Telefonnummer.
countryCode	string	Der ISO 3166-2-Code des Landes der Telefonnummer, z. B. USA.
id	string	Die ID der Telefonnummer, z. B. 11234567890.
phoneNumber	string	Zeichenfolge des E.164-Formats der Telefonnummer, z. B. +11234567890.
phoneNumberType	PhoneNumberType	Der Typ der Telefonnummer, z. B. ortsgebunden, tollFree.
purchaseDate	string (date-time)	Das Datum und die Uhrzeit, zu dem die Telefonnummer gekauft wurde.