Dela via

Job Router Operations - Get In Queue Position

  • Referens
Tjänst:
Communication
API-version:
2023-11-01

Hämtar ett jobbs befattningsinformation.

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

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string

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.

Svar

Name Typ Description
200 OK

RouterJobPositionDetails

Begäran har slutförts.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

AadOauth2Auth

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

Name Description
https://communication.azure.com/.default

Exempel

Gets a job's position details

Exempelbegäran

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

Name Description
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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterJobPositionDetails

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

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name Typ Description
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.

Name Typ Description
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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
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.

Name Typ Description
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.