Consultar privacidad

GET

api

profile

getPrivacy

:instance

Consultar privacidad

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 o TokenInstance • Rate limit: Global (100/min) • Idempotente: sí (solo lectura)

Descripción

Devuelve todas las configuraciones de privacidad de la cuenta conectada, agrupadas en tres sub-objetos: visibility, privacy y permissions.

Ejemplos

Default

Lee el snapshot completo de privacidad de la cuenta, agrupado en visibility, privacy y permissions. Sin parámetros de query ni cuerpo, una lectura simple para verificar el estado actual antes de llamar al POST correspondiente.

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)
}

Respuesta exitosa

Devuelve el snapshot completo de privacidad en settings, agrupado en tres sub-objetos: visibility (lastSeen, status, profile, online), privacy (readReceipts) y permissions (callAdd, groupAdd). Los valores provienen del store local sincronizado vía appstate, los cambios hechos en la app oficial pueden tardar unos segundos en reflejarse aquí.

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 ruta

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

Valores aceptados

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

Los valores provienen principalmente del store local de whatsmeow, sincronizado vía appstate. Los cambios hechos en la app oficial aparecen aquí con unos segundos de latencia.
online: match_last_seen significa que tu presencia en línea sigue la regla de lastSeen, si lastSeen=none, nadie te ve en línea tampoco.
Valores predeterminados para cuentas recién creadas: todo en all.

Errores

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

Envoltorio:

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Consultar privacidad

Descripción

Ejemplos

Default

Respuesta exitosa

Parámetros de ruta

Cabeceras

Valores aceptados

Notas

Errores

​Descripción

​Ejemplos

​Default

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Valores aceptados

​Notas

​Errores

Descripción

Ejemplos

Default

Respuesta exitosa

Parámetros de ruta

Cabeceras

Valores aceptados

Notas

Errores