Guias/Grupos
Documentação

Grupos

Criação, participantes, convites, foto e saída.

Todas as rotas atuais usam o JWT da instância.

MétodoRotaEntradaSucesso
POST/instance/:instance/groupJSON201
PUT/instance/:instance/group/update-pictureJSON200
GET/instance/:instance/group/invitation-code?groupJid=...query200
PUT/instance/:instance/group/revoke-invitation?groupJid=...query200 vazio
PUT/instance/:instance/group/update-participants?groupJid=...query + JSON200 vazio
DELETE/instance/:instance/group/leave?groupJid=...query200 vazio

Criar

{
  "subject":"Equipe",
  "description":"Atendimento",
  "participants":["5511999999999","5511888888888"]
}

subject e ao menos um participante são obrigatórios. O sucesso retorna id, subject, subjectOwner, subjectTime, size, creation, owner, desc, descId, restrict, announce, isCommunity, isCommunityAnnounce, joinApprovalMode, memberAddMode e participants. Cada participante pode conter id, phoneNumber, lid, isAdmin, isSuperAdmin, displayName e error.

Atualizar foto

{
  "groupJid":"[email protected]",
  "image":"https://example.com/group.jpg"
}

groupJid precisa terminar em @g.us; image precisa ser URL HTTP(S). O download é limitado a 16 MB. O sucesso retorna as informações atualizadas.

Convite

GET .../invitation-code retorna {"invitation":"<código>"}. PUT .../revoke-invitation revoga o código atual e responde 200 com body vazio.

Participantes

{
  "action":"add",
  "participants":["5511999999999"]
}

action aceita add, remove, promote ou demote; a lista não pode ser vazia. O grupo vem na query groupJid. A resposta atual é 200 vazia.

Sair

DELETE .../[email protected] responde 200 vazio.

Os aliases antigos /group/*/:instanceName estão em Endpoints legados.