> ## 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.

# getHC2

> <h2>Retorna o relatório HC2 — Histórico de Chamadas de Ramais/Agentes.</h2>

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

<table><tbody><tr><td><b>de</b></td><td>Data de início no formato AAAAMMDDHHMMSS (onde AAAA = ano, MM = mês, DD = dia, HH = hora, MM = minuto, SS = segundo. Exemplo: 20260101000000).</td></tr><tr><td><b>ate</b></td><td>Data de término no formato AAAAMMDDHHMMSS (onde AAAA = ano, MM = mês, DD = dia, HH = hora, MM = minuto, SS = segundo. Exemplo: 20260101235959).</td></tr><tr><td><b>tipo_entidade</b></td><td>Tipo da entidade a consultar. Valores possíveis: RS (Ramal SIP), RP (Ramal PJSIP), RI (Ramal IAX), RK (Ramal KHOMP), A (Agente).</td></tr><tr><td><b>ramal_agente</b></td><td>Número do ramal ou login/ID do agente, conforme o tipo_entidade informado.</td></tr></tbody></table>

###### Parâmetros opcionais:

<table><tbody><tr><td>tipo</td><td>Direção das chamadas. Valores possíveis: G (Geradas), R (Recebidas). Se não informado ou vazio, retorna todas.</td></tr></tbody></table>

###### Campos do retorno (envelope):

<table><tbody><tr><td>ramal_agente</td><td>Label do ramal (ex: SIP/1001) ou login do agente consultado.</td></tr><tr><td>de</td><td>Data de início da consulta (dd/mm/aaaa hh:mm).</td></tr><tr><td>ate</td><td>Data de término da consulta (dd/mm/aaaa hh:mm).</td></tr><tr><td>total</td><td>Total de chamadas retornadas.</td></tr><tr><td>chamadas</td><td>Array com as chamadas encontradas.</td></tr></tbody></table>

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

<table><tbody><tr><td>horario</td><td>Data e hora da chamada (aaaa-mm-dd hh:mm:ss).</td></tr><tr><td>tipo</td><td>Direção da chamada: Gerada ou Recebida.</td></tr><tr><td>numero</td><td>Número do telefone da outra parte, formatado.</td></tr><tr><td>duracao_segundos</td><td>Duração da chamada em segundos (inteiro).</td></tr><tr><td>duracao</td><td>Duração da chamada formatada (hh:mm:ss).</td></tr><tr><td>desligada_por</td><td>Código de quem encerrou a chamada.</td></tr><tr><td>protocolo</td><td>Protocolo da chamada.</td></tr></tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/getHC2
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/getHC2:
    post:
      tags:
        - Relatórios
      summary: getHC2
      description: >-
        <h2>Retorna o relatório HC2 — Histórico de Chamadas de
        Ramais/Agentes.</h2>


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


        <table><tbody><tr><td><b>de</b></td><td>Data de início no formato
        AAAAMMDDHHMMSS (onde AAAA = ano, MM = mês, DD = dia, HH = hora, MM =
        minuto, SS = segundo. Exemplo:
        20260101000000).</td></tr><tr><td><b>ate</b></td><td>Data de término no
        formato AAAAMMDDHHMMSS (onde AAAA = ano, MM = mês, DD = dia, HH = hora,
        MM = minuto, SS = segundo. Exemplo:
        20260101235959).</td></tr><tr><td><b>tipo_entidade</b></td><td>Tipo da
        entidade a consultar. Valores possíveis: RS (Ramal SIP), RP (Ramal
        PJSIP), RI (Ramal IAX), RK (Ramal KHOMP), A
        (Agente).</td></tr><tr><td><b>ramal_agente</b></td><td>Número do ramal
        ou login/ID do agente, conforme o tipo_entidade
        informado.</td></tr></tbody></table>


        ###### Parâmetros opcionais:


        <table><tbody><tr><td>tipo</td><td>Direção das chamadas. Valores
        possíveis: G (Geradas), R (Recebidas). Se não informado ou vazio,
        retorna todas.</td></tr></tbody></table>


        ###### Campos do retorno (envelope):


        <table><tbody><tr><td>ramal_agente</td><td>Label do ramal (ex: SIP/1001)
        ou login do agente consultado.</td></tr><tr><td>de</td><td>Data de
        início da consulta (dd/mm/aaaa hh:mm).</td></tr><tr><td>ate</td><td>Data
        de término da consulta (dd/mm/aaaa
        hh:mm).</td></tr><tr><td>total</td><td>Total de chamadas
        retornadas.</td></tr><tr><td>chamadas</td><td>Array com as chamadas
        encontradas.</td></tr></tbody></table>


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


        <table><tbody><tr><td>horario</td><td>Data e hora da chamada (aaaa-mm-dd
        hh:mm:ss).</td></tr><tr><td>tipo</td><td>Direção da chamada: Gerada ou
        Recebida.</td></tr><tr><td>numero</td><td>Número do telefone da outra
        parte, formatado.</td></tr><tr><td>duracao_segundos</td><td>Duração da
        chamada em segundos (inteiro).</td></tr><tr><td>duracao</td><td>Duração
        da chamada formatada
        (hh:mm:ss).</td></tr><tr><td>desligada_por</td><td>Código de quem
        encerrou a chamada.</td></tr><tr><td>protocolo</td><td>Protocolo da
        chamada.</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
                tipo_entidade:
                  type: string
                  description: >-
                    [Obrigatório] Tipo da entidade a consultar. Valores
                    possíveis: RS (Ramal SIP), RP (Ramal PJSIP), RI (Ramal IAX),
                    RK (Ramal KHOMP), A (Agente).
                  example: tipo_entidade
                ramal_agente:
                  type: string
                  description: >-
                    [Obrigatório] Número do ramal ou login/ID do agente,
                    conforme o tipo_entidade informado.
                  example: ramal_agente
                tipo:
                  type: string
                  description: >-
                    [Opcional] Direção das chamadas. Valores possíveis: G
                    (Geradas), R (Recebidas). Se não informado ou vazio, retorna
                    todas.
                  example: ''
              required:
                - de
                - ate
                - tipo_entidade
                - ramal_agente
                - tipo
      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 `.

````