# IPBox Docs

- [Documentação IPBox](https://docs.ipbox.com.br/index.md): Guias e referência técnica da API e dos Webhooks do IPBox
- [Primeiros passos com a API](https://docs.ipbox.com.br/guides/primeiros-passos-api.md): Como gerar um token e fazer sua primeira chamada na API do IPBox
- [Webhooks](https://docs.ipbox.com.br/guides/webhooks.md): Receba notificações em tempo real quando o estado de um agente muda
- [Referência técnica do Webhook](https://docs.ipbox.com.br/webhooks/referencia-tecnica.md): Formato do payload, headers, eventos e exemplos de código para integrar o Webhook do IPBox
- [login](https://docs.ipbox.com.br/api-reference/agente/login.md): <h2>Efetua o login do agente no painel do agente.</h2>
- [logout](https://docs.ipbox.com.br/api-reference/agente/logout.md): <h2>Efetua o logout do agente.</h2>
- [pausein](https://docs.ipbox.com.br/api-reference/agente/pausein.md): <h2>Coloca o agente em pausa</h2>.
- [pauseout](https://docs.ipbox.com.br/api-reference/agente/pauseout.md): <h2>Tira o agente da pausa</h2>.
- [getPausaAgente](https://docs.ipbox.com.br/api-reference/agente/getpausaagente.md): <h2>Retorna as pausas dos agentes</h2> <br /> O retorno é referente ao periodo especificado.<br /> Desta forma, o inicio e o fim do período são obrigatórios.<br /> O usuário e a fila são opcionais.
- [getEstado](https://docs.ipbox.com.br/api-reference/agente/getestado.md): <h2>Retorna o estado do agente</h2>
- [getTipoUsuario](https://docs.ipbox.com.br/api-reference/agente/gettipousuario.md): <h2>Retorna o tipo do usuário</h2>
- [changeTipoUsuario](https://docs.ipbox.com.br/api-reference/agente/changetipousuario.md): <h2>Altera o tipo do usuário</h2>
- [listarUsuarios](https://docs.ipbox.com.br/api-reference/agente/listarusuarios.md): ## Retorna lista de usuários ativos.
- [redefinirSenhaUsuario](https://docs.ipbox.com.br/api-reference/agente/redefinirsenhausuario.md): ## Redefine a senha do usuário
- [getUserWssCredentials](https://docs.ipbox.com.br/api-reference/agente/getuserwsscredentials.md): ## Obtém dados de conexão do webphone
- [dial](https://docs.ipbox.com.br/api-reference/ligações/dial.md): <h2>Disca um número e encaminha a ligação para o agente quando atendida.</h2>
- [discarParaRamal](https://docs.ipbox.com.br/api-reference/ligações/discarpararamal.md): <h2>Disca um número e encaminha a ligação para o agente que está logado no ramal indicadao.</h2>
- [desligarLigacao](https://docs.ipbox.com.br/api-reference/ligações/desligarligacao.md): <h2>Desliga a ligação em atendimento pelo agente.</h2>
- [classificarLigacao](https://docs.ipbox.com.br/api-reference/ligações/classificarligacao.md): <h2>Classifica a última ligação atendida pelo agente.</h2>
- [getResult](https://docs.ipbox.com.br/api-reference/ligações/getresult.md): <h2>Retorna os resultados da ligação</h2> <br />
- [getResultadoLigacao](https://docs.ipbox.com.br/api-reference/ligações/getresultadoligacao.md): <h2>Retorna a lista de resultados de ligação da fila.</h2>
- [retornoDiscador](https://docs.ipbox.com.br/api-reference/ligações/retornodiscador.md): ## Retorna o status de cada uma das tentativas de ligação do discador no período especificado.
- [getLigacaoAtiva](https://docs.ipbox.com.br/api-reference/ligações/getligacaoativa.md): <h2>Retorna dados da ligação ativa no IP especificado.</h2>
- [getLigacaoAtivaByRamal](https://docs.ipbox.com.br/api-reference/ligações/getligacaoativabyramal.md): <h2>Retorna dados da ligação ativa no ramal especificado.</h2>
- [getGravacao](https://docs.ipbox.com.br/api-reference/ligações/getgravacao.md): <h2> Retorna a gravação da ligação especificada.</h2>
- [insertProspect](https://docs.ipbox.com.br/api-reference/prospects/insertprospect.md): <h2>Insere um novo prospect no lote especificado.</h2> <br />  Ao menos um dos três campos abaixo deve ser informado:<br /> <ul> <li style="list-style-type: circle;">foneres</li> <li style="list-style-type: circle;">fonecel</li> <li style="list-style-type: circle;">fonecom</li> </ul>
- [getProspectLote](https://docs.ipbox.com.br/api-reference/prospects/getprospectlote.md): <h2>Retorna lista de prospects do lote especificado.</h2>
- [getDadosProspectSemClassificacao](https://docs.ipbox.com.br/api-reference/prospects/getdadosprospectsemclassificacao.md): <h2>Retorna os dados do ultimo prospect atendido pelo operador sem classificação.</h2>
- [getDadosProspectEmAtendimento](https://docs.ipbox.com.br/api-reference/prospects/getdadosprospectematendimento.md): <h2>Retorna os dados do prospect em atendimento ou da última ligação atendida pelo operador especificado.</h2>
- [getHistoricoProspect](https://docs.ipbox.com.br/api-reference/prospects/gethistoricoprospect.md): <h2>Retorna os números discados para o(s) prospect(s) informados</h2> <br /> O código e/ou o cpf devem ser informados obrigatoriamente.
- [getExcluidos](https://docs.ipbox.com.br/api-reference/prospects/getexcluidos.md): <h2>Retorna a lista de códigos de prospects excluídos na data especificada.</h2>
- [getSituacaoProspectLote](https://docs.ipbox.com.br/api-reference/prospects/getsituacaoprospectlote.md): <h2>Retorna a quantidade de prospect para cada situação</h2>
- [addMailing](https://docs.ipbox.com.br/api-reference/prospects/addmailing.md): <h2>Importa no lote especificado os prospects contidos no arquivo csv enviado.</h2>
- [importMailing](https://docs.ipbox.com.br/api-reference/prospects/importmailing.md): <h2>Importa no lote especificado os prospects contidos no arquivo csv enviado. Os prospects existentes são apagados quando uma nova importação é feita.</h2>
- [getStatusImportacao](https://docs.ipbox.com.br/api-reference/prospects/getstatusimportacao.md): Obtém o status da importação do mailing. Informar o Id da importação retornado pelo método addMailing ou importMailing.
- [classificarProspect](https://docs.ipbox.com.br/api-reference/prospects/classificarprospect.md): <h2>Classifica o prospect.</h2>
- [reciclarProspect](https://docs.ipbox.com.br/api-reference/prospects/reciclarprospect.md): Define a reciclagem de prospects de um ou mais lotes. O destino pode ser um lote ou um arquivo csv. A reciclagem é colocada em uma fila de execução. Para consultar o status da reciclagem usar o método getStatusReciclagem.
- [getStatusReciclagem](https://docs.ipbox.com.br/api-reference/prospects/getstatusreciclagem.md): Obtém o status da reciclagem. Informar o Id da reciclagem retornado pelo método reciclarProspect.
- [getAgendamentos](https://docs.ipbox.com.br/api-reference/agendamentos/getagendamentos.md): <h2>Obtém os agendamentos do usuário especificado.</h2>
- [alterarAgendamento](https://docs.ipbox.com.br/api-reference/agendamentos/alteraragendamento.md): <h2>Altera a data, tipo e/ou o usuário do agendamento especificado.</h2>
- [cancelarAgendamento](https://docs.ipbox.com.br/api-reference/agendamentos/cancelaragendamento.md): <h2>Cancela o agendamento especificado.</h2>
- [getLotesAtivos](https://docs.ipbox.com.br/api-reference/listas/getlotesativos.md): <h2>Retorna lista de lotes ativos</h2>
- [getPausa](https://docs.ipbox.com.br/api-reference/listas/getpausa.md): <h2>Retorna lista de pausas</h2>
- [getAbandonadasFila](https://docs.ipbox.com.br/api-reference/filas/getabandonadasfila.md): <h2>Retorna a quantidade de ligações abandonadas na fila, no ramal com atendimento e no ramal sem atendimento, no período especificado.</h2>
- [getFilas](https://docs.ipbox.com.br/api-reference/filas/getfilas.md): <h2>Obtem a lista de filas.</h2>
- [criarFilaAtiva](https://docs.ipbox.com.br/api-reference/filas/criarfilaativa.md): ## Cria uma fila ativa.
- [criarFilaReceptiva](https://docs.ipbox.com.br/api-reference/filas/criarfilareceptiva.md): ## Cria uma fila receptiva.
- [desativarFila](https://docs.ipbox.com.br/api-reference/filas/desativarfila.md): ## Desativa uma fila.
- [addTimeToFila](https://docs.ipbox.com.br/api-reference/filas/addtimetofila.md): ## Adiciona um time a uma fila.
- [removeTimeFromFila](https://docs.ipbox.com.br/api-reference/filas/removetimefromfila.md): ## Remove um time da fila.
- [changeLoteToFila](https://docs.ipbox.com.br/api-reference/filas/changelotetofila.md): ## Muda um lote de fila.
- [addResultadoLigacao](https://docs.ipbox.com.br/api-reference/filas/addresultadoligacao.md): Cadastra um novo resultado de ligação.
- [addResultadoLigacaoCsv](https://docs.ipbox.com.br/api-reference/filas/addresultadoligacaocsv.md): Cadastra resultados de ligação em lote a partir de um arquivo CSV.
- [addLote](https://docs.ipbox.com.br/api-reference/lotes/addlote.md): <h2>Cria novo lote.</h2>
- [setStatusLote](https://docs.ipbox.com.br/api-reference/lotes/setstatuslote.md): <h2>Seta o status do lote.</h2>
- [getStatusLote](https://docs.ipbox.com.br/api-reference/lotes/getstatuslote.md): <h2>Obtém o status do lote.</h2>
- [desativarLote](https://docs.ipbox.com.br/api-reference/lotes/desativarlote.md): ## Desativa um lote.
- [getTAQ1](https://docs.ipbox.com.br/api-reference/relatórios/gettaq1.md): <h2>Retorna o relatório TAQ1.</h2>
- [getRPQ1](https://docs.ipbox.com.br/api-reference/relatórios/getrpq1.md): <h2>Retorna o relatório RPQ1.</h2>
- [getTA1](https://docs.ipbox.com.br/api-reference/relatórios/getta1.md): <h2>Retorna o relatório TA1.</h2>
- [getTA2](https://docs.ipbox.com.br/api-reference/relatórios/getta2.md): <h2>Retorna o relatório TA2.</h2>
- [getDOQ1](https://docs.ipbox.com.br/api-reference/relatórios/getdoq1.md): <h2>Retorna o relatório DOQ1.</h2>
- [getRA1](https://docs.ipbox.com.br/api-reference/relatórios/getra1.md): <h2>Retorna o relatório de aproveitamento por operação (RA1).</h2>
- [getRA2](https://docs.ipbox.com.br/api-reference/relatórios/getra2.md): <h2>Retorna o relatório de aproveitamento por fila (RA2).</h2>
- [getRA3](https://docs.ipbox.com.br/api-reference/relatórios/getra3.md): <h2>Retorna o relatório de aproveitamento por time (RA3).</h2>
- [getRA4](https://docs.ipbox.com.br/api-reference/relatórios/getra4.md): <h2>Retorna o relatório de aproveitamento por agente (RA4).</h2>
- [getRQ4](https://docs.ipbox.com.br/api-reference/relatórios/getrq4.md): <h2>Retorna o Relatório de Resultado de Classificação de Chamadas - Agentes (Qualitativo)</h2>
- [getPA1](https://docs.ipbox.com.br/api-reference/relatórios/getpa1.md): <h2>Retorna o relatório de produtividade de agentes (PA1).</h2>
- [getEA1](https://docs.ipbox.com.br/api-reference/relatórios/getea1.md): <h2>Retorna o relatório de Estatísticas de Agentes (EA1).</h2>
- [getUOP1](https://docs.ipbox.com.br/api-reference/relatórios/getuop1.md): <h2>Retorna o relatório UOP1 (RELATÓRIO DE OPÇÕES DA URA RECEPTIVA)</h2>
- [getUDR1](https://docs.ipbox.com.br/api-reference/relatórios/getudr1.md): <h2>Retorna o relatório UDR1 (RELATÓRIO DE DURAÇÃO DE MENSAGEM DA URA RECEPTIVA)</h2>
- [getFP1](https://docs.ipbox.com.br/api-reference/relatórios/getfp1.md): ## Retorna o FP1 - Relatório de Fichas Preenchidas
- [getHC1](https://docs.ipbox.com.br/api-reference/relatórios/gethc1.md): <h2>Retorna o relatório HC1 — Histórico de Chamadas da Fila.</h2>
- [getHC2](https://docs.ipbox.com.br/api-reference/relatórios/gethc2.md): <h2>Retorna o relatório HC2 — Histórico de Chamadas de Ramais/Agentes.</h2>
- [getRE1](https://docs.ipbox.com.br/api-reference/relatórios/getre1.md): Retorna o relatório RE1 - Estatísticas de Roteamento de Entrada.
- [getRE2](https://docs.ipbox.com.br/api-reference/relatórios/getre2.md): Retorna o relatório RE2 - Chamadas de Roteamento de Entrada.
- [setStatusFicha](https://docs.ipbox.com.br/api-reference/outros/setstatusficha.md): <h2>Atualiza o status da ficha para o status informado.</h2>
- [criarTime](https://docs.ipbox.com.br/api-reference/times/criartime.md): ## Cria um time.
- [desativarTime](https://docs.ipbox.com.br/api-reference/times/desativartime.md): ## Desativa um time.
- [addAgenteToTime](https://docs.ipbox.com.br/api-reference/times/addagentetotime.md): ## Adiciona um agente a um time.
- [removeAgenteFromTime](https://docs.ipbox.com.br/api-reference/times/removeagentefromtime.md): ## Remove agente do time.
- [getTime](https://docs.ipbox.com.br/api-reference/times/gettime.md): <h2>Retorna lista de times</h2>
- [inserirNumeroBlacklist](https://docs.ipbox.com.br/api-reference/blacklist/inserirnumeroblacklist.md): Insere um número na blacklist de discagem. Se informada a fila, será adicionado na blacklist da fila informada; senão, será adicionado na blacklist geral (todas as filas).
- [removerNumeroBlacklist](https://docs.ipbox.com.br/api-reference/blacklist/removernumeroblacklist.md): Remove um número da blacklist de discagem. Se informada a fila, será removido da blacklist da fila informada; senão, será removido da blacklist geral (todas as filas).
- [isNumeroBlacklisted](https://docs.ipbox.com.br/api-reference/blacklist/isnumeroblacklisted.md): Checa se o número está na blacklist. Se estiver, são informadas as blacklists de quais filas o número está inserido.
- [listarAudios](https://docs.ipbox.com.br/api-reference/áudios/listaraudios.md): <h2>Retorna lista de áudios</h2>
- [inserirAudio](https://docs.ipbox.com.br/api-reference/áudios/inseriraudio.md): Insere um novo áudio. Devem ser fornecidos um arquivo de áudio no formato wav, mp3 ou sln, e uma descrição.
- [alterarAudio](https://docs.ipbox.com.br/api-reference/áudios/alteraraudio.md): Altera o arquivo de um aúdio existente. O arquivo deve ser no formato wav, mp3 ou sln. Opcionalmente, podem ser alterados a descrição e o formato.
- [desativarAudio](https://docs.ipbox.com.br/api-reference/áudios/desativaraudio.md): Desativa um áudio. Informar o id do áudio a ser desativado.
- [listarUras](https://docs.ipbox.com.br/api-reference/uras/listaruras.md): Retorna a lista de uras.
- [alterarAudioUra](https://docs.ipbox.com.br/api-reference/uras/alteraraudioura.md): Altera um áudio da lista de áudios iniciais da ura. Altera apenas o tipo áudio. Tipos tts e saudação não podem ser alterados usando esse método.
- [recarregarUra](https://docs.ipbox.com.br/api-reference/uras/recarregarura.md): Recarrega a configuração das uras.
- [criarUra](https://docs.ipbox.com.br/api-reference/uras/criarura.md): # criarUra

## OpenAPI Specs

- [openapi](/openapi.yaml)