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

# retornoDiscador

> ## Retorna o status de cada uma das tentativas de ligação do discador no período especificado.

###### Response:

Se foram efetuadas discagens, retorna CSV com todos os status das ligações efetuadas no período especificado. Ver o formato do CSV abaixo.

Se a data/hora inicial ou final não forem informadas, serão retornados os resultados do dia corrente.

**Formato CSV retornado:**

data_hora;codigo;ddd;numero;codigo_status;status

**Exemplo CSV:**

28/09/2017 20:04:50;1534664;11;22334455;4;ATENDIDO  
28/09/2017 20:05:18;2577333;33;22332233;3;SEM_RESPOSTA  
06/10/2017 08:00:55;2777322;33;22332233;5;OCUPADO  
06/10/2017 08:10:55;2475367;33;22332233;0;DESCONHECIDO

**Status possíveis:**

0 = DESCONHECIDO  
1 = INDISPONIVEL  
3 = SEM_RESPOSTA  
4 = ATENDIDO  
5 = OCUPADO  
8 = CONGESTIONADO  
94 = FAX  
95 = SECRETARIA_ELETRONICA  
96 = CAIXA_POSTAL  
97 = MENSAGEM_OPERADORA  
98 = MACHINE  
99 = BLACKLISTED



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/retornoDiscador
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/retornoDiscador:
    post:
      tags:
        - Ligações
      summary: retornoDiscador
      description: >-
        ## Retorna o status de cada uma das tentativas de ligação do discador
        no período especificado.


        ###### Response:


        Se foram efetuadas discagens, retorna CSV com todos os status das
        ligações efetuadas no período especificado. Ver o formato do CSV abaixo.


        Se a data/hora inicial ou final não forem informadas, serão retornados
        os resultados do dia corrente.


        **Formato CSV retornado:**


        data_hora;codigo;ddd;numero;codigo_status;status


        **Exemplo CSV:**


        28/09/2017 20:04:50;1534664;11;22334455;4;ATENDIDO  

        28/09/2017 20:05:18;2577333;33;22332233;3;SEM_RESPOSTA  

        06/10/2017 08:00:55;2777322;33;22332233;5;OCUPADO  

        06/10/2017 08:10:55;2475367;33;22332233;0;DESCONHECIDO


        **Status possíveis:**


        0 = DESCONHECIDO  

        1 = INDISPONIVEL  

        3 = SEM_RESPOSTA  

        4 = ATENDIDO  

        5 = OCUPADO  

        8 = CONGESTIONADO  

        94 = FAX  

        95 = SECRETARIA_ELETRONICA  

        96 = CAIXA_POSTAL  

        97 = MENSAGEM_OPERADORA  

        98 = MACHINE  

        99 = BLACKLISTED
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
          example: '{{token}}'
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/x-www-form-urlencoded
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                loteId:
                  type: string
                  description: Id do lote
                  example: loteId
                de:
                  type: string
                  description: Data e hora inicial no formato AAAA-MM-DD HH:MM:SS
                  example: de
                ate:
                  type: string
                  description: Data e hora final no formato AAAA-MM-DD HH:MM:SS
                  example: ate
              required:
                - loteId
                - de
                - ate
      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 `.

````