Primeiros passos

Início rápido

Envie sua primeira gravação para o Quality Spy e entenda o caminho percorrido até a conclusão da avaliação.

01

Obtenha seu token

A autenticação da API usa Bearer Token. Use o token fornecido para o seu ambiente de integração e envie-o no cabeçalho Authorization.

02

Prepare os metadados

Monte um objeto JSON com os dados que identificam a ocorrência e contextualizam a gravação.

{
  "id": "OCC-001",
  "id_ocorrencia": "CALL-0001",
  "funcionarionome": "João Silva",
  "funcionarioemail": "joao@empresa.com",
  "duracao_gravacao": 320,
  "horario_inicio": "2026-07-09T09:30:00",
  "ocorrencia_descricao": "Cobrança"
}
03

Prepare o arquivo de áudio

metadata não é o áudio. Ele é um campo textual com o JSON da ocorrência. O arquivo de gravação deve ser enviado separadamente no mesmo formulário.

Os dados são enviados como multipart/form-data, contendo os campos metadata e audio.

metadata
JSON serializado com os dados da ocorrência.
audio
Arquivo de gravação enviado como parte do formulário.
04

Faça a requisição

Com o token, os metadados e o arquivo preparados, envie a requisição para o endpoint de recebimento de áudio.

curl -X POST "https://SEU_DOMINIO/api/v1/external-audio" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -F 'metadata={"id":"OCC-001","id_ocorrencia":"CALL-001"}' \
  -F "audio=@gravacao.mp3"
05

Entenda a resposta inicial

A API valida os dados recebidos e registra o recebimento da gravação. O processamento pesado ocorre de maneira assíncrona, depois que a solicitação é aceita para processamento.

06

Aguarde o processamento

Depois do recebimento, a gravação percorre as etapas internas de processamento até que o resultado esteja persistido.

  1. Entrada na fila.
  2. Transcrição do áudio.
  3. Avaliação por IA.
  4. Persistência do resultado.
07

Consulte ou receba o resultado

Ao final do processamento, o sistema integrador pode consultar o resultado ou receber uma notificação por callback, conforme a configuração do ambiente.

Checklist do integrador

  • Token Bearer configurado como variável segura.
  • Metadados montados como JSON válido.
  • Áudio enviado no campo audio do multipart/form-data.
  • Campo metadata enviado separado do arquivo.
  • Fluxo assíncrono considerado pela aplicação integradora.
  • Consulta ou callback alinhado à configuração do ambiente.