criarFilaAtiva

curl --request POST \
  --url https://{baseUrl}/ipbox/api/criarFilaAtiva \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data descricao=descricao \
  --data operacao=operacao \
  --data tipo_discagem=tipo_discagem \
  --data num_canais=num_canais \
  --data canal_dialer=canal_dialer \
  --data adicionar_ddd_local=adicionar_ddd_local \
  --data overdial=overdial \
  --data max_overdial=max_overdial \
  --data operadora=operadora \
  --data tempo_max_atendimento=tempo_max_atendimento \
  --data tamanho_fila=tamanho_fila \
  --data tempo_max_tocando_agente=tempo_max_tocando_agente \
  --data tempo_max_fila_espera=tempo_max_fila_espera \
  --data integracao_id=integracao_id \
  --data tempo_medio_ring=tempo_medio_ring \
  --data tempo_medio_atendimento=tempo_medio_atendimento \
  --data tempo_medio_pos_atendimento=tempo_medio_pos_atendimento \
  --data max_dias_agendamento=max_dias_agendamento \
  --data max_ag_espec_dia_agente=max_ag_espec_dia_agente \
  --data max_ag_espec_agente=max_ag_espec_agente \
  --data tempo_dial=tempo_dial

import requests

url = "https://{baseUrl}/ipbox/api/criarFilaAtiva"

payload = {
    "descricao": "descricao",
    "operacao": "operacao",
    "tipo_discagem": "tipo_discagem",
    "num_canais": "num_canais",
    "canal_dialer": "canal_dialer",
    "adicionar_ddd_local": "adicionar_ddd_local",
    "overdial": "overdial",
    "max_overdial": "max_overdial",
    "operadora": "operadora",
    "tempo_max_atendimento": "tempo_max_atendimento",
    "tamanho_fila": "tamanho_fila",
    "tempo_max_tocando_agente": "tempo_max_tocando_agente",
    "tempo_max_fila_espera": "tempo_max_fila_espera",
    "integracao_id": "integracao_id",
    "tempo_medio_ring": "tempo_medio_ring",
    "tempo_medio_atendimento": "tempo_medio_atendimento",
    "tempo_medio_pos_atendimento": "tempo_medio_pos_atendimento",
    "max_dias_agendamento": "max_dias_agendamento",
    "max_ag_espec_dia_agente": "max_ag_espec_dia_agente",
    "max_ag_espec_agente": "max_ag_espec_agente",
    "tempo_dial": "tempo_dial"
}
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({
    descricao: 'descricao',
    operacao: 'operacao',
    tipo_discagem: 'tipo_discagem',
    num_canais: 'num_canais',
    canal_dialer: 'canal_dialer',
    adicionar_ddd_local: 'adicionar_ddd_local',
    overdial: 'overdial',
    max_overdial: 'max_overdial',
    operadora: 'operadora',
    tempo_max_atendimento: 'tempo_max_atendimento',
    tamanho_fila: 'tamanho_fila',
    tempo_max_tocando_agente: 'tempo_max_tocando_agente',
    tempo_max_fila_espera: 'tempo_max_fila_espera',
    integracao_id: 'integracao_id',
    tempo_medio_ring: 'tempo_medio_ring',
    tempo_medio_atendimento: 'tempo_medio_atendimento',
    tempo_medio_pos_atendimento: 'tempo_medio_pos_atendimento',
    max_dias_agendamento: 'max_dias_agendamento',
    max_ag_espec_dia_agente: 'max_ag_espec_dia_agente',
    max_ag_espec_agente: 'max_ag_espec_agente',
    tempo_dial: 'tempo_dial'
  })
};

