Pular para o conteúdo 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 ou TokenInstance em todas as rotas. Cada chamada valida a ownership da instância. Esta seção cobre as rotas /api/profile/* para atualizar o próprio perfil, consultar perfis de terceiros e ler / atualizar configurações de privacidade do WhatsApp.

​
Endpoints

MétodoPathFunção
POST/api/profile/account/:instanceAtualizar foto / nome / status
GET/api/profile/getAccount/:instanceObter perfil próprio ou de terceiro
GET/api/profile/getPrivacy/:instanceObter privacidade
GET/api/profile/privacy/:instanceAlias de /getPrivacy
POST/api/profile/privacy/:instanceAtualizar privacidade

​
Estrutura de privacidade

A API agrupa as configurações em três subobjetos: visibility, privacy e permissions. 
{
  "visibility": {
    "lastSeen": "contacts",
    "status": "all",
    "profile": "contacts",
    "online": "match_last_seen"
  },
  "privacy": {
    "readReceipts": "all"
  },
  "permissions": {
    "callAdd": "all",
    "groupAdd": "contacts"
  }
}

​
Valores aceitos por campo

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

​
Modelo AccountProfileData

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

​
Envelope de erro

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

​
Quadro de erros (resumo)

CategoriaMensagem
ValidaçãoAt least one field must be provided (profilePicture, profileName, or profileStatus)
ValidaçãoAt least one privacy setting must be provided
ValidaçãoInvalid <field> value: <value>. Valid values: ...
EstadoInstance is not connected to WhatsApp
NúmeroNumber not found or not registered on WhatsApp
Númeroinvalid LID format
Falhafailed to update <field> privacy: <reason>

​
Próximo

Atualizar conta

Mudar foto, nome de exibição ou status.

Atualizar privacidade

Ajustar quem vê o que.