Phone Numbers - Get Operation

Dienst:

Communication

API-Version:

2022-12-01

Ruft einen Vorgang anhand seiner ID ab.

GET {endpoint}/phoneNumbers/operations/{operationId}?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
operationId	path	True	string	Die ID des Vorgangs
api-version	query	True	string	Version der API, die aufgerufen werden soll

Antworten

Name	Typ	Beschreibung
200 OK	PhoneNumberOperation	Wenn der Vorgang abgeschlossen ist, fragen Sie das endgültige Ergebnis des Vorgangs mithilfe der URL ab, die im Attribut "Location" im Antwortheader angegeben ist. Header Location: string
Other Status Codes	CommunicationErrorResponse	Versagen

Beispiele

Get long running operation status by operation id

Beispielanforderung

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers/operations/search-my-operation-id?api-version=2022-12-01

Beispiel für eine Antwort

Statuscode:

200

Location: /availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28

{
  "status": "succeeded",
  "resourceLocation": "/availablePhoneNumbers/searchResults/378ddf60-81be-452a-ba4f-613198ea6c28",
  "createdDateTime": "2020-11-19T16:31:49.048Z",
  "id": "search-my-operation-id",
  "operationType": "search",
  "lastActionDateTime": "2020-11-19T22:31:49.048Z"
}

Definitionen

Name	Beschreibung
CommunicationError	Der Kommunikationsdienstfehler.
CommunicationErrorResponse	Der Kommunikationsdienstfehler.
PhoneNumberOperation
PhoneNumberOperationStatus	Status des Vorgangs.
PhoneNumberOperationType	Der Vorgangstyp, z. B. Suche

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.

PhoneNumberOperation

Objekt

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Das Datum, an dem der Vorgang erstellt wurde.
error	CommunicationError	Der Kommunikationsdienstfehler.
id	string	Id des Vorgangs.
lastActionDateTime	string (date-time)	Das letzte Datum, an dem der Vorgang geändert wurde.
operationType	PhoneNumberOperationType	Der Vorgangstyp, z. B. Suche
resourceLocation	string	URL zum Abrufen des Ergebnisses des Vorgangs, falls vorhanden.
status	PhoneNumberOperationStatus	Status des Vorgangs.

PhoneNumberOperationStatus

Enumeration

Status des Vorgangs.

Wert	Beschreibung
failed
notStarted
running
succeeded

PhoneNumberOperationType

Enumeration

Der Vorgangstyp, z. B. Suche

Wert	Beschreibung
purchase
releasePhoneNumber
search
updatePhoneNumberCapabilities