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

# getProspectLote

> <h2>Retorna lista de prospects do lote especificado.</h2>

<h6 class="label label-success">Response:</h6>
<table class="table table-hover"> <tbody><tr><td>lote</td><td>Descrição do Lote</td></tr> <tr><td>lote_id</td><td>Id do lote</td></tr> <tr><td>prospects</td><td>Informações do Prospect:<br /> <table class="table table-hover"> <tbody><tr><td>id</td><td>Id do Prospect</td></tr> <tr><td>nome</td><td>Nome do Prospect</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>numeros</td><td>Números do Prospect:<br /> <table class="table table-hover"> <tbody><tr><td>ddd</td><td>DDD</td></tr> <tr><td>numero</td><td>Número</td></tr> </tbody></table> </td></tr> <tr><td>situacao</td><td>Situação do Prospect. Exemplo: 'NOVO', 'FILA', 'CLIENTE', 'EXCLUIDO', 'RETORNO', 'EM_CHAMADA', 'EM_ESPERA', 'DISCANDO'</td></tr> <tr><td>classificacao</td><td>Classificação:<br /> <table class="table table-hover"> <tbody><tr><td>descricao</td><td>Texto descritivo da classificação</td></tr> <tr><td>acao</td><td>Ação resultante da ligação: <br /> <ul> <li>'NONE' = 'Nenhuma'</li> <li>'AG_GEN' = 'Agendamento Genérico'</li> <li>'AG_ESP' = 'Agendamento Específico'</li> <li>'EX_FONE' = 'Exclui o Fone'</li> <li>'EX_PROSPECT' = 'Exclui o Prospect'</li> <li>'CLIENTE' = 'Prospect tornou-se cliente'</li> <li>'VOLTAR_FILA' = 'Prospect volta para fila'</li> <li>'LIGAR_AGORA' = 'Liga imediatamente p/ o prospect'</li> <li>'BLACKLIST' = 'Adiciona prospect na blacklist'</li> </ul> </td></tr> <tr><td>datahora</td><td>Data e hora da ligação no formato "YYYY-MM-DD HH:MM:SS"</td></tr> <tr><td>usuario_id</td><td>Id do usuário/agente que atendeu a ligação</td></tr> <tr><td>usuario</td><td>Nome do usuário/agente que atendeu a ligação</td></tr> </tbody></table> </td></tr> </tbody></table> </td></tr> </tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/getProspectLote
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/getProspectLote:
    post:
      tags:
        - Prospects
      summary: getProspectLote
      description: >-
        <h2>Retorna lista de prospects do lote especificado.</h2>


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

        <table class="table table-hover"> <tbody><tr><td>lote</td><td>Descrição
        do Lote</td></tr> <tr><td>lote_id</td><td>Id do lote</td></tr>
        <tr><td>prospects</td><td>Informações do Prospect:<br /> <table
        class="table table-hover"> <tbody><tr><td>id</td><td>Id do
        Prospect</td></tr> <tr><td>nome</td><td>Nome do Prospect</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>numeros</td><td>Números do Prospect:<br /> <table class="table
        table-hover"> <tbody><tr><td>ddd</td><td>DDD</td></tr>
        <tr><td>numero</td><td>Número</td></tr> </tbody></table> </td></tr>
        <tr><td>situacao</td><td>Situação do Prospect. Exemplo: 'NOVO', 'FILA',
        'CLIENTE', 'EXCLUIDO', 'RETORNO', 'EM_CHAMADA', 'EM_ESPERA',
        'DISCANDO'</td></tr> <tr><td>classificacao</td><td>Classificação:<br />
        <table class="table table-hover"> <tbody><tr><td>descricao</td><td>Texto
        descritivo da classificação</td></tr> <tr><td>acao</td><td>Ação
        resultante da ligação: <br /> <ul> <li>'NONE' = 'Nenhuma'</li>
        <li>'AG_GEN' = 'Agendamento Genérico'</li> <li>'AG_ESP' = 'Agendamento
        Específico'</li> <li>'EX_FONE' = 'Exclui o Fone'</li> <li>'EX_PROSPECT'
        = 'Exclui o Prospect'</li> <li>'CLIENTE' = 'Prospect tornou-se
        cliente'</li> <li>'VOLTAR_FILA' = 'Prospect volta para fila'</li>
        <li>'LIGAR_AGORA' = 'Liga imediatamente p/ o prospect'</li>
        <li>'BLACKLIST' = 'Adiciona prospect na blacklist'</li> </ul> </td></tr>
        <tr><td>datahora</td><td>Data e hora da ligação no formato "YYYY-MM-DD
        HH:MM:SS"</td></tr> <tr><td>usuario_id</td><td>Id do usuário/agente que
        atendeu a ligação</td></tr> <tr><td>usuario</td><td>Nome do
        usuário/agente que atendeu a ligação</td></tr> </tbody></table>
        </td></tr> </tbody></table> </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:
                lote:
                  type: string
                  description: Descrição do lote.
                  example: descricao_lote
              required:
                - lote
      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 `.

````