Atualizar configuração da fila
curl --request PUT \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"disableEnqueueWhenDisconnected": true
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings"
payload = { "disableEnqueueWhenDisconnected": True }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({disableEnqueueWhenDisconnected: true})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings', 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://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'disableEnqueueWhenDisconnected' => true
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings"
payload := strings.NewReader("{\n \"disableEnqueueWhenDisconnected\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Client-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"disableEnqueueWhenDisconnected\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"disableEnqueueWhenDisconnected\": true\n}"
response = http.request(request)
puts response.read_bodyMessage Queue
Atualizar configuração da fila
Atualiza as configurações de fila de uma instância, permitindo controlar o comportamento de enfileiramento quando desconectada.
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-queue-settings
Atualizar configuração da fila
curl --request PUT \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"disableEnqueueWhenDisconnected": true
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings"
payload = { "disableEnqueueWhenDisconnected": True }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({disableEnqueueWhenDisconnected: true})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings', 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://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'disableEnqueueWhenDisconnected' => true
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings"
payload := strings.NewReader("{\n \"disableEnqueueWhenDisconnected\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Client-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"disableEnqueueWhenDisconnected\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/update-queue-settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"disableEnqueueWhenDisconnected\": true\n}"
response = http.request(request)
puts response.read_bodyConceituação
Este método permite atualizar configurações relacionadas ao comportamento da fila de mensagens da instância. Atualmente, é possível configurar se a instância deve ou não aceitar novas mensagens na fila enquanto estiver desconectada.Atributos
Obrigatórios
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
string
obrigatório
Token da sua instância Z-API.
Body (Obrigatórios)
boolean
Define se a instância deve bloquear o enfileiramento de mensagens quando estiver desconectada.
Request Body
{
"disableEnqueueWhenDisconnected": true
}
Comportamento da fila
- Por padrão, a Z-API permite o envio de mensagens para a fila mesmo quando a instância não possui um número conectado
- Quando
disableEnqueueWhenDisconnectedfortrue, novas mensagens não serão adicionadas à fila enquanto a instância estiver desconectada - Quando
disableEnqueueWhenDisconnectedforfalse, o comportamento padrão é mantido (mensagens continuam sendo enfileiradas mesmo desconectado) - Essa configuração é útil para evitar o acúmulo de mensagens na fila quando a instância é reutilizada sem um número conectado
Response
200
{
"success": true
}