Phone Numbers - Update Capabilities

Dienst:

Communication

API-Version:

2021-03-07

Updates die Funktionen einer Telefonnummer.

PATCH {endpoint}/phoneNumbers/{phoneNumber}/capabilities?api-version=2021-03-07

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Kommunikationsressource, z. B https://resourcename.communication.azure.com. .
phoneNumber	path	True	string	Die Telefonnummern-ID im E.164-Format. Das führende Plus kann entweder + oder als %2B codiert sein, z. B. +11234567890.
api-version	query	True	string	Version der aufzurufenden API.

Anforderungstext

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

Name	Typ	Beschreibung
calling	PhoneNumberCapabilityType	Funktionswert für Den Aufruf.
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. Er gibt sofort "Accepted" zurück und enthält die Header "Operation-Location" und "Location". Die Clientseite sollte den Vorgang status mithilfe der im Header "Operation-Location" angegebenen URL abfragen. Wenn der Vorgang erfolgreich abgeschlossen ist, fragen Sie das endgültige Ergebnis mithilfe der im Header "Location" angegebenen URL ab. Header Location: string Operation-Location: string operation-id: string capabilities-id: string
Other Status Codes	CommunicationErrorResponse	Fehler

Beispiele

Update phoneNumber capabilities

Beispielanforderung

HTTP

PATCH https://resourcename.communication.azure.com//phoneNumbers/+14792000102/capabilities?api-version=2021-03-07

{
  "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 abgerechnet werden.
CommunicationError	Der Communication Services-Fehler.
CommunicationErrorResponse	Der Communication Services-Fehler.
PhoneNumberAssignmentType	Der Zuweisungstyp der telefonnummern, nach der gesucht werden soll. Eine Telefonnummer kann einer Person oder einer Anwendung zugewiesen werden.
PhoneNumberCapabilities	Funktionen einer Telefonnummer.
PhoneNumberCapabilitiesRequest	Funktionen einer Telefonnummer.
PhoneNumberCapabilityType	Funktionswert für Den Aufruf.
PhoneNumberCost	Die angefallenen Kosten für eine einzelne Telefonnummer.
PhoneNumberType	Der Typ der zu suchden Telefonnummern, z. B. geografisch oder tollFree.
PurchasedPhoneNumber	Stellt eine erworbene Telefonnummer dar.

BillingFrequency

Die Häufigkeit, mit der die Kosten abgerechnet werden.

Name	Typ	Beschreibung
monthly	string

CommunicationError

Der Communication Services-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CommunicationError[]	Weitere Informationen 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 Communication Services-Fehler.

Name	Typ	Beschreibung
error	CommunicationError	Der Communication Services-Fehler.

PhoneNumberAssignmentType

Der Zuweisungstyp der telefonnummern, nach der gesucht werden soll. Eine Telefonnummer kann einer Person oder einer Anwendung zugewiesen werden.

Name	Typ	Beschreibung
application	string
person	string

PhoneNumberCapabilities

Funktionen einer Telefonnummer.

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

PhoneNumberCapabilitiesRequest

Funktionen einer Telefonnummer.

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

PhoneNumberCapabilityType

Funktionswert für Den Aufruf.

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

PhoneNumberCost

Die angefallenen Kosten für eine einzelne Telefonnummer.

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

PhoneNumberType

Der Typ der zu suchden Telefonnummern, z. B. geografisch oder tollFree.

Name	Typ	Beschreibung
geographic	string
tollFree	string

PurchasedPhoneNumber

Stellt eine erworbene Telefonnummer dar.

Name	Typ	Beschreibung
assignmentType	PhoneNumberAssignmentType	Der Zuweisungstyp der Telefonnummer. Eine Telefonnummer kann einer Person oder einer Anwendung zugewiesen werden.
capabilities	PhoneNumberCapabilities	Funktionen einer Telefonnummer.
cost	PhoneNumberCost	Die angefallenen 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 im E.164-Format der Telefonnummer, z. B. +11234567890.
phoneNumberType	PhoneNumberType	Der Typ der Telefonnummer, z. B. Geografisch, TollFree.
purchaseDate	string	Das Datum und die Uhrzeit, zu dem die Telefonnummer erworben wurde.