Job Router Operations - Get In Queue Position

서비스:

Communication

API 버전:

2023-11-01

작업의 위치 세부 정보를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	통신 리소스의 URI
jobId	path	True	string	작업의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	RouterJobPositionDetails	요청이 성공했습니다.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

예제

Gets a job's position details

샘플 요청

HTTP

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

샘플 응답

상태 코드:

200

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

정의

Name	Description
Azure.Core.Foundations.Error	Error 개체.
Azure.Core.Foundations.ErrorResponse	오류 세부 정보가 포함된 응답입니다.
Azure.Core.Foundations.InnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterJobPositionDetails	작업에 대한 위치 및 예상 대기 시간입니다.

Azure.Core.Foundations.Error

Error 개체.

Name	형식	Description
code	string	서버 정의 오류 코드 집합 중 하나입니다.
details	Azure.Core.Foundations.Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	Azure.Core.Foundations.InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

Azure.Core.Foundations.ErrorResponse

오류 세부 정보가 포함된 응답입니다.

Name	형식	Description
error	Azure.Core.Foundations.Error	Error 개체.

Azure.Core.Foundations.InnerError

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	형식	Description
code	string	서버 정의 오류 코드 집합 중 하나입니다.
innererror	Azure.Core.Foundations.InnerError	내부 오류입니다.

RouterJobPositionDetails

작업에 대한 위치 및 예상 대기 시간입니다.

Name	형식	Description
estimatedWaitTimeMinutes	number	작업의 예상 대기 시간이 가장 가까운 분으로 반올림되었습니다.
jobId	string	이러한 세부 정보에 대한 작업의 ID입니다.
position	integer	해당 큐 내에서 해당 작업의 위치입니다.
queueId	string	이 작업이 큐에 넣은 큐의 ID입니다.
queueLength	integer	큐의 길이: 큐에 넣은 총 작업 수입니다.