Job Router Operations - Close Job

Serviço:

Communication

Versão da API:

2023-11-01

Fecha uma tarefa concluída.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
assignmentId	path	True	string	ID de uma tarefa.
endpoint	path	True	string	Uri do recurso de Comunicação
jobId	path	True	string	ID de um trabalho.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
closeAt	string	Se não for fornecido, a capacidade de trabalho é lançada imediatamente juntamente com uma notificação JobClosedEvent. Se for fornecido, a capacidade de trabalho é lançada juntamente com uma notificação JobClosedEvent numa hora futura em UTC.
dispositionCode	string	Indica o resultado de uma tarefa, preencha este campo com os seus próprios valores personalizados.
note	string	Uma nota que será anexada à coleção notas de uma tarefa com o carimbo de data/hora atual.

Respostas

Name	Tipo	Description
200 OK	object	O pedido foi bem-sucedido.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Exemplos

Closes a completed job

Pedido de amostra

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

Resposta da amostra

Código de estado:

200

{}

Definições

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes de erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CloseJobOptions	Pedir payload para fechar tarefas

Azure.Core.Foundations.Error

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta que contém detalhes de erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

CloseJobOptions

Pedir payload para fechar tarefas

Name	Tipo	Description
closeAt	string	Se não for fornecido, a capacidade de trabalho é lançada imediatamente juntamente com uma notificação JobClosedEvent. Se for fornecido, a capacidade de trabalho é lançada juntamente com uma notificação JobClosedEvent numa hora futura em UTC.
dispositionCode	string	Indica o resultado de uma tarefa, preencha este campo com os seus próprios valores personalizados.
note	string	Uma nota que será anexada à coleção notas de uma tarefa com o carimbo de data/hora atual.