curl --request POST \
--url https://{baseUrl}/ipbox/api/reciclarProspect \
--header 'Authorization: <api-key>' \
--header 'Content-Type: multipart/form-data' \
--form filaOrigem=filaOrigem \
--form lotesOrigem=lotesOrigem \
--form loteDestino=loteDestino \
--form resultadosLigacao=resultadosLigacao \
--form resultadosTelefonia=resultadosTelefonia \
--form ddd=ddd \
--form apenasExcluidos=apenas_excluidos \
--form tipo=tipoimport requests
url = "https://{baseUrl}/ipbox/api/reciclarProspect"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filaOrigem\"\r\n\r\nfilaOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lotesOrigem\"\r\n\r\nlotesOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loteDestino\"\r\n\r\nloteDestino\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosLigacao\"\r\n\r\nresultadosLigacao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosTelefonia\"\r\n\r\nresultadosTelefonia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ddd\"\r\n\r\nddd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apenasExcluidos\"\r\n\r\napenas_excluidos\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tipo\"\r\n\r\ntipo\r\n-----011000010111000001101001--"
headers = {
"Authorization": "<api-key>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('filaOrigem', 'filaOrigem');
form.append('lotesOrigem', 'lotesOrigem');
form.append('loteDestino', 'loteDestino');
form.append('resultadosLigacao', 'resultadosLigacao');
form.append('resultadosTelefonia', 'resultadosTelefonia');
form.append('ddd', 'ddd');
form.append('apenasExcluidos', 'apenas_excluidos');
form.append('tipo', 'tipo');
const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
options.body = form;
fetch('https://{baseUrl}/ipbox/api/reciclarProspect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{baseUrl}/ipbox/api/reciclarProspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filaOrigem\"\r\n\r\nfilaOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lotesOrigem\"\r\n\r\nlotesOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loteDestino\"\r\n\r\nloteDestino\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosLigacao\"\r\n\r\nresultadosLigacao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosTelefonia\"\r\n\r\nresultadosTelefonia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ddd\"\r\n\r\nddd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apenasExcluidos\"\r\n\r\napenas_excluidos\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tipo\"\r\n\r\ntipo\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{baseUrl}/ipbox/api/reciclarProspect"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filaOrigem\"\r\n\r\nfilaOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lotesOrigem\"\r\n\r\nlotesOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loteDestino\"\r\n\r\nloteDestino\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosLigacao\"\r\n\r\nresultadosLigacao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosTelefonia\"\r\n\r\nresultadosTelefonia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ddd\"\r\n\r\nddd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apenasExcluidos\"\r\n\r\napenas_excluidos\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tipo\"\r\n\r\ntipo\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{baseUrl}/ipbox/api/reciclarProspect")
.header("Authorization", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filaOrigem\"\r\n\r\nfilaOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lotesOrigem\"\r\n\r\nlotesOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loteDestino\"\r\n\r\nloteDestino\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosLigacao\"\r\n\r\nresultadosLigacao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosTelefonia\"\r\n\r\nresultadosTelefonia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ddd\"\r\n\r\nddd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apenasExcluidos\"\r\n\r\napenas_excluidos\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tipo\"\r\n\r\ntipo\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/reciclarProspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filaOrigem\"\r\n\r\nfilaOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lotesOrigem\"\r\n\r\nlotesOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loteDestino\"\r\n\r\nloteDestino\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosLigacao\"\r\n\r\nresultadosLigacao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosTelefonia\"\r\n\r\nresultadosTelefonia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ddd\"\r\n\r\nddd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apenasExcluidos\"\r\n\r\napenas_excluidos\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tipo\"\r\n\r\ntipo\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"id": 90,
"status": "FILA"
}
}{
"errors": [
{
"status": 409,
"title": "Erro",
"detail": "(mensagem dinâmica, varia conforme o erro encontrado)"
}
]
}reciclarProspect
Define a reciclagem de prospects de um ou mais lotes. O destino pode ser um lote ou um arquivo CSV.
Resultados de telefonia válidos (para resultadosTelefonia): ATENDIDO, DESCONHECIDO, OCUPADO, SEM_RESPOSTA, HANGUP, CONGESTIONADO, BLACKLISTED, NUMERO_INVALIDO, FORA_DE_SERVICO, CAIXA_POSTAL, MAQUINA, SEM_SALDO.
A reciclagem é assíncrona: este endpoint apenas enfileira a operação e retorna imediatamente com status: FILA — use getStatusReciclagem para acompanhar o progresso.
curl --request POST \
--url https://{baseUrl}/ipbox/api/reciclarProspect \
--header 'Authorization: <api-key>' \
--header 'Content-Type: multipart/form-data' \
--form filaOrigem=filaOrigem \
--form lotesOrigem=lotesOrigem \
--form loteDestino=loteDestino \
--form resultadosLigacao=resultadosLigacao \
--form resultadosTelefonia=resultadosTelefonia \
--form ddd=ddd \
--form apenasExcluidos=apenas_excluidos \
--form tipo=tipoimport requests
url = "https://{baseUrl}/ipbox/api/reciclarProspect"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filaOrigem\"\r\n\r\nfilaOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lotesOrigem\"\r\n\r\nlotesOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loteDestino\"\r\n\r\nloteDestino\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosLigacao\"\r\n\r\nresultadosLigacao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosTelefonia\"\r\n\r\nresultadosTelefonia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ddd\"\r\n\r\nddd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apenasExcluidos\"\r\n\r\napenas_excluidos\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tipo\"\r\n\r\ntipo\r\n-----011000010111000001101001--"
headers = {
"Authorization": "<api-key>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('filaOrigem', 'filaOrigem');
form.append('lotesOrigem', 'lotesOrigem');
form.append('loteDestino', 'loteDestino');
form.append('resultadosLigacao', 'resultadosLigacao');
form.append('resultadosTelefonia', 'resultadosTelefonia');
form.append('ddd', 'ddd');
form.append('apenasExcluidos', 'apenas_excluidos');
form.append('tipo', 'tipo');
const options = {method: 'POST', headers: {Authorization: '<api-key>'}};
options.body = form;
fetch('https://{baseUrl}/ipbox/api/reciclarProspect', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{baseUrl}/ipbox/api/reciclarProspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filaOrigem\"\r\n\r\nfilaOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lotesOrigem\"\r\n\r\nlotesOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loteDestino\"\r\n\r\nloteDestino\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosLigacao\"\r\n\r\nresultadosLigacao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosTelefonia\"\r\n\r\nresultadosTelefonia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ddd\"\r\n\r\nddd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apenasExcluidos\"\r\n\r\napenas_excluidos\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tipo\"\r\n\r\ntipo\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{baseUrl}/ipbox/api/reciclarProspect"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filaOrigem\"\r\n\r\nfilaOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lotesOrigem\"\r\n\r\nlotesOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loteDestino\"\r\n\r\nloteDestino\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosLigacao\"\r\n\r\nresultadosLigacao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosTelefonia\"\r\n\r\nresultadosTelefonia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ddd\"\r\n\r\nddd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apenasExcluidos\"\r\n\r\napenas_excluidos\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tipo\"\r\n\r\ntipo\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{baseUrl}/ipbox/api/reciclarProspect")
.header("Authorization", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filaOrigem\"\r\n\r\nfilaOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lotesOrigem\"\r\n\r\nlotesOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loteDestino\"\r\n\r\nloteDestino\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosLigacao\"\r\n\r\nresultadosLigacao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosTelefonia\"\r\n\r\nresultadosTelefonia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ddd\"\r\n\r\nddd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apenasExcluidos\"\r\n\r\napenas_excluidos\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tipo\"\r\n\r\ntipo\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/reciclarProspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"filaOrigem\"\r\n\r\nfilaOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lotesOrigem\"\r\n\r\nlotesOrigem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loteDestino\"\r\n\r\nloteDestino\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosLigacao\"\r\n\r\nresultadosLigacao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"resultadosTelefonia\"\r\n\r\nresultadosTelefonia\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"ddd\"\r\n\r\nddd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apenasExcluidos\"\r\n\r\napenas_excluidos\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tipo\"\r\n\r\ntipo\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"id": 90,
"status": "FILA"
}
}{
"errors": [
{
"status": 409,
"title": "Erro",
"detail": "(mensagem dinâmica, varia conforme o erro encontrado)"
}
]
}Authorizations
Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo Bearer / Basic.
Body
Id ou descricao da fila de origem
"filaOrigem"
Lista de ids ou descrições dos lotes de origem no formato: 3||6||12 ou Lote 01||Venda Direta
"lotesOrigem"
Id ou descrição do lote de destino - Opcional se tipo = csv
"loteDestino"
[Opcional] Lista de ids ou descrições dos resultados de ligação no formato 4||6||22 ou Sem interesse||Solicitou retorno - default: todos
"resultadosLigacao"
[Opcional] Lista de resultados de telefonia no formato OCUPADO||SEM_RESPOSTA - default: todos
"resultadosTelefonia"
[Opcional] Lista de DDDs a serem reciclados no formato 11||21 - default: todos
"ddd"
[Opcional] Reciclar apenas prospects EXCLUÍDOS (Y ou N) - default: N
"apenas_excluidos"
[Opcional] "lote" (default) reciclar para outro lote (loteDestino obrigatório), ou "csv" para gerar um arquivo CSV para download (loteDestino não é usado).
"tipo"
