Compartir a través de

Job Router Operations - Get In Queue Position

  • Referencia
Servicio:
Communication
Versión de la API:
2023-11-01

Obtiene los detalles de la posición de un trabajo.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string

Uri del recurso de comunicación
jobId
 path True

string

Identificador del trabajo.
api-version
 query True

string

Versión de la API que se va a usar para esta operación.

Respuestas

Nombre Tipo Description
200 OK

RouterJobPositionDetails

La solicitud se ha realizado correctamente.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

AadOauth2Auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

Nombre Description
https://communication.azure.com/.default

Ejemplos

Gets a job's position details

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
Azure.Core.Foundations.Error

Objeto de error.
Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
RouterJobPositionDetails

Posición y tiempo de espera estimado para un trabajo.

Azure.Core.Foundations.Error

Objeto de error.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.
details

Azure.Core.Foundations.Error[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica que el objeto actual sobre el error.
message

string

Representación legible del error.
target

string

Destino del error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre Tipo Description
error

Azure.Core.Foundations.Error

Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.
innererror

Azure.Core.Foundations.InnerError

Error interno.

RouterJobPositionDetails

Posición y tiempo de espera estimado para un trabajo.

Nombre Tipo Description
estimatedWaitTimeMinutes

number

Tiempo de espera estimado del trabajo redondeado hasta el minuto más cercano.
jobId

string

Identificador del trabajo sobre el que se tratan estos detalles.
position

integer

Posición del trabajo en cuestión dentro de esa cola.
queueId

string

Identificador de la cola en la que se pone en cola este trabajo.
queueLength

integer

Longitud de la cola: número total de trabajos en cola.