Skip to main content

​
O que é a API do IPBoX

A API do IPBoX permite que sistemas externos (um CRM, uma ferramenta de discagem, um painel próprio) conversem diretamente com o IPBoX: efetuar login/logout de um agente, colocar uma ligação em pausa, consultar prospects, listas, filas, relatórios, e muito mais. Toda a API é acessada por chamadas POST, com resposta em JSON.

​
Passo 1 — Gerar um token de acesso

  1. No IPBoX, acesse IPBoX > API > Token.
  2. Clique em Inserir para criar um novo token.
  3. Copie o token gerado — ele é a sua credencial de acesso e não deve ser compartilhado.

​
Passo 2 — Fazer sua primeira chamada

Cada ação da API tem sua própria URL, no formato https://SEU_DOMINIO_IPBOX:PORTA/ipbox/api/{ação}. O token vai no header Authorization (aceita Bearer SEU_TOKEN, Basic SEU_TOKEN ou o token puro).
A maioria dos servidores IPBoX usa uma porta específica (não a porta padrão 443/HTTPS). Inclua a porta junto ao domínio, do jeito que você acessa o painel — por exemplo: https://cliente.ipboxcloud.com.br:9052/ipbox/api/login.
Exemplo — efetuar login de um agente:
Uma resposta de sucesso tem esse formato:

​
Testando direto pela documentação (botão “Try it”)

Você não precisa usar curl ou Postman para testar — cada endpoint na Referência da API tem um painel de teste embutido, com um botão para enviar a chamada de verdade e ver a resposta na hora.
  1. Abra um endpoint na Referência da API — um bom primeiro teste é o getTime, já que não exige nenhum parâmetro obrigatório e não altera nada (só consulta a lista de times cadastrados).
  2. No painel à direita, preencha a Base URL com o domínio (e a porta!) do seu servidor IPBoX — o mesmo endereço que você usa para acessar o painel.
  3. Em Headers, cole seu token no campo Authorization.
  4. Em Body, o getTime tem só o campo opcional user — pode deixar em branco para listar todos os times, ou preencher com o login de um agente para ver só os times dele.
  5. Clique em Send (ou o botão equivalente de disparar a chamada). A resposta real do servidor aparece logo abaixo, no mesmo painel.
Isso faz uma chamada de rede real contra o servidor que você configurar na Base URL. Evite testar ações que alteram dados (como pauseout, addLote) contra um ambiente de produção com dados reais, a menos que seja intencional.

​
Próximos passos

  • Veja a Referência da API completa, com todos os endpoints disponíveis (login, pausas, prospects, filas, relatórios e mais).
  • Se você quer ser avisado em tempo real quando o estado de um agente muda (sem precisar ficar consultando a API), veja o guia de Webhooks.