fetch('https://{baseUrl}/ipbox/api/criarFilaAtiva', 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/criarFilaAtiva",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "descricao=descricao&operacao=operacao&tipo_discagem=tipo_discagem&num_canais=num_canais&canal_dialer=canal_dialer&adicionar_ddd_local=adicionar_ddd_local&overdial=overdial&max_overdial=max_overdial&operadora=operadora&tempo_max_atendimento=tempo_max_atendimento&tamanho_fila=tamanho_fila&tempo_max_tocando_agente=tempo_max_tocando_agente&tempo_max_fila_espera=tempo_max_fila_espera&integracao_id=integracao_id&tempo_medio_ring=tempo_medio_ring&tempo_medio_atendimento=tempo_medio_atendimento&tempo_medio_pos_atendimento=tempo_medio_pos_atendimento&max_dias_agendamento=max_dias_agendamento&max_ag_espec_dia_agente=max_ag_espec_dia_agente&max_ag_espec_agente=max_ag_espec_agente&tempo_dial=tempo_dial",
  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/criarFilaAtiva"

	payload := strings.NewReader("descricao=descricao&operacao=operacao&tipo_discagem=tipo_discagem&num_canais=num_canais&canal_dialer=canal_dialer&adicionar_ddd_local=adicionar_ddd_local&overdial=overdial&max_overdial=max_overdial&operadora=operadora&tempo_max_atendimento=tempo_max_atendimento&tamanho_fila=tamanho_fila&tempo_max_tocando_agente=tempo_max_tocando_agente&tempo_max_fila_espera=tempo_max_fila_espera&integracao_id=integracao_id&tempo_medio_ring=tempo_medio_ring&tempo_medio_atendimento=tempo_medio_atendimento&tempo_medio_pos_atendimento=tempo_medio_pos_atendimento&max_dias_agendamento=max_dias_agendamento&max_ag_espec_dia_agente=max_ag_espec_dia_agente&max_ag_espec_agente=max_ag_espec_agente&tempo_dial=tempo_dial")

	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/criarFilaAtiva")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("descricao=descricao&operacao=operacao&tipo_discagem=tipo_discagem&num_canais=num_canais&canal_dialer=canal_dialer&adicionar_ddd_local=adicionar_ddd_local&overdial=overdial&max_overdial=max_overdial&operadora=operadora&tempo_max_atendimento=tempo_max_atendimento&tamanho_fila=tamanho_fila&tempo_max_tocando_agente=tempo_max_tocando_agente&tempo_max_fila_espera=tempo_max_fila_espera&integracao_id=integracao_id&tempo_medio_ring=tempo_medio_ring&tempo_medio_atendimento=tempo_medio_atendimento&tempo_medio_pos_atendimento=tempo_medio_pos_atendimento&max_dias_agendamento=max_dias_agendamento&max_ag_espec_dia_agente=max_ag_espec_dia_agente&max_ag_espec_agente=max_ag_espec_agente&tempo_dial=tempo_dial")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{baseUrl}/ipbox/api/criarFilaAtiva")

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 = "descricao=descricao&operacao=operacao&tipo_discagem=tipo_discagem&num_canais=num_canais&canal_dialer=canal_dialer&adicionar_ddd_local=adicionar_ddd_local&overdial=overdial&max_overdial=max_overdial&operadora=operadora&tempo_max_atendimento=tempo_max_atendimento&tamanho_fila=tamanho_fila&tempo_max_tocando_agente=tempo_max_tocando_agente&tempo_max_fila_espera=tempo_max_fila_espera&integracao_id=integracao_id&tempo_medio_ring=tempo_medio_ring&tempo_medio_atendimento=tempo_medio_atendimento&tempo_medio_pos_atendimento=tempo_medio_pos_atendimento&max_dias_agendamento=max_dias_agendamento&max_ag_espec_dia_agente=max_ag_espec_dia_agente&max_ag_espec_agente=max_ag_espec_agente&tempo_dial=tempo_dial"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "id": 20,
    "descricao": "FILA API 8",
    "operacao": "OPERACAO 2"
  }
}

{
  "errors": [
    {
      "status": 409,
      "title": "Erro",
      "detail": "(mensagem dinâmica, varia conforme o erro encontrado)"
    }
  ]
}

POST

