ListCallAnalyticsJobs - Transcribe
Sintaxe da solicitaçãoParâmetros de solicitaçãoSintaxe da respostaElementos de respostaErrosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

ListCallAnalyticsJobs

Fornece uma lista de trabalhos de Call Analytics que correspondem aos critérios especificados. Se não houver critérios especificados, todas as tarefas do Call Analytics serão retornadas.

Para obter informações detalhadas sobre uma tarefa específica do Call Analytics, use aGetCallAnalyticsJob operação.

Sintaxe da solicitação

{
   "JobNameContains": "string",
   "MaxResults": number,
   "NextToken": "string",
   "Status": "string"
}

Parâmetros de solicitação

Para obter informações sobre os parâmetros que são comuns a todas as ações, consulte Parâmetros comuns.

A solicitação aceita os dados a seguir no formato JSON.

JobNameContains

Retorna somente os trabalhos do Call Analytics que contêm a string especificada. A pesquisa não diferencia maiúsculas de minúsculas.

Tipo: String

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 200.

Padrão: ^[0-9a-zA-Z._-]+

Obrigatório: não

MaxResults

O número máximo de trabalhos de Call Analytics a serem retornados em cada página de resultados. Se houver menos resultados do que o valor especificado, somente os resultados reais serão retornados. Se você não especificar um valor, será usado um valor padrão de 5.

Tipo: inteiro

Faixa válida: valor mínimo de 1. Valor máximo de 100.

Obrigatório: não

NextToken

Se suaListCallAnalyticsJobs solicitação retornar mais resultados do que os que podem ser exibidos,NextToken será exibida na resposta com uma string associada. Para obter a próxima página de resultados, copie essa string e repita sua solicitação, inclusiveNextToken com o valor da string copiada. Repita conforme necessário para ver todos os resultados.

Tipo: String

Restrições de tamanho: tamanho máximo de 8192.

Padrão: .+

Obrigatório: não

Status

Retorna somente trabalhos do Call Analytics com o status especificado. Os trabalhos são ordenados por data de criação, com o trabalho mais novo primeiro. Se você não incluirStatus, todos os trabalhos do Call Analytics serão devolvidos.

Tipo: String

Valores válidos: QUEUED | IN_PROGRESS | FAILED | COMPLETED

Obrigatório: não

Sintaxe da resposta

{
   "CallAnalyticsJobSummaries": [ 
      { 
         "CallAnalyticsJobName": "string",
         "CallAnalyticsJobStatus": "string",
         "CompletionTime": number,
         "CreationTime": number,
         "FailureReason": "string",
         "LanguageCode": "string",
         "StartTime": number
      }
   ],
   "NextToken": "string",
   "Status": "string"
}

Elementos de resposta

Se a ação for bem-sucedida, o serviço reenviará uma resposta HTTP 200.

Os seguintes dados são retornados no formato JSON pelo serviço.

CallAnalyticsJobSummaries

Fornece um resumo das informações sobre cada resultado.

Tipo: matriz de objetos CallAnalyticsJobSummary

NextToken

SeNextToken estiver presente em sua resposta, isso indica que nem todos os resultados são exibidos. Para ver o próximo conjunto de resultados, copie a string associada aoNextToken parâmetro na saída de resultados e execute sua solicitação novamente, inclusiveNextToken com o valor da string copiada. Repita conforme necessário para ver todos os resultados.

Tipo: String

Restrições de tamanho: tamanho máximo de 8192.

Padrão: .+

Status

Lista todas as tarefas do Call Analytics que têm o status especificado em sua solicitação. Os trabalhos são ordenados por data de criação, com o trabalho mais novo primeiro.

Tipo: String

Valores válidos: QUEUED | IN_PROGRESS | FAILED | COMPLETED

Erros

Para obter informações sobre os erros comuns a todas as ações, consulteErros comuns.

BadRequestException

Sua solicitação não passou em um ou mais testes de validação. Isso pode ocorrer quando a entidade que você está tentando excluir não existe ou está em um estado não terminal (comoIN PROGRESS). Consulte o campo da mensagem de exceção para obter mais informações.

Código de status HTTP: 400

InternalFailureException

Ocorreu um erro interno. Verifique a mensagem de erro, corrija o problema e tente fazer sua solicitação novamente.

Código de status HTTP: 500

LimitExceededException

Você enviou muitas solicitações ou seu arquivo de entrada é muito longo. Aguarde antes de tentar novamente sua solicitação ou use um arquivo menor e tente fazer sua solicitação novamente.

Código de status HTTP: 400

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte: