vértice
Produto Preços Painel
Grupos

Grupos

Criação e administração de grupos: participantes, admins, convites, configurações e saída. Requer uma instância conectada.

Referência

16 endpoints

GET /instances/:id/groups →

Listar grupos da instância

Lista os grupos dos quais o número participa, com tamanho, dono e configurações.

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

Criar um grupo

Cria um grupo com nome e lista inicial de participantes.

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

Metadados e participantes do grupo

Retorna nome, descrição, configurações, admins e todos os participantes do grupo.

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

Atualizar nome e descrição

Atualiza o nome e/ou a descrição de um grupo.

API key · Escopo write
POST /instances/:id/groups/:jid/participants →

Adicionar/remover/promover/rebaixar participantes

Adiciona, remove, promove ou rebaixa participantes do grupo em uma única chamada.

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

Atualizar a foto do grupo

Atualiza a foto do grupo.

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

Remover a foto do grupo

Remove a foto do grupo.

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

Listar solicitações de entrada

Lista solicitações de entrada.

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

Aprova/rejeita solicitações de entrada

Aprova/rejeita solicitações de entrada.

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

Definir mensagens temporárias do grupo

Define mensagens temporárias do grupo.

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

Consultar o link de convite

Retorna o código e o link de convite atual do grupo.

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

Revogar e gerar um novo link

Revoga o link atual e gera um novo código de convite.

API key · Escopo write
POST /instances/:id/groups/join →

Entrar em um grupo por código

Entra em um grupo a partir do código de convite.

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

Metadados de um convite

Consulta os metadados públicos de um convite de grupo antes de entrar.

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

Sair do grupo

Faz o número conectado sair do grupo.

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

Restringir mensagens/edição e modo de entrada

Restringe quem pode falar (announcement) ou quem pode editar as informações do grupo (locked).

API key · Escopo write