ipbox

api

criarFilaAtiva

curl --request POST \
  --url https://{baseUrl}/ipbox/api/criarFilaAtiva \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data descricao=descricao \
  --data operacao=operacao \
  --data tipo_discagem=tipo_discagem \
  --data num_canais=num_canais \
  --data canal_dialer=canal_dialer \
  --data adicionar_ddd_local=adicionar_ddd_local \
  --data overdial=overdial \
  --data max_overdial=max_overdial \
  --data operadora=operadora \
  --data tempo_max_atendimento=tempo_max_atendimento \
  --data tamanho_fila=tamanho_fila \
  --data tempo_max_tocando_agente=tempo_max_tocando_agente \
  --data tempo_max_fila_espera=tempo_max_fila_espera \
  --data integracao_id=integracao_id \
  --data tempo_medio_ring=tempo_medio_ring \
  --data tempo_medio_atendimento=tempo_medio_atendimento \
  --data tempo_medio_pos_atendimento=tempo_medio_pos_atendimento \
  --data max_dias_agendamento=max_dias_agendamento \
  --data max_ag_espec_dia_agente=max_ag_espec_dia_agente \
  --data max_ag_espec_agente=max_ag_espec_agente \
  --data tempo_dial=tempo_dial

import requests

url = "https://{baseUrl}/ipbox/api/criarFilaAtiva"

payload = {
    "descricao": "descricao",
    "operacao": "operacao",
    "tipo_discagem": "tipo_discagem",
    "num_canais": "num_canais",
    "canal_dialer": "canal_dialer",
    "adicionar_ddd_local": "adicionar_ddd_local",
    "overdial": "overdial",
    "max_overdial": "max_overdial",
    "operadora": "operadora",
    "tempo_max_atendimento": "tempo_max_atendimento",
    "tamanho_fila": "tamanho_fila",
    "tempo_max_tocando_agente": "tempo_max_tocando_agente",
    "tempo_max_fila_espera": "tempo_max_fila_espera",
    "integracao_id": "integracao_id",
    "tempo_medio_ring": "tempo_medio_ring",
    "tempo_medio_atendimento": "tempo_medio_atendimento",
    "tempo_medio_pos_atendimento": "tempo_medio_pos_atendimento",
    "max_dias_agendamento": "max_dias_agendamento",
    "max_ag_espec_dia_agente": "max_ag_espec_dia_agente",
    "max_ag_espec_agente": "max_ag_espec_agente",
    "tempo_dial": "tempo_dial"
}
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({
    descricao: 'descricao',
    operacao: 'operacao',
    tipo_discagem: 'tipo_discagem',
    num_canais: 'num_canais',
    canal_dialer: 'canal_dialer',
    adicionar_ddd_local: 'adicionar_ddd_local',
    overdial: 'overdial',
    max_overdial: 'max_overdial',
    operadora: 'operadora',
    tempo_max_atendimento: 'tempo_max_atendimento',
    tamanho_fila: 'tamanho_fila',
    tempo_max_tocando_agente: 'tempo_max_tocando_agente',
    tempo_max_fila_espera: 'tempo_max_fila_espera',
    integracao_id: 'integracao_id',
    tempo_medio_ring: 'tempo_medio_ring',
    tempo_medio_atendimento: 'tempo_medio_atendimento',
    tempo_medio_pos_atendimento: 'tempo_medio_pos_atendimento',
    max_dias_agendamento: 'max_dias_agendamento',
    max_ag_espec_dia_agente: 'max_ag_espec_dia_agente',
    max_ag_espec_agente: 'max_ag_espec_agente',
    tempo_dial: 'tempo_dial'
  })
};

