vértice
Produto Preços Painel
Comunidades

Comunidades

Criação, grupos vinculados, participantes, admins, convites e configurações de comunidades.

Referência

18 endpoints

GET /instances/:id/communities →

Listar comunidades

Lista as comunidades das quais o número participa.

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

Criar comunidade

Cria uma comunidade com nome e descrição.

API key · Escopo write
GET /instances/:id/communities/invite/:code →

Metadados de convite de comunidade

Metadados de convite de comunidade.

API key · Escopo read
POST /instances/:id/communities/join →

Entrar em comunidade por convite

Entra em comunidade por convite.

API key · Escopo write
GET /instances/:id/communities/:jid →

Metadados da comunidade

Retorna metadados e participantes da comunidade.

API key · Escopo read
PATCH /instances/:id/communities/:jid →

Atualizar nome/descrição

Atualiza nome/descrição.

API key · Escopo write
DELETE /instances/:id/communities/:jid →

Sair da comunidade

Confere a listagem nativa após solicitar saída. left=true somente quando a conta deixa de constar. HTTP409/community_leave_not_confirmed se continuar vinculada; HTTP502/community_leave_unverified se a conferência falhar. Não desativa a comunidade globalmente.

API key · Escopo write
POST /instances/:id/communities/:jid/leave →

Sair da comunidade

Confere a listagem nativa após solicitar saída. left=true somente quando a conta deixa de constar. HTTP409/community_leave_not_confirmed se continuar vinculada; HTTP502/community_leave_unverified se a conferência falhar. Não desativa a comunidade globalmente.

API key · Escopo write
GET /instances/:id/communities/:jid/groups →

Listar grupos vinculados

Lista os grupos vinculados à comunidade.

API key · Escopo read
POST /instances/:id/communities/:jid/groups →

Criar/vincula grupo à comunidade

Cria um grupo vinculado ou vincula grupos existentes.

API key · Escopo write
DELETE /instances/:id/communities/:jid/groups →

Desvincular grupos

Desvincula grupos da comunidade.

API key · Escopo write
GET /instances/:id/communities/:jid/invite →

Link de convite da comunidade

Retorna o link de convite da comunidade.

API key · Escopo read
POST /instances/:id/communities/:jid/invite/revoke →

Revogar link de convite

Revoga e gera um novo link de convite.

API key · Escopo write
GET /instances/:id/communities/:jid/requests →

Solicitações de entrada

Lista solicitações de entrada na comunidade.

API key · Escopo read
POST /instances/:id/communities/:jid/participants →

Gerencia participantes

Adiciona, remove, promove, rebaixa, aprova ou rejeita participantes.

API key · Escopo write
PATCH /instances/:id/communities/:jid/settings →

Configurações da comunidade

setting aceita locked/unlocked como entrada, mas o WhatsApp pode rejeitar configurações no nó pai: HTTP422/community_setting_rejected (403 para permissão negada). announcement/not_announcement pertencem ao grupo de anúncios. Valida todos os campos antes das operações e informa quantas alterações foram aplicadas antes de uma recusa; não há rollback nativo.

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

Atualizar foto da comunidade

Atualiza foto da comunidade.

API key · Escopo write
POST /instances/:id/communities/:jid/ephemeral →

Configura temporárias nos grupos da comunidade

Até 100 grupos; seconds aceita 0,86400,604800,7776000. Operação não atômica: 207 informa sucessos/falhas por grupo.

API key · Escopo write