Job Router Operations - Close Job

Servicio:

Communication

Versión de la API:

2023-11-01

Cierra un trabajo completado.

POST {endpoint}/routing/jobs/{jobId}/assignments/{assignmentId}:close?api-version=2023-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
assignmentId	path	True	string	Identificador de una asignación de trabajo.
endpoint	path	True	string	Uri del recurso de comunicación
jobId	path	True	string	Identificador de un trabajo.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
closeAt	string	Si no se proporciona, la capacidad de trabajo se libera inmediatamente junto con una notificación JobClosedEvent. Si se proporciona, se libera la capacidad de trabajo junto con una notificación JobClosedEvent en una hora futura en UTC.
dispositionCode	string	Indica el resultado de un trabajo y rellena este campo con sus propios valores personalizados.
note	string	Nota que se anexará a la colección Notes de un trabajo con la marca de tiempo actual.

Respuestas

Nombre	Tipo	Description
200 OK	object	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Ejemplos

Closes a completed job

Solicitud de ejemplo

HTTP

POST https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958/assignments/1d5896f3-8b54-40be-82d3-910323f5e2af:close?api-version=2023-11-01

{
  "dispositionCode": "JobCompleted.",
  "note": "Closing job"
}

Respuesta de muestra

status code:

200

{}

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.
CloseJobOptions	Solicitud de carga para cerrar trabajos

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.

CloseJobOptions

Solicitud de carga para cerrar trabajos

Nombre	Tipo	Description
closeAt	string	Si no se proporciona, la capacidad de trabajo se libera inmediatamente junto con una notificación JobClosedEvent. Si se proporciona, se libera la capacidad de trabajo junto con una notificación JobClosedEvent en una hora futura en UTC.
dispositionCode	string	Indica el resultado de un trabajo y rellena este campo con sus propios valores personalizados.
note	string	Nota que se anexará a la colección Notes de un trabajo con la marca de tiempo actual.