Ativar Proteção de Grupo de Avisos
curl --request PUT \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": true
}'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard"
payload = { "value": 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({value: true})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard', 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-announcement-guard",
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([
'value' => 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-announcement-guard"
payload := strings.NewReader("{\n \"value\": 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-announcement-guard")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"value\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard")
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 \"value\": true\n}"
response = http.request(request)
puts response.read_bodyInstance
Ativar Proteção de Grupo de Avisos
Proteja seus grupos de avisos contra mensagens de golpe, removendo automaticamente conteúdos enviados por participantes que não são administradores e recebendo os dados do autor via webhook.
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
update-announcement-guard
Ativar Proteção de Grupo de Avisos
curl --request PUT \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"value": true
}'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard"
payload = { "value": 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({value: true})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard', 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-announcement-guard",
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([
'value' => 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-announcement-guard"
payload := strings.NewReader("{\n \"value\": 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-announcement-guard")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"value\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/update-announcement-guard")
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 \"value\": true\n}"
response = http.request(request)
puts response.read_bodyObservações sobre este endpoint
- Funciona apenas em grupos de avisos onde a instância é administradora.
- Ignora administradores.
- Cada mensagem gera um evento no webhook.
- O autor não é removido automaticamente.
Conceituação
A Proteção Anti-Golpe em Grupos de Avisos remove automaticamente, para todos os participantes, as mensagens enviadas por golpistas — ou seja, participantes que não são administradores — em grupos de avisos de comunidades, nos quais apenas administradores podem enviar mensagens. Sempre que uma mensagem é removida, você recebe um evento no webhook contendo os dados do autor. Assim, sua aplicação pode identificar o responsável e tomar as medidas necessárias, como removê-lo do grupo.Atributos
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.
Headers
| Header | Valor |
|---|---|
Client-Token | Token de segurança da conta |
Content-Type | application/json |
Request Body
{
"value": true
}
boolean
obrigatório
Valor que liga a proteção, TRUE ativa e FALSE desativa (Padrão = FALSE)
Response
200
boolean
É retornado com o status informado na requisição (TRUE or FALSE)