Phone Numbers - Update Capabilities

Dienst:

Communication

API-Version:

2022-12-01

Aktualisiert die Funktionen einer Telefonnummer.

PATCH {endpoint}/phoneNumbers/{phoneNumber}/capabilities?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 Telefonnummern-ID im E.164-Format. Das führende Pluszeichen kann entweder + oder als %2Bcodiert werden, z. B. +11234567890.
api-version	query	True	string	Version der API, die aufgerufen werden soll

Anforderungstext

Media Types: "application/merge-patch+json"

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

Antworten

Name	Typ	Beschreibung
202 Accepted	PurchasedPhoneNumber	Der Dienst hat die Anforderung akzeptiert und beginnt später mit der Verarbeitung. Sie gibt "Akzeptiert" sofort zurück und enthält die Kopfzeilen "Operation-Location" und "Location". Clientseite sollte den Vorgangsstatus weiter abfragen, indem die im Header "Operation-Location" angegebene URL verwendet wird. Wenn der Vorgang abgeschlossen ist, wird das endergebnis mithilfe der URL, die im Header "Location" angegeben ist, erfolgreich abfraget. Header Location: string Operation-Location: string operation-id: string capabilities-id: string
Other Status Codes	CommunicationErrorResponse	Versagen

Beispiele

Update phoneNumber capabilities

Beispielanforderung

HTTP

PATCH https://resourcename.communication.azure.com//phoneNumbers/+14792000102/capabilities?api-version=2022-12-01

{
  "calling": "inbound+outbound",
  "sms": "none"
}

Beispiel für eine Antwort

Statuscode:

202

Operation-Location: /phoneNumbers/operations/capabilities_378ddf60-81be-452a-ba4f-613198ea6c28
Location: /phoneNumbers/%2b14792000102
operation-id: capabilities_378ddf60-81be-452a-ba4f-613198ea6c28
capabilities-id: 378ddf60-81be-452a-ba4f-613198ea6c28

{
  "id": "14792000102",
  "phoneNumber": "+14792000102",
  "countryCode": "US",
  "assignmentType": "person",
  "phoneNumberType": "geographic",
  "capabilities": {
    "calling": "inbound+outbound",
    "sms": "none"
  },
  "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.
PhoneNumberCapabilitiesRequest	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

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

Name	Typ	Beschreibung
monthly	string

CommunicationError

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

Der Kommunikationsdienstfehler.

Name	Typ	Beschreibung
error	CommunicationError	Der Kommunikationsdienstfehler.

PhoneNumberAssignmentType

Stellt den Zuordnungstyp des Angebots dar.

Name	Typ	Beschreibung
application	string
person	string

PhoneNumberCapabilities

Funktionen einer Telefonnummer.

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

PhoneNumberCapabilitiesRequest

Funktionen einer Telefonnummer.

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

PhoneNumberCapabilityType

Funktionswert für Anrufe.

Name	Typ	Beschreibung
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

Die entstandenen Kosten für eine einzelne Telefonnummer.

Name	Typ	Beschreibung
amount	number	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

Stellt den Nummerntyp des Angebots dar.

Name	Typ	Beschreibung
geographic	string
tollFree	string

PurchasedPhoneNumber

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	Das Datum und die Uhrzeit, zu dem die Telefonnummer gekauft wurde.