vértice
Produto Preços Painel
Configurações

Configurações

Perfil do número, dispositivo, QR, reinício e comportamentos automáticos da instância.

Referência

11 endpoints

GET /instances/:id/settings →

Comportamento automático da instância

Retorna os comportamentos automáticos da instância: auto-leitura, rejeição de chamadas e proteção de grupos de avisos.

API key · Escopo read
PATCH /instances/:id/settings →

Atualizar auto-leitura, chamadas e proteção de grupos

Atualiza auto-leitura de mensagens/status, rejeição automática de chamadas, mensagem de rejeição e announcement guard.

API key · Escopo write
GET /instances/:id/profile →

Perfil do número conectado

Retorna nome, recado, foto e dados do dispositivo do número conectado.

API key · Escopo read
PATCH /instances/:id/profile →

Atualizar nome e recado do perfil

Atualiza o nome e o recado do perfil do WhatsApp.

API key · Escopo write
PUT /instances/:id/profile/picture →

Atualizar a foto do perfil

Troca a foto do perfil a partir de URL HTTPS ou base64.

API key · Escopo write
DELETE /instances/:id/profile/picture →

Remover a foto do perfil

Remove a foto do perfil do número conectado.

API key · Escopo write
GET /instances/:id/device →

Dados do dispositivo conectado

Retorna JID, telefone, nome e plataforma do dispositivo conectado.

API key · Escopo read
POST /instances/:id/restart →

Reinicia o socket da instância

Fecha e reabre o socket da instância sem apagar a sessão.

API key · Escopo write
GET /instances/:id/qr/bytes →

QR code em PNG

Baixa o QR code atual como imagem PNG binária.

API key · Escopo read
GET /instances/:id/qr/image →

QR code como data URL

Retorna o QR code como data URL para renderização no frontend.

API key · Escopo read
POST /instances/:id/extension-token →

Token efêmero de conexão/embed

Gera um token efêmero de 10 minutos para abrir a página/iframe de conexão.

API key · Escopo write