curl --request POST \
--url https://{baseUrl}/ipbox/api/getFP1 \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data form=form \
--data de=de \
--data ate=ate \
--data fichaId=fichaId \
--data lote=lote \
--data agente=agente \
--data time=time \
--data status=status \
--data operacao=operacao \
--data fila=fila \
--data prospect=prospect \
--data formato=formato \
--data user=user \
--data senha=senhaimport requests
url = "https://{baseUrl}/ipbox/api/getFP1"
payload = {
"form": "form",
"de": "de",
"ate": "ate",
"fichaId": "fichaId",
"lote": "lote",
"agente": "agente",
"time": "time",
"status": "status",
"operacao": "operacao",
"fila": "fila",
"prospect": "prospect",
"formato": "formato",
"user": "user",
"senha": "senha"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/x-www-form-urlencoded'},
body: new URLSearchParams({
form: 'form',
de: 'de',
ate: 'ate',
fichaId: 'fichaId',
lote: 'lote',
agente: 'agente',
time: 'time',
status: 'status',
operacao: 'operacao',
fila: 'fila',
prospect: 'prospect',
formato: 'formato',
user: 'user',
senha: 'senha'
})
};
fetch('https://{baseUrl}/ipbox/api/getFP1', 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/getFP1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "form=form&de=de&ate=ate&fichaId=fichaId&lote=lote&agente=agente&time=time&status=status&operacao=operacao&fila=fila&prospect=prospect&formato=formato&user=user&senha=senha",
CURLOPT_HTTPHEADER => [
"Content-Type: application/x-www-form-urlencoded"
],
]);
$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/getFP1"
payload := strings.NewReader("form=form&de=de&ate=ate&fichaId=fichaId&lote=lote&agente=agente&time=time&status=status&operacao=operacao&fila=fila&prospect=prospect&formato=formato&user=user&senha=senha")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
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/getFP1")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("form=form&de=de&ate=ate&fichaId=fichaId&lote=lote&agente=agente&time=time&status=status&operacao=operacao&fila=fila&prospect=prospect&formato=formato&user=user&senha=senha")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/getFP1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "form=form&de=de&ate=ate&fichaId=fichaId&lote=lote&agente=agente&time=time&status=status&operacao=operacao&fila=fila&prospect=prospect&formato=formato&user=user&senha=senha"
response = http.request(request)
puts response.read_bodygetFP1
Retorna o FP1 - Relatório de Fichas Preenchidas
-
Ao consultar por fichaId, todas as fichas especificadas devem pertencer ao mesmo formulário. Caso contrário, um erro é retornado.
-
Os parâmetros user/senha só são obrigatórios quando o sistema possui ATIVAR_PERMISSAO_POR_TIME ou ATIVAR_PERMISSAO_POR_OPERACAO habilitados. Quando ativos, os resultados são filtrados conforme as permissões de time do usuário.
Resposta — Formato JSON (formato=json)
HTTP 200
Content-Type: application/vnd.api+json
{ "data": [ { "ficha": "1234", "data": "15/01/2025 14:30:00", "status": "Finalizado", "agente": "joao.silva", "time": "Equipe Vendas", "codigo": "C001", "cpf": "12345678900", "nome": "Maria da Silva", "ddd_cel": "11", "tel_cel": "987654321", "ddd_com": "", "tel_com": "", "ddd_res": "11", "tel_res": "12345678", "lote": "Campanha Janeiro", "pontos": "85", "campo_personalizado_p": "valor", "pergunta_1_5_f": "Sim", "observacoes_5_f": "Cliente satisfeito" } ] }
As chaves JSON são normalizadas para snake_case ASCII (acentos transliterados, caracteres especiais substituídos por _). Sufixos nos cabeçalhos: [P] = campo customizado do prospect, [F] = campo do formulário.
Resposta — Formato CSV (formato=csv)
HTTP 200
Content-Type: application/vnd.api+json
Conteúdo CSV delimitado por ponto e vírgula. A primeira linha é o cabeçalho.
ficha;data;status;agente;time;codigo;cpf;nome;ddd_cel;tel_cel;ddd_com;tel_com;ddd_res;tel_res;lote;pontos;"Pergunta 1 [5] [F]";"Observacoes [5] [F]" 1234;"15/01/2025 14:30:00";Finalizado;joao.silva;"Equipe Vendas";C001;12345678900;"Maria da Silva";11;987654321;;;11;12345678;"Campanha Janeiro";85;Sim;"Cliente satisfeito"
curl --request POST \
--url https://{baseUrl}/ipbox/api/getFP1 \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data form=form \
--data de=de \
--data ate=ate \
--data fichaId=fichaId \
--data lote=lote \
--data agente=agente \
--data time=time \
--data status=status \
--data operacao=operacao \
--data fila=fila \
--data prospect=prospect \
--data formato=formato \
--data user=user \
--data senha=senhaimport requests
url = "https://{baseUrl}/ipbox/api/getFP1"
payload = {
"form": "form",
"de": "de",
"ate": "ate",
"fichaId": "fichaId",
"lote": "lote",
"agente": "agente",
"time": "time",
"status": "status",
"operacao": "operacao",
"fila": "fila",
"prospect": "prospect",
"formato": "formato",
"user": "user",
"senha": "senha"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/x-www-form-urlencoded'},
body: new URLSearchParams({
form: 'form',
de: 'de',
ate: 'ate',
fichaId: 'fichaId',
lote: 'lote',
agente: 'agente',
time: 'time',
status: 'status',
operacao: 'operacao',
fila: 'fila',
prospect: 'prospect',
formato: 'formato',
user: 'user',
senha: 'senha'
})
};
fetch('https://{baseUrl}/ipbox/api/getFP1', 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/getFP1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "form=form&de=de&ate=ate&fichaId=fichaId&lote=lote&agente=agente&time=time&status=status&operacao=operacao&fila=fila&prospect=prospect&formato=formato&user=user&senha=senha",
CURLOPT_HTTPHEADER => [
"Content-Type: application/x-www-form-urlencoded"
],
]);
$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/getFP1"
payload := strings.NewReader("form=form&de=de&ate=ate&fichaId=fichaId&lote=lote&agente=agente&time=time&status=status&operacao=operacao&fila=fila&prospect=prospect&formato=formato&user=user&senha=senha")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
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/getFP1")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("form=form&de=de&ate=ate&fichaId=fichaId&lote=lote&agente=agente&time=time&status=status&operacao=operacao&fila=fila&prospect=prospect&formato=formato&user=user&senha=senha")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/getFP1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "form=form&de=de&ate=ate&fichaId=fichaId&lote=lote&agente=agente&time=time&status=status&operacao=operacao&fila=fila&prospect=prospect&formato=formato&user=user&senha=senha"
response = http.request(request)
puts response.read_bodyBody
Identificador do formulário. Aceita ID numérico ou nome (descrição) do formulário.
"form"
Data/hora inicial no formato YYYYMMDDhhmmss. Exemplo: 20250101000000
"de"
Data/hora final no formato YYYYMMDDhhmmss. Exemplo: 20250131235959
"ate"
IDs de fichas separados por vírgula. Suporta faixas com - (ex: 100,101,200-210). Quando informado, form, de e ate não são obrigatórios. Todas as fichas devem pertencer ao mesmo formulário.
"fichaId"
Filtro de lote. Aceita ID numérico ou nome do lote.
"lote"
Filtro de agente. Aceita ID numérico ou login.
"agente"
Filtro de time. Aceita ID numérico ou nome do time.
"time"
Filtro de status da ficha.
"status"
Filtro de operação. Aceita ID numérico ou nome da operação.
"operacao"
Filtro de fila. Aceita ID numérico ou nome da fila.
"fila"
Filtro por nome do prospect
"prospect"
Formato de saída: json (padrão) ou csv.
"formato"
Login do usuário. Obrigatório quando a permissão por time ou operação está habilitada (ATIVAR_PERMISSAO_POR_TIME ou ATIVAR_PERMISSAO_POR_OPERACAO).
"user"
Senha do usuário. Obrigatório junto com user quando as verificações de permissão estão habilitadas.
"senha"
Response
Successful response