Grupos
Adicionar/remover/promover/rebaixar participantes
Adiciona, remove, promove ou rebaixa participantes do grupo em uma única chamada.
API key
Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/groups/:jid/participants" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"participants":["5511888888888"],"action":"add"}'
const response = await fetch('https://seu-dominio/instances/:id/groups/:jid/participants', {
method: 'POST',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"participants": [
"5511888888888"
],
"action": "add"
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Adiciona, remove, promove ou rebaixa participantes do grupo em uma única chamada.
A operação exige que a instância esteja conectada ao WhatsApp. Caso o socket esteja desconectado, a API responde 409 not_connected.
Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato
Atributos
Header
x-api-key
string
obrigatório
API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.
content-type
string
obrigatório
application/json.
Path
id
string
obrigatório
ID da instância.
jid
string
obrigatório
JID do grupo terminando em @g.us.
Body
participants
array<string>
obrigatório
Lista de telefones/JIDs dos participantes.
action
string
obrigatório
add, remove, promote ou demote.
Payload
Request Body
{
"participants": [
"5511888888888"
],
"action": "add"
}
Contrato
200
Resposta
{
"data": {
"ok": true
}
}
Respostas de sucesso são envelopadas em data.
Erros comuns
400
Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401
Credencial ausente, inválida ou sessão expirada.
403
Escopo insuficiente, IP não autorizado ou workspace suspenso.
404
Recurso não encontrado ou pertence a outro workspace.
409
Instância não conectada ou conflito de estado.