Saltar al contenido principal
GET
/
api
/
profile
/
getPrivacy
/
:instance
Consultar privacidad
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 o TokenInstanceRate 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"

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

instance
string
requerido
Nombre de la instancia.

Cabeceras

token
string
requerido
TokenAccount o TokenInstance.

Valores aceptados

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

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