Pular para o conteúdo principal
GET
/
api
/
profile
/
getPrivacy
/
:instance
Verificar privacidade
curl --request GET \
  --url https://api.example.com/api/profile/getPrivacy/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

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"

​
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

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Valores aceitos

CampoValores
lastSeen / status / profileall / contacts / contact_blacklist / none
onlineall / match_last_seen
readReceiptsall / none
callAddall / known
groupAddall / 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

HTTPMensagem
400Instance is not connected to WhatsApp
404Instance not found
Envelope: 
{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}