Job Router Operations - Get In Queue Position

サービス:

Communication

API バージョン:

2023-11-01

ジョブの位置の詳細を取得します。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	Communication リソースの URI
jobId	path	True	string	ジョブの ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
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
}

定義

名前	説明
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 オブジェクト。

名前	型	説明
code	string	サーバー定義のエラー コードのセットの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

エラーの詳細を含む応答。

名前	型	説明
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。

名前	型	説明
code	string	サーバー定義のエラー コードのセットの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

RouterJobPositionDetails

ジョブの位置と推定待機時間。

名前	型	説明
estimatedWaitTimeMinutes	number	ジョブの推定待機時間は、最も近い分に切り上げられます。
jobId	string	これらの詳細に関するジョブの ID。
position	integer	そのキュー内の問題のジョブの位置。
queueId	string	このジョブがエンキューされるキューの ID。
queueLength	integer	キューの長さ: エンキューされたジョブの合計数。