Job Router Operations - Get In Queue Position

  • Reference
Service:
Communication
API Version:
2023-11-01

Gets a job's position details.

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

URI Parameters

Name In Required Type Description
endpoint
 path True

string

Uri of your Communication resource
jobId
 path True

string

Id of the job.
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

RouterJobPositionDetails

The request has succeeded.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Examples

Gets a job's position details

Sample request

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

Sample response

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

Definitions

Name Description
Azure.Core.Foundations.Error

The error object.
Azure.Core.Foundations.ErrorResponse

A response containing error details.
Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterJobPositionDetails

Position and estimated wait time for a job.

Azure.Core.Foundations.Error

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.
details

Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.
innererror

Azure.Core.Foundations.InnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Name Type Description
error

Azure.Core.Foundations.Error

The error object.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

string

One of a server-defined set of error codes.
innererror

Azure.Core.Foundations.InnerError

Inner error.

RouterJobPositionDetails

Position and estimated wait time for a job.

Name Type Description
estimatedWaitTimeMinutes

number

Estimated wait time of the job rounded up to the nearest minute.
jobId

string

Id of the job these details are about.
position

integer

Position of the job in question within that queue.
queueId

string

Id of the queue this job is enqueued in.
queueLength

integer

Length of the queue: total number of enqueued jobs.