listarUsuarios
curl --request POST \
--url https://{baseUrl}/ipbox/api/listarUsuarios \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data tipo=tipo \
--data status=statusimport requests
url = "https://{baseUrl}/ipbox/api/listarUsuarios"
payload = {
"tipo": "tipo",
"status": "status"
}
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({tipo: 'tipo', status: 'status'})
};
fetch('https://{baseUrl}/ipbox/api/listarUsuarios', 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/listarUsuarios",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "tipo=tipo&status=status",
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/listarUsuarios"
payload := strings.NewReader("tipo=tipo&status=status")
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/listarUsuarios")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("tipo=tipo&status=status")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/listarUsuarios")
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 = "tipo=tipo&status=status"
response = http.request(request)
puts response.read_body{
"status": "success",
"usuarios": [
{
"id": 18,
"login": "agente08",
"tipo": "Agente",
"ramal": 2000,
"email": "",
"cpf": "",
"ativo": "Y"
}
]
}{
"errors": [
{
"status": 409,
"title": "Erro",
"detail": "(mensagem dinâmica, varia conforme o erro encontrado)"
}
]
}Agente
listarUsuarios
Retorna lista de usuários ativos. É possível filtrar pelo tipo de usuário (agente, supervisor, etc) e pelo status do agente (ativos, inativos ou todos).
Retorna:
| Campo | Descrição |
|---|---|
| id | Id do usuário |
| login | Login do usuário |
| tipo | Tipo do usuário |
| ramal | Ramal do usuário |
| E-mail do usuário | |
| cpf | CPF do usuário |
| ativo | Ativo (Y) ou inativo (N) |
POST
/
ipbox
/
api
/
listarUsuarios
listarUsuarios
curl --request POST \
--url https://{baseUrl}/ipbox/api/listarUsuarios \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data tipo=tipo \
--data status=statusimport requests
url = "https://{baseUrl}/ipbox/api/listarUsuarios"
payload = {
"tipo": "tipo",
"status": "status"
}
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({tipo: 'tipo', status: 'status'})
};
fetch('https://{baseUrl}/ipbox/api/listarUsuarios', 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/listarUsuarios",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "tipo=tipo&status=status",
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/listarUsuarios"
payload := strings.NewReader("tipo=tipo&status=status")
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/listarUsuarios")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("tipo=tipo&status=status")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/listarUsuarios")
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 = "tipo=tipo&status=status"
response = http.request(request)
puts response.read_body{
"status": "success",
"usuarios": [
{
"id": 18,
"login": "agente08",
"tipo": "Agente",
"ramal": 2000,
"email": "",
"cpf": "",
"ativo": "Y"
}
]
}{
"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
application/x-www-form-urlencoded
