Job Router Operations - Get In Queue Position

Service:

Communication

Version d'API:

2023-11-01

Obtient les détails de la position d’un travail.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URI de votre ressource communication
jobId	path	True	string	ID du travail.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	RouterJobPositionDetails	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

Gets a job's position details

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

200

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

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.
RouterJobPositionDetails	Position et temps d’attente estimé pour un travail.

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.

RouterJobPositionDetails

Position et temps d’attente estimé pour un travail.

Nom	Type	Description
estimatedWaitTimeMinutes	number	Temps d’attente estimé du travail arrondi à la minute la plus proche.
jobId	string	ID du travail dont il s’agit.
position	integer	Position du travail en question dans cette file d’attente.
queueId	string	ID de la file d’attente dans laquelle ce travail est mis en file d’attente.
queueLength	integer	Longueur de la file d’attente : nombre total de travaux mis en file d’attente.