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

# getHistoricoProspect

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

<h6 class="label label-success">Response:</h6>
<table class="table table-hover"> <tbody><tr><td>date</td><td>Data da ligação no formato "DD/MM/YYYY HH:MM:SS"</td></tr> <tr><td>numero</td><td>Número discado</td></tr> <tr><td>resultadoTelefonia</td><td>Resultado da Telefonia, pode ser ATENDIDO, OCUPADO, SEM_RESPOSTA, DESLIGADO_CLIENTE, CONGESTIONADO, NAO_DISCADO, entre outros</td></tr> <tr><td>resultadoLigacao</td><td>Resultado da Ligação: <li>Tornou-se cliente</li> <li>Não tem interesse</li> <li>Solicitou retorno</li> <li>Não encontrado</li> <li>Telefone invalido</li> <li>Ligação interrompida</li> <li>... entre outros</li> </td></tr> <tr><td>codigo</td><td>Código do prospect</td></tr> <tr><td>cpf</td><td>CPF do prospect</td></tr> <tr><td>nome</td><td>Nome do prospect</td></tr> <tr><td>lote</td><td>Descrição do lote</td></tr> </tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/getHistoricoProspect
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/getHistoricoProspect:
    post:
      tags:
        - Prospects
      summary: getHistoricoProspect
      description: >-
        <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.


        <h6 class="label label-success">Response:</h6>

        <table class="table table-hover"> <tbody><tr><td>date</td><td>Data da
        ligação no formato "DD/MM/YYYY HH:MM:SS"</td></tr>
        <tr><td>numero</td><td>Número discado</td></tr>
        <tr><td>resultadoTelefonia</td><td>Resultado da Telefonia, pode ser
        ATENDIDO, OCUPADO, SEM_RESPOSTA, DESLIGADO_CLIENTE, CONGESTIONADO,
        NAO_DISCADO, entre outros</td></tr>
        <tr><td>resultadoLigacao</td><td>Resultado da Ligação: <li>Tornou-se
        cliente</li> <li>Não tem interesse</li> <li>Solicitou retorno</li>
        <li>Não encontrado</li> <li>Telefone invalido</li> <li>Ligação
        interrompida</li> <li>... entre outros</li> </td></tr>
        <tr><td>codigo</td><td>Código do prospect</td></tr>
        <tr><td>cpf</td><td>CPF do prospect</td></tr> <tr><td>nome</td><td>Nome
        do prospect</td></tr> <tr><td>lote</td><td>Descrição do lote</td></tr>
        </tbody></table>
      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:
                codigo:
                  type: string
                  description: Código do Prospect.
                  example: codigo
                cpf:
                  type: string
                  description: CPF do prospect.
                  example: cpf
                loteId:
                  type: string
                  description: '[Opcional] Id do lote.'
                  example: loteId
              required:
                - codigo
                - cpf
      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 `.

````