Job Router Operations - Accept Job Offer

服務:

Communication

API 版本:

2023-11-01

接受在作業上工作的供應專案，如果另一個代理程序已經接受作業，則會傳回 409/Conflict。

POST {endpoint}/routing/workers/{workerId}/offers/{offerId}:accept?api-version=2023-11-01

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	通訊資源的 URI
offerId	path	True	string	供應項目的標識碼。
workerId	path	True	string	背景工作角色的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	AcceptJobOfferResult	要求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

AadOauth2Auth

Azure Active Directory OAuth2 流程

類型: oauth2
Flow: accessCode
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize
權杖 URL: https://login.microsoftonline.com/common/oauth2/token

範圍

名稱	Description
https://communication.azure.com/.default

範例

Accepts an offer to work on a job

範例要求

HTTP

POST https://contoso.westus.communications.azure.com/routing/workers/DefaultWorker/offers/1d5896f3-8b54-40be-82d3-910323f5e2af:accept?api-version=2023-11-01

範例回覆

狀態碼:

200

{
  "assignmentId": "246d5a06-c04a-4b6b-8a34-02bbd9fdad68",
  "jobId": "632f5345-220b-4e46-b31f-aeaf03cc2df9",
  "workerId": "DefaultWorker"
}

定義

名稱	Description
AcceptJobOfferResult	包含已接受供應專案之背景工作、作業和指派標識碼的回應。
Azure.Core.Foundations.Error	error 物件。
Azure.Core.Foundations.ErrorResponse	包含錯誤詳細數據的回應。
Azure.Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

AcceptJobOfferResult

包含已接受供應專案之背景工作、作業和指派標識碼的回應。

名稱	類型	Description
assignmentId	string	指派已接受作業供應專案之背景工作的工作指派標識符。
jobId	string	指派之作業的標識碼。
workerId	string	已指派此作業的背景工作識別碼。

Azure.Core.Foundations.Error

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。