Saltar al contenido principal

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 TokenInstance en cada ruta. Cada llamada valida la propiedad de la instancia. Esta sección cubre las rutas /api/profile/* para actualizar tu propio perfil, consultar perfiles de terceros y leer o actualizar la configuración de privacidad de WhatsApp.

​
Endpoints

MethodPathFunción
POST/api/profile/account/:instanceActualizar foto / nombre / estado
GET/api/profile/getAccount/:instanceObtener tu perfil o el de un tercero
GET/api/profile/getPrivacy/:instanceObtener configuración de privacidad
GET/api/profile/privacy/:instanceAlias de /getPrivacy
POST/api/profile/privacy/:instanceActualizar privacidad

​
Estructura de privacidad

La API agrupa los ajustes en tres sub-objetos: visibility, privacy y permissions. 
{
  "visibility": {
    "lastSeen": "contacts",
    "status": "all",
    "profile": "contacts",
    "online": "match_last_seen"
  },
  "privacy": {
    "readReceipts": "all"
  },
  "permissions": {
    "callAdd": "all",
    "groupAdd": "contacts"
  }
}

​
Valores aceptados por campo

CampoValores
lastSeen / status / profileall / contacts / contact_blacklist / none
onlineall / match_last_seen
readReceiptsall / none
callAddall / known
groupAddall / contacts / contact_blacklist

​
Modelo AccountProfileData

Respuesta de GET /getAccount: 
{
  "profilePicture": "https://pps.whatsapp.net/...",
  "profileName": "João Silva",
  "profileStatus": "Disponivel",
  "phoneNumber": "5511999999999",
  "jid": "5511999999999@s.whatsapp.net",
  "lid": "199789077627112@lid"
}

​
Envoltorio de error

{
  "success": false,
  "error": { "message": "At least one field must be provided (profilePicture, profileName, or profileStatus)" }
}

​
Referencia de errores (resumen)

CategoríaMensaje
ValidaciónAt least one field must be provided (profilePicture, profileName, or profileStatus)
ValidaciónAt least one privacy setting must be provided
ValidaciónInvalid <field> value: <value>. Valid values: ...
EstadoInstance is not connected to WhatsApp
NúmeroNumber not found or not registered on WhatsApp
Númeroinvalid LID format
Fallafailed to update <field> privacy: <reason>

​
Siguiente

Actualizar cuenta

Cambia foto, nombre visible o estado.

Actualizar privacidad

Ajusta quién ve qué.