> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ipbox.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# getHC1

> <h2>Retorna o relatório HC1 — Histórico de Chamadas da Fila.</h2>

###### Parâmetros obrigatórios:

<table><tbody><tr><td><div><b>de</b></div></td><td><div>Data de início no formato AAAAMMDDHHMMSS (onde AAAA = ano, MM = mês, DD = dia, HH = hora, MM = minuto, SS = segundo. Exemplo: 20260101000000).</div></td></tr><tr><td><div><b>ate</b></div></td><td><div>Data de término no formato AAAAMMDDHHMMSS (onde AAAA = ano, MM = mês, DD = dia, HH = hora, MM = minuto, SS = segundo. Exemplo: 20260101235959).</div></td></tr><tr><td><div><b>fila</b></div></td><td><div>Nome ou ID da fila.</div></td></tr></tbody></table>

###### Parâmetros opcionais:

<table><tbody><tr><td><div>status</div></td><td><div>Filtro por status da chamada. Valores possíveis: AT (Atendida), AB (Abandonada), BF (Abandonada na Fila), BR (Abandonada no Ramal), TR (Transbordo). Se não informado, retorna todas.</div></td></tr><tr><td><div>rna</div></td><td><div>Filtro de toque. Valores possíveis: 1 (Atendidas na primeira tentativa), 2 (Com perda de toque). Se não informado, retorna todas.</div></td></tr><tr><td><div>desligada</div></td><td><div>Filtro por quem desligou. Valores possíveis: A (Agente), C (Cliente). Se não informado, retorna todas.</div></td></tr><tr><td><div>durde</div></td><td><div>Duração mínima da chamada em segundos.</div></td></tr><tr><td><div>durate</div></td><td><div>Duração máxima da chamada em segundos.</div></td></tr><tr><td><div>filade</div></td><td><div>Tempo mínimo de espera na fila em segundos.</div></td></tr><tr><td><div>filaate</div></td><td><div>Tempo máximo de espera na fila em segundos.</div></td></tr></tbody></table>

###### Campos do retorno (cada item em "chamadas"):

<table><tbody><tr><td><div>data</div></td><td><div>Data e hora da chamada (dd/mm/aaaa hh:mm).</div></td></tr><tr><td><div>numero</div></td><td><div>Número do telefone formatado.</div></td></tr><tr><td><div>status</div></td><td><div>Status da chamada: AT (Atendida), BF (Abandonada na Fila), BR (Abandonada no Ramal) ou TR (Transbordo).</div></td></tr><tr><td><div>agente_perdeu_toque</div></td><td><div>Agentes que perderam toque (ring no answer).</div></td></tr><tr><td><div>agente_atendeu</div></td><td><div>Login do agente que atendeu a chamada.</div></td></tr><tr><td><div>tempo_fila</div></td><td><div>Tempo de espera na fila (formatado).</div></td></tr><tr><td><div>tempo_chamada</div></td><td><div>Tempo de duração da chamada (formatado).</div></td></tr><tr><td><div>desligado_por</div></td><td><div>Quem desligou: A (Agente) ou C (Cliente).</div></td></tr><tr><td><div>transbordo_status</div></td><td><div>Status do transbordo (apenas para status TR). Valores: Timeout, Fila Cheia, Sem agentes disponiveis, Agentes ocupados.</div></td></tr><tr><td><div>transbordo_tipo</div></td><td><div>Tipo do destino do transbordo (apenas para status TR). Valores: Fila, Ramal, Ura, Hangup, etc.</div></td></tr><tr><td><div>transbordo_destino</div></td><td><div>Destino do transbordo (apenas para status TR).</div></td></tr><tr><td><div>ura</div></td><td><div>Descrição da ura.</div></td></tr></tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/getHC1
openapi: 3.0.0
info:
  title: IPBoX Api Documentation v1.1
  description: >-
    Nesse documento são descritos os comandos presentes na API Rest do IPBoX. Os
    comandos são executados com chamadas POST e com respostas em formato JSON.
  version: 1.0.0
servers:
  - url: https://{baseUrl}
    description: Dominio (e porta, se houver) do servidor IPBoX do cliente
    variables:
      baseUrl:
        default: cliente.ipboxcloud.com.br:9052
        description: >-
          Substitua pelo dominio real do seu servidor IPBoX. A maioria dos
          servidores usa uma porta especifica - inclua-a junto ao dominio (ex.:
          cliente.ipboxcloud.com.br:9052)
security:
  - ApiToken: []
tags:
  - name: Agente
  - name: Ligações
  - name: Prospects
  - name: Agendamentos
  - name: Listas
  - name: Filas
  - name: Lotes
  - name: Relatórios
  - name: Outros
  - name: Times
  - name: Blacklist
  - name: Áudios
  - name: URAs