fetch('https://{baseUrl}/ipbox/api/criarFilaAtiva', 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/criarFilaAtiva",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "descricao=descricao&operacao=operacao&tipo_discagem=tipo_discagem&num_canais=num_canais&canal_dialer=canal_dialer&adicionar_ddd_local=adicionar_ddd_local&overdial=overdial&max_overdial=max_overdial&operadora=operadora&tempo_max_atendimento=tempo_max_atendimento&tamanho_fila=tamanho_fila&tempo_max_tocando_agente=tempo_max_tocando_agente&tempo_max_fila_espera=tempo_max_fila_espera&integracao_id=integracao_id&tempo_medio_ring=tempo_medio_ring&tempo_medio_atendimento=tempo_medio_atendimento&tempo_medio_pos_atendimento=tempo_medio_pos_atendimento&max_dias_agendamento=max_dias_agendamento&max_ag_espec_dia_agente=max_ag_espec_dia_agente&max_ag_espec_agente=max_ag_espec_agente&tempo_dial=tempo_dial",
  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/criarFilaAtiva"

	payload := strings.NewReader("descricao=descricao&operacao=operacao&tipo_discagem=tipo_discagem&num_canais=num_canais&canal_dialer=canal_dialer&adicionar_ddd_local=adicionar_ddd_local&overdial=overdial&max_overdial=max_overdial&operadora=operadora&tempo_max_atendimento=tempo_max_atendimento&tamanho_fila=tamanho_fila&tempo_max_tocando_agente=tempo_max_tocando_agente&tempo_max_fila_espera=tempo_max_fila_espera&integracao_id=integracao_id&tempo_medio_ring=tempo_medio_ring&tempo_medio_atendimento=tempo_medio_atendimento&tempo_medio_pos_atendimento=tempo_medio_pos_atendimento&max_dias_agendamento=max_dias_agendamento&max_ag_espec_dia_agente=max_ag_espec_dia_agente&max_ag_espec_agente=max_ag_espec_agente&tempo_dial=tempo_dial")

	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/criarFilaAtiva")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("descricao=descricao&operacao=operacao&tipo_discagem=tipo_discagem&num_canais=num_canais&canal_dialer=canal_dialer&adicionar_ddd_local=adicionar_ddd_local&overdial=overdial&max_overdial=max_overdial&operadora=operadora&tempo_max_atendimento=tempo_max_atendimento&tamanho_fila=tamanho_fila&tempo_max_tocando_agente=tempo_max_tocando_agente&tempo_max_fila_espera=tempo_max_fila_espera&integracao_id=integracao_id&tempo_medio_ring=tempo_medio_ring&tempo_medio_atendimento=tempo_medio_atendimento&tempo_medio_pos_atendimento=tempo_medio_pos_atendimento&max_dias_agendamento=max_dias_agendamento&max_ag_espec_dia_agente=max_ag_espec_dia_agente&max_ag_espec_agente=max_ag_espec_agente&tempo_dial=tempo_dial")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{baseUrl}/ipbox/api/criarFilaAtiva")

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 = "descricao=descricao&operacao=operacao&tipo_discagem=tipo_discagem&num_canais=num_canais&canal_dialer=canal_dialer&adicionar_ddd_local=adicionar_ddd_local&overdial=overdial&max_overdial=max_overdial&operadora=operadora&tempo_max_atendimento=tempo_max_atendimento&tamanho_fila=tamanho_fila&tempo_max_tocando_agente=tempo_max_tocando_agente&tempo_max_fila_espera=tempo_max_fila_espera&integracao_id=integracao_id&tempo_medio_ring=tempo_medio_ring&tempo_medio_atendimento=tempo_medio_atendimento&tempo_medio_pos_atendimento=tempo_medio_pos_atendimento&max_dias_agendamento=max_dias_agendamento&max_ag_espec_dia_agente=max_ag_espec_dia_agente&max_ag_espec_agente=max_ag_espec_agente&tempo_dial=tempo_dial"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": {
    "id": 20,
    "descricao": "FILA API 8",
    "operacao": "OPERACAO 2"
  }
}

{
  "errors": [
    {
      "status": 409,
      "title": "Erro",
      "detail": "(mensagem dinâmica, varia conforme o erro encontrado)"
    }
  ]
}

