curl --request POST \
--url https://{baseUrl}/ipbox/api/classificarProspect \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data prospectId=prospectId \
--data resultadoLigacaoId=resultadoLigacaoId \
--data resultadoLigacao=resultadoLigacao \
--data tipoRetorno=tipoRetorno \
--data dataRetorno=dataRetorno \
--data usuarioRetorno=usuario \
--data historico=historicoimport requests
url = "https://{baseUrl}/ipbox/api/classificarProspect"
payload = {
"prospectId": "prospectId",
"resultadoLigacaoId": "resultadoLigacaoId",
"resultadoLigacao": "resultadoLigacao",
"tipoRetorno": "tipoRetorno",
"dataRetorno": "dataRetorno",
"usuarioRetorno": "usuario",
"historico": "historico"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/x-www-form-urlencoded"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<api-key>',
'Content-Type': 'application/x-www-form-urlencoded'
},
body: new URLSearchParams({
prospectId: 'prospectId',
resultadoLigacaoId: 'resultadoLigacaoId',
resultadoLigacao: 'resultadoLigacao',
tipoRetorno: 'tipoRetorno',
dataRetorno: 'dataRetorno',
usuarioRetorno: 'usuario',
historico: 'historico'
})
};
fetch('https://{baseUrl}/ipbox/api/classificarProspect', 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/classificarProspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "prospectId=prospectId&resultadoLigacaoId=resultadoLigacaoId&resultadoLigacao=resultadoLigacao&tipoRetorno=tipoRetorno&dataRetorno=dataRetorno&usuarioRetorno=usuario&historico=historico",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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/classificarProspect"
payload := strings.NewReader("prospectId=prospectId&resultadoLigacaoId=resultadoLigacaoId&resultadoLigacao=resultadoLigacao&tipoRetorno=tipoRetorno&dataRetorno=dataRetorno&usuarioRetorno=usuario&historico=historico")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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/classificarProspect")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("prospectId=prospectId&resultadoLigacaoId=resultadoLigacaoId&resultadoLigacao=resultadoLigacao&tipoRetorno=tipoRetorno&dataRetorno=dataRetorno&usuarioRetorno=usuario&historico=historico")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/classificarProspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "prospectId=prospectId&resultadoLigacaoId=resultadoLigacaoId&resultadoLigacao=resultadoLigacao&tipoRetorno=tipoRetorno&dataRetorno=dataRetorno&usuarioRetorno=usuario&historico=historico"
response = http.request(request)
puts response.read_body{
"status": "success"
}{
"errors": [
{
"status": 409,
"title": "Erro",
"detail": "(mensagem dinâmica, varia conforme o erro encontrado)"
}
]
}classificarProspect
Classifica o prospect.
Informar resultadoLigacaoId ou resultadoLigacao; se ambos forem informados, será usado o resultadoLigacaoId.
curl --request POST \
--url https://{baseUrl}/ipbox/api/classificarProspect \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data prospectId=prospectId \
--data resultadoLigacaoId=resultadoLigacaoId \
--data resultadoLigacao=resultadoLigacao \
--data tipoRetorno=tipoRetorno \
--data dataRetorno=dataRetorno \
--data usuarioRetorno=usuario \
--data historico=historicoimport requests
url = "https://{baseUrl}/ipbox/api/classificarProspect"
payload = {
"prospectId": "prospectId",
"resultadoLigacaoId": "resultadoLigacaoId",
"resultadoLigacao": "resultadoLigacao",
"tipoRetorno": "tipoRetorno",
"dataRetorno": "dataRetorno",
"usuarioRetorno": "usuario",
"historico": "historico"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/x-www-form-urlencoded"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: '<api-key>',
'Content-Type': 'application/x-www-form-urlencoded'
},
body: new URLSearchParams({
prospectId: 'prospectId',
resultadoLigacaoId: 'resultadoLigacaoId',
resultadoLigacao: 'resultadoLigacao',
tipoRetorno: 'tipoRetorno',
dataRetorno: 'dataRetorno',
usuarioRetorno: 'usuario',
historico: 'historico'
})
};
fetch('https://{baseUrl}/ipbox/api/classificarProspect', 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/classificarProspect",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "prospectId=prospectId&resultadoLigacaoId=resultadoLigacaoId&resultadoLigacao=resultadoLigacao&tipoRetorno=tipoRetorno&dataRetorno=dataRetorno&usuarioRetorno=usuario&historico=historico",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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/classificarProspect"
payload := strings.NewReader("prospectId=prospectId&resultadoLigacaoId=resultadoLigacaoId&resultadoLigacao=resultadoLigacao&tipoRetorno=tipoRetorno&dataRetorno=dataRetorno&usuarioRetorno=usuario&historico=historico")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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/classificarProspect")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("prospectId=prospectId&resultadoLigacaoId=resultadoLigacaoId&resultadoLigacao=resultadoLigacao&tipoRetorno=tipoRetorno&dataRetorno=dataRetorno&usuarioRetorno=usuario&historico=historico")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/classificarProspect")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "prospectId=prospectId&resultadoLigacaoId=resultadoLigacaoId&resultadoLigacao=resultadoLigacao&tipoRetorno=tipoRetorno&dataRetorno=dataRetorno&usuarioRetorno=usuario&historico=historico"
response = http.request(request)
puts response.read_body{
"status": "success"
}{
"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 do prospect
"prospectId"
[Obrigatório informar este OU resultadoLigacao] Id do resultado de ligação. Tem prioridade sobre resultadoLigacao se ambos forem informados.
"resultadoLigacaoId"
[Obrigatório informar este OU resultadoLigacaoId] Descrição do resultado de ligação.
"resultadoLigacao"
[Opcional] Tipo de retorno/agendamento (GENERICO ou ESPECIFICO) — obrigatório apenas quando a ação do resultado de ligação for um agendamento e um usuário de destino for necessário; nesses casos, se omitido, é inferido a partir da ação.
"tipoRetorno"
[Opcional] Data/hora do agendamento — obrigatório apenas quando a ação do resultado de ligação exigir uma data futura.
"dataRetorno"
[Obrigatório apenas quando tipoRetorno=ESPECIFICO] Login do usuário de destino do retorno/agendamento específico.
"usuario"
[Opcional] observação em forma de texto
"historico"
Response
Prospect classificado com sucesso.
"success"