paths:
  /ipbox/api/getHC1:
    post:
      tags:
        - Relatórios
      summary: getHC1
      description: >-
        <h2>Retorna o relatório HC1 — Histórico de Chamadas da Fila.</h2>


        ###### Parâmetros obrigatórios:


        <table><tbody><tr><td><div><b>de</b></div></td><td><div>Data de início
        no formato AAAAMMDDHHMMSS (onde AAAA = ano, MM = mês, DD = dia, HH =
        hora, MM = minuto, SS = segundo. Exemplo:
        20260101000000).</div></td></tr><tr><td><div><b>ate</b></div></td><td><div>Data
        de término no formato AAAAMMDDHHMMSS (onde AAAA = ano, MM = mês, DD =
        dia, HH = hora, MM = minuto, SS = segundo. Exemplo:
        20260101235959).</div></td></tr><tr><td><div><b>fila</b></div></td><td><div>Nome
        ou ID da fila.</div></td></tr></tbody></table>


        ###### Parâmetros opcionais:


        <table><tbody><tr><td><div>status</div></td><td><div>Filtro por status
        da chamada. Valores possíveis: AT (Atendida), AB (Abandonada), BF
        (Abandonada na Fila), BR (Abandonada no Ramal), TR (Transbordo). Se não
        informado, retorna
        todas.</div></td></tr><tr><td><div>rna</div></td><td><div>Filtro de
        toque. Valores possíveis: 1 (Atendidas na primeira tentativa), 2 (Com
        perda de toque). Se não informado, retorna
        todas.</div></td></tr><tr><td><div>desligada</div></td><td><div>Filtro
        por quem desligou. Valores possíveis: A (Agente), C (Cliente). Se não
        informado, retorna
        todas.</div></td></tr><tr><td><div>durde</div></td><td><div>Duração
        mínima da chamada em
        segundos.</div></td></tr><tr><td><div>durate</div></td><td><div>Duração
        máxima da chamada em
        segundos.</div></td></tr><tr><td><div>filade</div></td><td><div>Tempo
        mínimo de espera na fila em
        segundos.</div></td></tr><tr><td><div>filaate</div></td><td><div>Tempo
        máximo de espera na fila em segundos.</div></td></tr></tbody></table>


        ###### Campos do retorno (cada item em "chamadas"):


        <table><tbody><tr><td><div>data</div></td><td><div>Data e hora da
        chamada (dd/mm/aaaa
        hh:mm).</div></td></tr><tr><td><div>numero</div></td><td><div>Número do
        telefone
        formatado.</div></td></tr><tr><td><div>status</div></td><td><div>Status
        da chamada: AT (Atendida), BF (Abandonada na Fila), BR (Abandonada no
        Ramal) ou TR
        (Transbordo).</div></td></tr><tr><td><div>agente_perdeu_toque</div></td><td><div>Agentes
        que perderam toque (ring no
        answer).</div></td></tr><tr><td><div>agente_atendeu</div></td><td><div>Login
        do agente que atendeu a
        chamada.</div></td></tr><tr><td><div>tempo_fila</div></td><td><div>Tempo
        de espera na fila
        (formatado).</div></td></tr><tr><td><div>tempo_chamada</div></td><td><div>Tempo
        de duração da chamada
        (formatado).</div></td></tr><tr><td><div>desligado_por</div></td><td><div>Quem
        desligou: A (Agente) ou C
        (Cliente).</div></td></tr><tr><td><div>transbordo_status</div></td><td><div>Status
        do transbordo (apenas para status TR). Valores: Timeout, Fila Cheia, Sem
        agentes disponiveis, Agentes
        ocupados.</div></td></tr><tr><td><div>transbordo_tipo</div></td><td><div>Tipo
        do destino do transbordo (apenas para status TR). Valores: Fila, Ramal,
        Ura, Hangup,
        etc.</div></td></tr><tr><td><div>transbordo_destino</div></td><td><div>Destino
        do transbordo (apenas para status
        TR).</div></td></tr><tr><td><div>ura</div></td><td><div>Descrição da
        ura.</div></td></tr></tbody></table>
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
          example: '{{token}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                de:
                  type: string
                  description: >-
                    [Obrigatório] Data de início no formato AAAAMMDDHHMMSS (onde
                    AAAA = ano, MM = mês, DD = dia, HH = hora, MM = minuto, SS =
                    segundo. Exemplo: 20260101000000).
                  example: de
                ate:
                  type: string
                  description: >-
                    [Obrigatório] Data de término no formato AAAAMMDDHHMMSS
                    (onde AAAA = ano, MM = mês, DD = dia, HH = hora, MM =
                    minuto, SS = segundo. Exemplo: 20260101235959).
                  example: ate
                fila:
                  type: string
                  description: '[Obrigatório] Nome ou ID da fila.'
                  example: fila
                status:
                  type: string
                  description: >-
                    [Opcional] Filtro por status da chamada. Valores possíveis:
                    AT (Atendida), AB (Abandonada), BF (Abandonada na Fila), BR
                    (Abandonada no Ramal), TR (Transbordo). Se não informado,
                    retorna todas.
                  example: status
                rna:
                  type: string
                  description: >-
                    [Opcional] Filtro de toque. Valores possíveis: 1 (Atendidas
                    na primeira tentativa), 2 (Com perda de toque). Se não
                    informado, retorna todas.
                  example: rna
                desligada:
                  type: string
                  description: >-
                    [Opcional] Filtro por quem desligou. Valores possíveis: A
                    (Agente), C (Cliente). Se não informado, retorna todas.
                  example: desligada
                durde:
                  type: string
                  description: '[Opcional] Duração mínima da chamada em segundos.'
                  example: durde
                durate:
                  type: string
                  description: '[Opcional] Duração máxima da chamada em segundos.'
                  example: durate
                filade:
                  type: string
                  description: '[Opcional] Tempo mínimo de espera na fila em segundos.'
                  example: filade
                filaate:
                  type: string
                  description: '[Opcional] Tempo máximo de espera na fila em segundos.'
                  example: filaate
              required:
                - de
                - ate
                - fila
                - status
                - rna
                - desligada
                - durde
                - durate
                - filade
                - filaate
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
components:
  securitySchemes:
    ApiToken:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo
        `Bearer ` / `Basic `.

````