Authorizations

Authorization

string

header

required

Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo Bearer / Basic.

Body

application/x-www-form-urlencoded

descricao

string

required

Descricao da fila

Example:

"descricao"

operacao

string

required

Id ou descricao da operacao

Example:

"operacao"

tipo_discagem

string

required

[Obrigatório] Tipo de discagem da fila. Valores possíveis: PREDICTIVE, PREVIEW, POWER, MENSAGEM, MODAL (aceita também o alias "SGL" para MODAL).

Example:

"tipo_discagem"

num_canais

string

required

Numero max de canais da fila

Example:

"num_canais"

canal_dialer

string

required

Canal de discagem da fila

Example:

"canal_dialer"

adicionar_ddd_local

string

required

Adicionar DDD em ligacoes locais: Y ou N

Example:

"adicionar_ddd_local"

overdial

string

[Opcional] "Y"/"N" — se a fila pode fazer overdial (discar mais números que agentes disponíveis). Default: N.

Example:

"overdial"

max_overdial

string

[Obrigatório apenas quando overdial=Y] Quantidade máxima de overdial (mínimo 2, limitado pela configuração/licença do sistema).

Example:

"max_overdial"

operadora

string

[Opcional] Nome da operadora associada à fila.

Example:

"operadora"

tempo_max_atendimento

string

[Opcional] Tempo máximo (minutos) de atendimento da ligação. Default: 10.

Example:

"tempo_max_atendimento"

tamanho_fila

string

[Opcional] Tamanho máximo da fila de espera. Default: 1.

Example:

"tamanho_fila"

tempo_max_tocando_agente

string

[Opcional] Tempo máximo (segundos) tocando para o agente antes de desistir. Default: 0 (sem limite).

Example:

"tempo_max_tocando_agente"

tempo_max_fila_espera

string

[Opcional] Tempo máximo (segundos) que a ligação pode esperar na fila. Default: 1.

Example:

"tempo_max_fila_espera"

integracao_id

string

[Opcional] Id da integração associada à fila. Default: 0 (nenhuma).

Example:

"integracao_id"

tempo_medio_ring

string

[Opcional] Tempo médio de toque (ring), usado pelo discador preditivo. Se omitido, usa a configuração TEMPO_MEDIO_RING do sistema.

Example:

"tempo_medio_ring"

tempo_medio_atendimento

string

[Opcional] Tempo médio de atendimento, usado pelo discador preditivo. Se omitido, usa a configuração TEMPO_MEDIO_ATENDIMENTO do sistema.

Example:

"tempo_medio_atendimento"

tempo_medio_pos_atendimento

string

[Opcional] Tempo médio pós-atendimento, usado pelo discador preditivo. Se omitido, usa a configuração TEMPO_MEDIO_POS_ATENDIMENTO do sistema.

Example:

"tempo_medio_pos_atendimento"

max_dias_agendamento

string

[Opcional] Máximo de dias no futuro permitido para agendamentos. Se omitido, usa a configuração MAX_DIAS_AGENDAMENTO do sistema.

Example:

"max_dias_agendamento"

max_ag_espec_dia_agente

string

[Opcional] Máximo de agendamentos específicos por agente por dia. Se omitido, usa a configuração MAX_AG_ESPEC_AGENTE_DIA do sistema.

Example:

"max_ag_espec_dia_agente"

max_ag_espec_agente

string

[Opcional] Máximo de agendamentos específicos por agente. Se omitido, usa a configuração MAX_AG_ESPEC_AGENTE do sistema.

Example:

"max_ag_espec_agente"

tempo_dial

string

[Opcional] Tempo de dial usado pelo discador. Se omitido, usa a configuração TEMPO_DIAL do sistema.

Example:

"tempo_dial"

Response

Fila criada com sucesso.

status

string

Example:

"success"

data

object

Show child attributes

Guias

Webhook - Referência técnica

Referência da API

criarFilaAtiva

Authorizations

Body

Response