Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Crie grupos, gerencie participantes e convites, e ative mensagens efêmeras.
const group = await sock.groupCreate('My Fab Group', ['[email protected]', '[email protected]'])
console.log('created group with id: ' + group.gid)
await sock.sendMessage(group.id, { text: 'hello there' })
await sock.groupParticipantsUpdate(
jid,
['[email protected]', '[email protected]'],
'add' // 'remove' | 'demote' | 'promote'
)
await sock.groupUpdateSubject(jid, 'New Subject!')
await sock.groupUpdateDescription(jid, 'New Description!')
await sock.groupSettingUpdate(jid, 'announcement')
await sock.groupSettingUpdate(jid, 'not_announcement')
await sock.groupSettingUpdate(jid, 'unlocked')
await sock.groupSettingUpdate(jid, 'locked')
| Valor | Efeito |
|---|---|
announcement | Apenas admins enviam |
not_announcement | Todos os membros enviam |
locked | Apenas admins mudam configurações |
unlocked | Todos os membros mudam configurações |
await sock.groupLeave(jid)
const code = await sock.groupInviteCode(jid)
const link = 'https://chat.whatsapp.com/' + code
const code = await sock.groupRevokeInvite(jid)
const response = await sock.groupAcceptInvite(code)
code não inclui o prefixo https://chat.whatsapp.com/.const response = await sock.groupGetInviteInfo(code)
groupInviteMessageconst response = await sock.groupAcceptInviteV4(jid, groupInviteMessage)
const metadata = await sock.groupMetadata(jid)
console.log(metadata.id + ', title: ' + metadata.subject + ', description: ' + metadata.desc)
GroupMetadata inclui:
| Campo | Tipo | Descrição |
|---|---|---|
id | string | JID do grupo |
subject | string | Nome |
desc | string | undefined | Descrição |
owner | string | undefined | JID do criador |
participants | GroupParticipant[] | Lista com flags de admin |
ephemeralDuration | number | undefined | Timer ativo de mensagens efêmeras (segundos) |
announce | boolean | undefined | true quando só admins enviam |
restrict | boolean | undefined | true quando só admins mudam configurações |
memberAddMode | boolean | undefined | true quando todos podem adicionar membros |
joinApprovalMode | boolean | undefined | true quando entradas precisam de aprovação |
const response = await sock.groupFetchAllParticipating()
const response = await sock.groupRequestParticipantsList(jid)
const response = await sock.groupRequestParticipantsUpdate(
jid,
['[email protected]', '[email protected]'],
'approve' // ou 'reject'
)
await sock.groupToggleEphemeral(jid, 86400)
| Duração | Segundos |
|---|---|
| Off | 0 |
| 24 horas | 86400 |
| 7 dias | 604800 |
| 90 dias | 7776000 |
await sock.groupMemberAddMode(
jid,
'all_member_add' // ou 'admin_add'
)
| Modo | Efeito |
|---|---|
all_member_add | Qualquer membro pode adicionar |
admin_add | Apenas admins podem adicionar |
import NodeCache from '@cacheable/node-cache'
const groupCache = new NodeCache({ stdTTL: 5 * 60, useClones: false })
const sock = makeWASocket({
cachedGroupMetadata: async (jid) => groupCache.get(jid)
})
sock.ev.on('groups.update', async ([event]) => {
const metadata = await sock.groupMetadata(event.id)
groupCache.set(event.id, metadata)
})
sock.ev.on('group-participants.update', async (event) => {
const metadata = await sock.groupMetadata(event.id)
groupCache.set(event.id, metadata)
})