Job Router Operations - Get In Queue Position

Tjänst:

Communication

API-versionen:

2023-11-01

Hämtar ett jobbs befattningsinformation.

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
endpoint	path	True	string (uri)	Uri för din kommunikationsresurs
jobId	path	True	string	Id för jobbet.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Svaren

Namn	Typ	Beskrivning
200 OK	RouterJobPositionDetails	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Headers x-ms-error-code: string

Säkerhet

AadOauth2Auth

Azure Active Directory OAuth2-flödet

Typ: oauth2
Rinna: accessCode
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Scope

Namn	Beskrivning
https://communication.azure.com/.default

Exempel

Gets a job's position details

Exempelförfrågan

HTTP

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

Exempelsvar

Statuskod:

200

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

Definitioner

Namn	Beskrivning
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
RouterJobPositionDetails	Position och uppskattad väntetid för ett jobb.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Namn	Typ	Beskrivning
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Namn	Typ	Beskrivning
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt riktlinjerna för Azure REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Namn	Typ	Beskrivning
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

RouterJobPositionDetails

Objekt

Position och uppskattad väntetid för ett jobb.

Namn	Typ	Beskrivning
estimatedWaitTimeMinutes	number (double)	Beräknad väntetid för jobbet avrundades upp till närmaste minut.
jobId	string	Id för jobbet som den här informationen handlar om.
position	integer (int32)	Positionen för det aktuella jobbet i kön.
queueId	string	Id för kön som det här jobbet finns i.
queueLength	integer (int32)	Köns längd: totalt antal köade jobb.