Verificar privacidade

GET

api

profile

getPrivacy

:instance

Verificar privacidade

curl --request GET \
  --url https://api.example.com/api/profile/getPrivacy/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://api.example.com/api/profile/getPrivacy/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim (read-only)

Descrição

Retorna todas as configurações de privacidade da conta conectada agrupadas em três subobjetos: visibility, privacy e permissions.

Exemplos

Padrão

Lê o snapshot completo de privacidade da conta agrupado em visibility, privacy e permissions. Sem query params nem body, leitura simples para conferir o estado atual antes de chamar o POST correspondente.

curl -X GET "https://ryzeapi.cloud/api/profile/getPrivacy/$Instance_Name" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/profile/getPrivacy/${process.env.Instance_Name}`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/profile/getPrivacy/{os.environ['Instance_Name']}",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/profile/getPrivacy/"+os.Getenv("Instance_Name"), nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Resposta de sucesso

Retorna o snapshot completo de privacidade em settings, agrupado em três subobjetos: visibility (lastSeen, status, profile, online), privacy (readReceipts) e permissions (callAdd, groupAdd). Os valores vêm do store local sincronizado via appstate, alterações feitas no app oficial podem demorar alguns segundos para refletir.

200 OK

{
  "success": true,
  "message": "Privacy settings retrieved successfully",
  "settings": {
    "visibility": {
      "lastSeen": "contacts",
      "status": "all",
      "profile": "contacts",
      "online": "match_last_seen"
    },
    "privacy": {
      "readReceipts": "all"
    },
    "permissions": {
      "callAdd": "all",
      "groupAdd": "contacts"
    }
  }
}

Parâmetros de rota

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

Valores aceitos

Campo	Valores
`lastSeen` / `status` / `profile`	`all` / `contacts` / `contact_blacklist` / `none`
`online`	`all` / `match_last_seen`
`readReceipts`	`all` / `none`
`callAdd`	`all` / `known`
`groupAdd`	`all` / `contacts` / `contact_blacklist`

Notas

Os valores vêm primariamente do store local do whatsmeow, sincronizado via appstate. Alterações feitas pelo app oficial aparecem aqui com latência de segundos.
online: match_last_seen significa que sua presença online segue a regra de lastSeen, se lastSeen=none, ninguém te vê online também.
Defaults para contas recém-criadas: tudo em all.

Erros

HTTP	Mensagem
400	`Instance is not connected to WhatsApp`
404	`Instance not found`

Envelope:

{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Verificar privacidade

Descrição

Exemplos

Padrão

Resposta de sucesso

Parâmetros de rota

Headers

Valores aceitos

Notas

Erros

​Descrição

​Exemplos

​Padrão

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Valores aceitos

​Notas

​Erros

Descrição

Exemplos

Padrão

Resposta de sucesso

Parâmetros de rota

Headers

Valores aceitos

Notas

Erros