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

# reciclarProspect

> Define a reciclagem de prospects de um ou mais lotes. O destino pode ser um lote ou um arquivo csv. A reciclagem é colocada em uma fila de execução. Para consultar o status da reciclagem usar o método getStatusReciclagem.

Resultados de telefonia válidos:

ATENDIDO  
DESCONHECIDO  
OCUPADO  
SEM_RESPOSTA  
HANGUP  
CONGESTIONADO  
BLACKLISTED  
NUMERO_INVALIDO  
FORA_DE_SERVICO  
CAIXA_POSTAL  
MAQUINA  
SEM_SALDO



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/reciclarProspect
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/reciclarProspect:
    post:
      tags:
        - Prospects
      summary: reciclarProspect
      description: >-
        Define a reciclagem de prospects de um ou mais lotes. O destino pode ser
        um lote ou um arquivo csv. A reciclagem é colocada em uma fila de
        execução. Para consultar o status da reciclagem usar o método
        getStatusReciclagem.


        Resultados de telefonia válidos:


        ATENDIDO  

        DESCONHECIDO  

        OCUPADO  

        SEM_RESPOSTA  

        HANGUP  

        CONGESTIONADO  

        BLACKLISTED  

        NUMERO_INVALIDO  

        FORA_DE_SERVICO  

        CAIXA_POSTAL  

        MAQUINA  

        SEM_SALDO
      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:
          multipart/form-data:
            schema:
              type: object
              properties:
                filaOrigem:
                  type: string
                  description: Id ou descricao da fila de origem
                  example: filaOrigem
                lotesOrigem:
                  type: string
                  description: >-
                    Lista de ids ou descrições dos lotes de origem no formato:
                    3||6||12 ou Lote 01||Venda Direta
                  example: lotesOrigem
                loteDestino:
                  type: string
                  description: Id ou descrição do lote de destino - Opcional se tipo = csv
                  example: loteDestino
                resultadosLigacao:
                  type: string
                  description: >-
                    [Opcional] Lista de ids ou descrições dos resultados de
                    ligação no formato 4||6||22 ou Sem interesse||Solicitou
                    retorno - default: todos
                  example: resultadosLigacao
                resultadosTelefonia:
                  type: string
                  description: >-
                    [Opcional] Lista de resultados de telefonia no formato
                    OCUPADO||SEM_RESPOSTA - default: todos
                  example: resultadosTelefonia
                ddd:
                  type: string
                  description: >-
                    [Opcional] Lista de DDDs a serem reciclados no formato
                    11||21 - default: todos
                  example: ddd
                apenasExcluidos:
                  type: string
                  description: >-
                    [Opcional] Reciclar apenas prospects EXCLUÍDOS (Y ou N) -
                    default: N
                  example: apenas_excluidos
                tipo:
                  type: string
                  description: '[Opcional] Tipo de reciclagem: lote ou csv - default: lote'
                  example: tipo
              required:
                - filaOrigem
                - lotesOrigem
                - loteDestino
      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 `.

````