curl --request POST \
--url https://{baseUrl}/ipbox/api/inserirUsuario \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data usuario=agente08 \
--data tipo=agente \
--data email=agente08@empresa.com.br \
--data cpf= \
--data dataNascimento=15/03/1990 \
--data nivelAcesso=1import requests
url = "https://{baseUrl}/ipbox/api/inserirUsuario"
payload = {
"usuario": "agente08",
"tipo": "agente",
"email": "agente08@empresa.com.br",
"cpf": "",
"dataNascimento": "15/03/1990",
"nivelAcesso": "1"
}
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({
usuario: 'agente08',
tipo: 'agente',
email: 'agente08@empresa.com.br',
cpf: '',
dataNascimento: '15/03/1990',
nivelAcesso: '1'
})
};
fetch('https://{baseUrl}/ipbox/api/inserirUsuario', 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/inserirUsuario",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "usuario=agente08&tipo=agente&email=agente08%40empresa.com.br&cpf=&dataNascimento=15%2F03%2F1990&nivelAcesso=1",
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/inserirUsuario"
payload := strings.NewReader("usuario=agente08&tipo=agente&email=agente08%40empresa.com.br&cpf=&dataNascimento=15%2F03%2F1990&nivelAcesso=1")
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/inserirUsuario")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("usuario=agente08&tipo=agente&email=agente08%40empresa.com.br&cpf=&dataNascimento=15%2F03%2F1990&nivelAcesso=1")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/inserirUsuario")
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 = "usuario=agente08&tipo=agente&email=agente08%40empresa.com.br&cpf=&dataNascimento=15%2F03%2F1990&nivelAcesso=1"
response = http.request(request)
puts response.read_bodyinserirUsuario
Cria um novo usuário (agente, supervisor etc.).
Uma senha forte de 8 caracteres é gerada automaticamente e devolvida em texto plano na resposta. Ela não é enviada por e-mail nem por nenhum outro canal. O usuário é criado ativo e já com um ramal PJSIP, devolvido no campo ramal.
Regras:
- O
loginprecisa ser único. - O
cpf, se informado, não pode estar em uso por outro usuário. - O
emailé opcional para agentes e obrigatório para os demais tipos de usuário. - Não é permitido criar um usuário do tipo root.
Retorna:
| Campo | Descrição |
|---|---|
| status | success |
| data.id | Id do usuário criado |
| data.login | Login do usuário |
| data.tipo | Tipo do usuário |
| data.ramal | Ramal PJSIP do usuário |
| data.senha | Senha gerada, em texto plano |
A senha só é devolvida nesta resposta e não pode ser consultada depois. Guarde-a ou repasse-a ao usuário com segurança. Se ela se perder, use o método redefinirSenhaUsuario (que precisa estar habilitado) ou peça ao suporte.
curl --request POST \
--url https://{baseUrl}/ipbox/api/inserirUsuario \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data usuario=agente08 \
--data tipo=agente \
--data email=agente08@empresa.com.br \
--data cpf= \
--data dataNascimento=15/03/1990 \
--data nivelAcesso=1import requests
url = "https://{baseUrl}/ipbox/api/inserirUsuario"
payload = {
"usuario": "agente08",
"tipo": "agente",
"email": "agente08@empresa.com.br",
"cpf": "",
"dataNascimento": "15/03/1990",
"nivelAcesso": "1"
}
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({
usuario: 'agente08',
tipo: 'agente',
email: 'agente08@empresa.com.br',
cpf: '',
dataNascimento: '15/03/1990',
nivelAcesso: '1'
})
};
fetch('https://{baseUrl}/ipbox/api/inserirUsuario', 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/inserirUsuario",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "usuario=agente08&tipo=agente&email=agente08%40empresa.com.br&cpf=&dataNascimento=15%2F03%2F1990&nivelAcesso=1",
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/inserirUsuario"
payload := strings.NewReader("usuario=agente08&tipo=agente&email=agente08%40empresa.com.br&cpf=&dataNascimento=15%2F03%2F1990&nivelAcesso=1")
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/inserirUsuario")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/x-www-form-urlencoded")
.body("usuario=agente08&tipo=agente&email=agente08%40empresa.com.br&cpf=&dataNascimento=15%2F03%2F1990&nivelAcesso=1")
.asString();require 'uri'
require 'net/http'
url = URI("https://{baseUrl}/ipbox/api/inserirUsuario")
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 = "usuario=agente08&tipo=agente&email=agente08%40empresa.com.br&cpf=&dataNascimento=15%2F03%2F1990&nivelAcesso=1"
response = http.request(request)
puts response.read_bodyAuthorizations
Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo Bearer / Basic .
Body
Login do novo usuário
"agente08"
Id ou descrição do tipo de usuário (por exemplo, o tipo agente)
"agente"
[Opcional para agentes] E-mail do usuário. Obrigatório para os demais tipos.
"agente08@empresa.com.br"
[Opcional] CPF do usuário
""
[Opcional] Data de nascimento no formato dd/mm/aaaa
"15/03/1990"
[Opcional] Nível de acesso aos formulários, de 1 a 6. Se não informado, vale o nível do tipo de usuário.
"1"
