Job Router Operations - Decline Job Offer

Service:

Communication

Version d'API:

2023-11-01

Refuse une offre de travail.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URI de votre ressource communication
offerId	path	True	string	ID d’une offre.
workerId	path	True	string	ID d’un worker.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
retryOfferAt	string	Si retryOfferAt n’est pas fourni, ce travail ne sera pas à nouveau proposé au travailleur qui a refusé ce travail, sauf s’il est désinscrit et réinscrit. Si une heure RetryOfferAt est fournie, le travail est re-mis en correspondance avec les travailleurs éligibles à l’heure de nouvelle tentative utc. Le travailleur qui a refusé le travail sera également éligible pour le travail à ce moment-là.

Réponses

Nom	Type	Description
200 OK	object	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Exemples

Declines an offer to work on a job

Exemple de requête

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"
}

Exemple de réponse

Code d’état:

200

{}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet error.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DeclineJobOfferOptions	Charge utile de la demande pour les offres déclinantes.

Azure.Core.Foundations.Error

Objet error.

Nom	Type	Description
code	string	Un des ensembles de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet error.

Azure.Core.Foundations.InnerError

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	string	Un des ensembles de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

DeclineJobOfferOptions

Charge utile de la demande pour les offres déclinantes.

Nom	Type	Description
retryOfferAt	string	Si retryOfferAt n’est pas fourni, ce travail ne sera pas à nouveau proposé au travailleur qui a refusé ce travail, sauf s’il est désinscrit et réinscrit. Si une heure RetryOfferAt est fournie, le travail est re-mis en correspondance avec les travailleurs éligibles à l’heure de nouvelle tentative utc. Le travailleur qui a refusé le travail sera également éligible pour le travail à ce moment-là.