Job Router Operations - Get In Queue Position

Usługa:

Communication

Wersja interfejsu API:

2023-11-01

Pobiera szczegóły stanowiska zadania.

GET {endpoint}/routing/jobs/{jobId}/position?api-version=2023-11-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Identyfikator URI zasobu komunikacji
jobId	path	True	string	Identyfikator zadania.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RouterJobPositionDetails	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Przykłady

Gets a job's position details

Przykładowe żądanie

HTTP

GET https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/position?api-version=2023-11-01

Przykładowa odpowiedź

Kod stanu:

200

{
  "jobId": "383541b3-5637-4af6-8aac-3391da8a578a",
  "position": 1,
  "queueId": "MainQueue",
  "queueLength": 3,
  "estimatedWaitTimeMinutes": 4
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt error.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterJobPositionDetails	Pozycja i szacowany czas oczekiwania dla zadania.

Azure.Core.Foundations.Error

Obiekt error.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt error.

Azure.Core.Foundations.InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

RouterJobPositionDetails

Pozycja i szacowany czas oczekiwania dla zadania.

Nazwa	Typ	Opis
estimatedWaitTimeMinutes	number	Szacowany czas oczekiwania zadania zaokrąglony do najbliższej minuty.
jobId	string	Identyfikator zadania, o których te szczegóły dotyczą.
position	integer	Pozycja danego zadania w tej kolejce.
queueId	string	Identyfikator kolejki, w ramach których to zadanie jest w kolejce.
queueLength	integer	Długość kolejki: łączna liczba w kolejce zadań.