Job Router Operations - Decline Job Offer

サービス:

Communication

API バージョン:

2023-11-01

ジョブで作業するオファーを拒否します。

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

URI パラメーター

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

要求本文

名前	型	説明
retryOfferAt	string	RetryOfferAt が指定されていない場合、ワーカーが登録解除されて再登録されない限り、このジョブを拒否したワーカーにこのジョブは再び提供されません。 RetryOfferAt 時刻が指定されている場合、ジョブは UTC の再試行時刻に対象のワーカーと再照合されます。 ジョブを辞退したワーカーも、その時点でジョブの対象となります。

応答

名前	型	説明
200 OK	object	要求は成功しました。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。 ヘッダー x-ms-error-code: string

例

Declines an offer to work on a job

要求のサンプル

HTTP

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

{
  "retryOfferAt": "2023-05-26T00:00:00.0000000Z"
}

応答のサンプル

状態コード:

200

{}

定義

名前	説明
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。
DeclineJobOfferOptions	オファーを拒否するための要求ペイロード。

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	内部エラー。

DeclineJobOfferOptions

オファーを拒否するための要求ペイロード。

名前	型	説明
retryOfferAt	string	RetryOfferAt が指定されていない場合、ワーカーが登録解除されて再登録されない限り、このジョブを拒否したワーカーにこのジョブは再び提供されません。 RetryOfferAt 時刻が指定されている場合、ジョブは UTC の再試行時刻に対象のワーカーと再照合されます。 ジョブを辞退したワーカーも、その時点でジョブの対象となります。