> ## Documentation Index
> Fetch the complete documentation index at: https://zapo.to/llms.txt
> Use this file to discover all available pages before exploring further.
# WaClient & coordinators
> Referência completa de métodos do WaClient e de cada coordinator: auth, message, presence, chat, group, newsletter, profile e mais.
Esta página lista **todos** os métodos públicos do `WaClient` e de seus coordinators, com descrições fundamentadas no código. Páginas dedicadas se aprofundam em [tipos de mensagem](/pt-br/reference/message-types), [mutations de chat](/pt-br/reference/chat-mutations) e a [API de baixo nível](/pt-br/reference/low-level).
WaClient
```ts theme={null}
new WaClient(options: WaClientOptions, logger?: Logger)
```
Veja [Configuração](/pt-br/concepts/configuration) para todas as opções.
| Member | Signature | Description |
| --------------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `connect` | `() => Promise` | Abre o socket e executa o handshake Noise; conduz o pareamento na primeira execução. Resolve quando conectado. |
| `disconnect` | `() => Promise` | Faz o flush das escritas write-behind pendentes e fecha o socket, mantendo as credenciais. |
| `logout` | `(reason?: WaLogoutReason) => Promise` | Desvincula este dispositivo companion no lado do servidor; depois limpa o estado armazenado conforme [`logoutStoreClear`](/pt-br/concepts/configuration#logout-store-clearing). Lança se não estiver autenticado. |
| `getState` | `() => WaAuthState` | Estado atual de auth/conexão. |
| `getCredentials` | `() => WaAuthCredentials \| null` | Credenciais atuais, se pareado. |
| `getClockSkewMs` | `() => number \| null` | Desvio estimado do relógio do servidor (a partir do keep-alive), ou `null`. |
| `ignoreKey` | `(input: WaIgnoreKey \| WaIgnoreKeyPredicate) => () => void` | Descarta stanzas inbound que casam **antes** de qualquer handler rodar — descriptor ou predicate (veja [Ignorando stanzas inbound](#ignoring-inbound-stanzas)). Retorna uma função `unregister`. |
| `on` / `once` / `off` | `(event, listener) => this` | Emissor de eventos tipado sobre o [`WaClientEventMap`](/pt-br/concepts/events). |
Ignorando stanzas inbound
`client.ignoreKey(input)` descarta stanzas ``, ``, ``, ``, `` e `` que casam antes de qualquer handler — incluindo os caminhos de persistência e decifragem — ver. O coordinator ainda envia o ack apropriado para o servidor parar de re-entregar.
Aceita dois formatos:
Descriptor declarativo — `WaIgnoreKey`
```ts theme={null}
import type { WaIgnoreKey } from 'zapo-js'
// Descarta tudo de um peer
const off = client.ignoreKey({ remoteJid: spammerJid })
// Descarta só as mensagens daquele peer (mantém receipts / presence)
client.ignoreKey({ remoteJid: spammerJid, only: ['message'] })
// Descarta os echoes das suas próprias mensagens (multi-device fan-in)
client.ignoreKey({ fromMe: true, only: ['message'] })
off() // unregister
```
| Campo | Tipo | Notas |
| ------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `remoteJid` | `string \| readonly string[]` | O JID do chat. Entradas do array fazem OR. Também casa contra os attrs alt `sender_pn` / `sender_lid` / `participant_pn` / `participant_lid` (e `sender_lid` em ``), então uma forma do JID pega a outra. |
| `fromMe` | `boolean` | Se a stanza foi enviada por esta conta. |
| `id` | `string` | Id da stanza. |
| `participant` | `string` | O autor em grupos / broadcasts. Também casa contra as formas alt. |
| `only` | `readonly ('message' \| 'receipt' \| 'notification' \| 'presence' \| 'chatstate' \| 'call')[]` | Restringe a tags específicas. Default: todas as seis. |
Múltiplos campos de topo fazem **AND** entre si; o array de `remoteJid` faz **OR**. Pelo menos um de `remoteJid` / `fromMe` / `id` / `participant` é obrigatório — descriptors vazios e arrays vazios lançam erro.
Predicate — `WaIgnoreKeyPredicate`
Pra qualquer coisa que o descriptor não consiga expressar (filtros por kind de chat, regras customizadas combinando vários campos), passe um predicate `(ctx: WaIgnoreKeyContext) => boolean`. Retorne `true` pra descartar. A lib já fez o parse do node em wire-format antes de chamar — sem precisar mexer em `BinaryNode`.
```ts theme={null}
import { isGroupJid, isStatusBroadcastJid, isNewsletterJid } from 'zapo-js'
// Descarta toda mensagem de grupo; mantém receipts/notifications de grupo
client.ignoreKey((m) => m.kind === 'message' && isGroupJid(m.remoteJid ?? ''))
// Descarta todos os status broadcasts
client.ignoreKey((m) => isStatusBroadcastJid(m.remoteJid ?? ''))
// Só 1:1 — descarta qualquer coisa de grupo, broadcast ou newsletter
client.ignoreKey((m) => {
const j = m.remoteJid ?? ''
return isGroupJid(j) || isStatusBroadcastJid(j) || isNewsletterJid(j)
})
```
O `WaIgnoreKeyContext` carrega os mesmos campos contra os quais o descriptor casa, já parseados:
| Campo | Tipo | Notas |
| ------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `kind` | `'message' \| 'receipt' \| 'notification' \| 'presence' \| 'chatstate' \| 'call'` | Tag da stanza. |
| `remoteJid` | `string \| null` | JID do chat sem device — JID do grupo para grupos, JID PN ou LID na forma **user** para 1:1 (o segmento `:device` é stripped para casar com `event.key.remoteJid`). Valores `from` sem user (ex.: `s.whatsapp.net`) ficam como vieram. |
| `fromMe` | `boolean` | Já resolvido contra o `meJid` da conta. |
| `id` | `string \| undefined` | Id da stanza. |
| `participant` | `string \| null` | O autor em grupos / broadcasts. Mesmo stripping de device do `remoteJid`; `null` para stanzas que não são de grupo. |
O predicate vê `from` / `participant` com o device stripped — mas **sem** resolução de alt-attr PN ↔ LID. O formato descriptor é quem cuida da parte de PN ↔ LID automaticamente; se você precisa de matching por JID com cobertura de forma alt *junto* de uma regra custom, prefira o `remoteJid` do descriptor com `only`.
Os nodes de controle de stream e as tags `success` / `failure` críticas para a conexão passam pelos filtros para manter o fluxo de auth intacto.
Coordinator getters
| Getter | Type | Section |
| --------------- | ------------------------------- | ------------------------------------------------ |
| `auth` | `WaAuthClient` | [auth](#auth) |
| `message` | `WaMessageCoordinator` | [message](#message) |
| `presence` | `WaPresenceCoordinator` | [presence](#presence) |
| `chat` | `WaAppStateMutationCoordinator` | [chat](#chat) |
| `group` | `WaGroupCoordinator` | [group](#group) |
| `status` | `WaStatusCoordinator` | [status](#status) |
| `broadcastList` | `WaBroadcastListCoordinator` | [broadcastList](#broadcastlist) |
| `newsletter` | `WaNewsletterCoordinator` | [newsletter](#newsletter) |
| `privacy` | `WaPrivacyCoordinator` | [privacy](#privacy) |
| `profile` | `WaProfileCoordinator` | [profile](#profile) |
| `business` | `WaBusinessCoordinator` | [business](#business) |
| `bot` | `WaBotCoordinator` | [bot](#bot) |
| `email` | `WaEmailCoordinator` | [email](#email) |
| `mobile` | `WaMobileCoordinator` | [mobile](#mobile) |
| `lowlevel` | `WaLowLevelCoordinator` | [API de baixo nível](/pt-br/reference/low-level) |
***
auth
`client.auth` (`WaAuthClient`). O pareamento é majoritariamente orientado a eventos ([Autenticação](/pt-br/concepts/authentication)); estes são os pontos de entrada voltados ao usuário.
| Method | Signature | Description |
| ---------------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `requestPairingCode` | `(phoneNumber, shouldShowPushNotification?, customCode?) => Promise` | Solicita um código de pareamento de 8 caracteres (fluxo link-code). O client já deve estar conectado — chame após o evento `auth_pairing_required`. `customCode` sugere um código; o servidor pode retornar um diferente. |
| `fetchPairingCountryCodeIso` | `() => Promise` | O código ISO de país que o servidor resolveu para a conta. |
| `getState` | `(connected?) => { connected, registered, hasQr, hasPairingCode }` | Flags de prontidão de auth. |
| `getCurrentCredentials` | `() => WaAuthCredentials \| null` | Credenciais carregadas, ou `null`. |
***
message
`WaMessageCoordinator` — veja [Envio](/pt-br/guides/sending-messages) & [Recebimento](/pt-br/guides/receiving-messages).
| Method | Signature | Description |
| -------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `send` | `(to, content: WaSendMessageContent, options?: WaSendMessageOptions) => Promise` | Envia qualquer [tipo de conteúdo](/pt-br/reference/message-types); lida com o fanout de dispositivos e retries por envio. Retorna o id da stanza + metadados de ack. |
| `sendReceipt` | `(event\|events, options?)` / `(jid, ids, options?) => Promise` | Envia um recibo de entrega/leitura/reprodução/inatividade. A entrega recebe ack automático ao descriptografar; use isto para leitura/reprodução manual. |
| `requestHistorySync` | `(input: WaRequestHistorySyncInput) => Promise<{ messageId }>` | Pede ao servidor para baixar mensagens mais antigas de um chat. Resolve assim que despachado — o backlog chega depois como `history_sync_chunk`. Veja [Solicitando histórico antigo](/pt-br/guides/receiving-messages#requesting-older-history). |
| `download` | `(source, options?) => Promise` | Faz streaming de mídia descriptografada (MAC + SHA-256 verificados conforme consumida). Cancele via `options.signal`. |
| `downloadToFile` | `(source, filePath, options?) => Promise` | Faz streaming de mídia descriptografada para um arquivo. |
| `downloadBytes` | `(source, options?) => Promise` | Bufferiza mídia descriptografada na memória — apenas mídia pequena; limite com `options.maxBytes`. |
| `tryDecryptAddon` | `(event) => Promise` | Descriptografa um addon (voto em enquete, reação, …) e emite `message_addon`. Chamado automaticamente por padrão; opt-out com `addons: { autoDecrypt: false }` para chamar você mesmo. |
| `syncSignalSession` | `(jid, reasonIdentity?) => Promise` | Força a atualização da(s) sessão(ões) Signal de um JID; `reasonIdentity` também reemite o token de contato confiável. |
| `getReachoutTimelock` | `() => Promise` | Timelock do lado do servidor que limita o cold outreach a não-contatos. |
| `getNewChatMessageCapping` | `(type?) => Promise` | Cota de mensagens por ciclo aplicada a threads de chats novos (cota, usado, ciclo, status). |
`source` é um `WaIncomingMessageEvent` ou um `Proto.IMessage` bruto.
***
presence
`WaPresenceCoordinator` — veja [Presença & status](/pt-br/guides/presence-status).
| Method | Signature | Description |
| --------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `send` | `(type?: 'available' \| 'unavailable') => Promise` | Faz o broadcast da sua presença online/offline. |
| `sendChatstate` | `(jid, options) => Promise` | Envia uma dica de digitando/gravando/pausado para um chat. |
| `subscribe` | `(jid, options?) => Promise` | Inscreve-se na presença/chat-state de um contato. Por jid e por conexão — **reinscreva-se após reconectar**. |
***
chat
`WaAppStateMutationCoordinator` — referência completa (incluindo o `set`/`remove` genérico e todos os schemas) em [Mutations de chat](/pt-br/reference/chat-mutations).
| Method | Signature |
| --------------------------------------------------------------- | -------------------------------------------------------- |
| `setChatMute` | `(chatJid, muted, muteEndTimestampMs?) => Promise` |
| `setChatPin` / `setChatArchive` / `setChatRead` / `setChatLock` | `(chatJid, boolean) => Promise` |
| `setMessageStar` | `(message, starred) => Promise` |
| `clearChat` / `deleteChat` | `(chatJid, options?) => Promise` |
| `deleteMessageForMe` | `(message, options?) => Promise` |
| `setStatusPrivacy` / `setUserStatusMute` | `(input) / (jid, muted) => Promise` |
| `setBroadcastList` / `removeBroadcastList` | `(input) / (id) => Promise` |
| `set` / `remove` | `(input) => Promise` |
| `sync` / `flushMutations` | `(options?) / () => Promise<…>` |
| `getBlockedCollections` / `emitEventsFromSyncResult` | `(syncResult) => …` |
Pin e arquivamento são mutuamente exclusivos (fixar limpa o arquivamento e vice-versa); travar limpa ambos. `clearChat`/`deleteChat`/`deleteMessageForMe` são **somente locais** (seus dispositivos) — use um [revoke](/pt-br/guides/interactive-messages#revoking-delete-for-everyone) para apagar para todos. Um timer de silenciamento não desativa o mudo automaticamente no lado do client.
***
group
`WaGroupCoordinator` — veja [Grupos & comunidades](/pt-br/guides/groups). Operações sobre participantes retornam um [`WaParticipantActionResult`](/pt-br/guides/groups#managing-participants) por jid — o IQ tem sucesso como um todo mesmo quando alguns falham, então verifique o `status` / `code` de cada resultado.
| Method | Signature | Description |
| -------------------------------------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `queryGroupMetadata` | `(groupJid) => Promise` | Metadados completos do grupo. |
| `queryAllGroups` | `() => Promise` | Todos os grupos dos quais a conta participa. |
| `queryGroupInviteInfo` | `(code) => Promise` | Preview de um código de convite (assunto, tamanho, ephemeral, descrição, amostra reduzida de participantes). |
| `createGroup` | `(subject, participants, options?) => Promise` | Cria um grupo (você é adicionado automaticamente como admin; não inclua seu próprio JID). Retorna o metadata do novo grupo. |
| `setSubject` | `(groupJid, subject) => Promise` | Renomeia. |
| `setDescription` | `(groupJid, description\|null, prevDescId?) => Promise` | Define/limpa a descrição. |
| `setSetting` | `(groupJid, setting, enabled) => Promise` | Alterna uma flag booleana do grupo (`announcement`, `restrict`, `ephemeral`, `group_history`, `allow_admin_reports`, `no_frequently_forwarded`, flags de comunidade). |
| `setMemberAddMode` | `(groupJid, 'admin_add' \| 'all_member_add') => Promise` | Restringe quem pode adicionar membros (só admins ou qualquer um). Op. de admin. |
| `setMemberLinkMode` | `(groupJid, 'admin_link' \| 'all_member_link') => Promise` | Restringe quem pode compartilhar o link de convite. Op. de admin. |
| `setMemberShareGroupHistoryMode` | `(groupJid, 'admin_share' \| 'all_member_share') => Promise` | Esconde ou expõe o histórico anterior para novos membros. Op. de admin. |
| `setEphemeralDuration` | `(groupJid, expirationSeconds, trigger?) => Promise` | Liga as mensagens temporárias com uma duração específica (`86400` = 24h, `604800` = 7d, `7776000` = 90d). Use `setSetting('ephemeral', false)` para desligar. Op. de admin. |
| `addParticipants` / `removeParticipants` | `(groupJid, jids) => Promise` | Adiciona / remove membros. Um resultado por jid; verifique `status` / `code` para falhas parciais. |
| `promoteParticipants` / `demoteParticipants` | `(groupJid, jids) => Promise` | Concede / revoga admin. Mesmo formato por jid. |
| `leaveGroup` | `(groupJids) => Promise` | Sai de um ou mais grupos (em lote). |
| `queryInviteCode` | `(groupJid) => Promise` | Busca o código de convite atual (o segmento de caminho de `chat.whatsapp.com/`) **sem** rotacioná-lo. Operação de admin — não-admins recebem `403 not-authorized`. |
| `revokeInvite` | `(groupJid) => Promise` | Rotaciona o código de convite — todo link `chat.whatsapp.com/` antigo para de funcionar. Retorna o novo `code` mais `affectedParticipants`. |
| `joinGroupViaInvite` | `(code) => Promise` | Entra via código. Lança se expirado/revogado/lotado/já for membro. Retorna o metadata do grupo. |
| `createCommunity` | `(subject, options?) => Promise` | Cria uma comunidade (requer solicitação a menos que `membershipApprovalMode: 'open'`). |
| `deactivateCommunity` | `(communityJid) => Promise` | Exclui uma comunidade. |
| `linkSubGroups` / `unlinkSubGroups` | `(communityJid, jids, options?) => Promise<…>` | Vincula / desvincula sub-grupos (`removeOrphanedMembers` remove membros órfãos). |
| `queryLinkedGroupsParticipants` | `(communityJid) => Promise` | Participantes mesclados de uma comunidade. |
| `fetchSubGroups` | `(communityJid) => Promise` | Lista os sub-grupos (MEX). |
| `joinLinkedGroup` | `(communityJid, subGroupJid, options?) => Promise` | Entra em um sub-grupo vinculado. Chame `queryGroupMetadata` depois para obter o metadata completo. |
| `queryMembershipApprovalRequests` | `(groupJid) => Promise` | Solicitações de entrada pendentes. |
| `approveMembershipRequests` / `rejectMembershipRequests` | `(groupJid, jids) => Promise` | Aprova / rejeita solicitações. |
| `cancelMembershipRequests` | `(groupJid, jids) => Promise` | Cancela suas próprias solicitações pendentes. |
| `isInternalGroup` | `(groupJid) => Promise` | `true` para grupos internos do WhatsApp (MEX). |
| `transferCommunityOwnership` | `(communityJid, newOwnerJid) => Promise` | Transfere a propriedade da comunidade (MEX). |
| `fetchSubgroupSuggestions` | `(communityJid, hintSubgroupJid) => Promise` | Sub-grupos sugeridos (MEX). |
| `submitGroupSuspensionAppeal` | `(groupJid, options?) => Promise` | Recorre de uma suspensão (MEX). |
Métodos marcados com (MEX) exigem um transport [MEX](/pt-br/reference/glossary#mex) ativo e lançam quando ele está indisponível.
***
newsletter
`WaNewsletterCoordinator` — veja [Newsletters](/pt-br/guides/newsletters). Composto de operações de discovery, admin e messaging.
Discovery
| Method | Signature | Description |
| --------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------- |
| `fetch` / `fetchByInvite` | `(jid\|code, options?) => Promise` | Metadados por JID ou código de convite. |
| `fetchDehydrated` | `(keyOrInvite, options?) => Promise` | Metadados leves (sem imagem/seguidores). |
| `listSubscribed` | `(options?) => Promise` | Canais que você segue. |
| `searchDirectory` | `(options?) => Promise` | Pesquisa no diretório público. |
| `fetchRecommended` | `(options?) => Promise` | Canais recomendados. |
| `fetchSimilar` | `(jid, options?) => Promise` | Canais semelhantes a um. |
| `fetchDirectoryList` | `(options) => Promise` | Diretório paginado por país/categoria. |
| `fetchDirectoryCategoriesPreview` | `(options) => Promise` | Prévias de carrossel por categoria. |
| `fetchIsDomainPreviewable` | `(domains) => Promise>` | Quais domínios suportam prévias de link. |
Admin
| Method | Signature | Description |
| ----------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| `create` | `(input) => Promise` | Cria um canal (aceita automaticamente os TOS de criação; `picture` é enviada inline — mantenha pequena). |
| `update` | `(jid, input) => Promise` | Edita nome/descrição/imagem. |
| `delete` | `(jid) => Promise` | Exclusão **irreversível** — seguidores desvinculados, histórico descartado, JID queimado. |
| `fetchAdminInfo` | `(jid) => Promise` | Visão de metadados restrita a admins. |
| `fetchAdminCapabilities` | `(jid) => Promise>` | Capabilities concedidas à conta. |
| `fetchFollowers` | `(jid, options?) => Promise` | Lista paginada de seguidores. |
| `fetchInsights` | `(jid, metrics) => Promise<… \| null>` | Analytics de admin. |
| `fetchReports` | `() => Promise<… \| null>` | Denúncias de moderação contra canais que você possui. |
| `fetchPendingInvites` | `(jid) => Promise` | JIDs de convites de admin pendentes. |
| `fetchEnforcements` | `(jid) => Promise<… \| null>` | Estado de aplicação de moderação. |
| `fetchPollVoters` | `(input) => Promise>` | Votantes da enquete agrupados por opção. |
| `fetchMessageReactionSenders` | `(input) => Promise` | Remetentes de reações agrupados por emoji. |
| `createAdminInvite` | `(input) => Promise` | Convida um usuário como admin. |
| `acceptAdminInvite` | `(jid) => Promise` | Aceita um convite de admin pendente (aceita os TOS automaticamente). |
| `revokeAdminInvite` | `(input) => Promise` | Revoga um convite de admin enviado. |
| `changeOwner` | `(input) => Promise` | Transfere a propriedade para um admin convidado. |
| `demoteAdmin` | `(input) => Promise` | Rebaixa um admin a seguidor. |
| `queryTosState` / `acceptTos` | `(noticeIds) => Promise<…>` | Consulta / aceita avisos de TOS. |
| `logExposures` | `(exposures) => Promise` | Reporta exposições de capability (telemetria). |
Messaging
| Method | Signature | Description |
| --------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `send` | `(jid, content, options?) => Promise` | Publica uma mensagem (qualquer tipo de conteúdo). |
| `editMessage` | `(jid, parentMessageId, content) => Promise` | Edita uma mensagem publicada. |
| `react` / `revoke` / `votePoll` / `sendViewReceipt` | `(input) => Promise<{ stanzaId }>` | Reage / revoga / vota / recibo de visualização. |
| `fetchMessages` / `fetchMessageUpdates` | `(input) => Promise` | Pagina mensagens / busca edições-reações-votos em um intervalo. |
| `subscribeLiveUpdates` | `(jid) => Promise<{ durationSeconds }>` | Inscreve-se em atualizações ao vivo (**reinscreva-se após reconectar**). |
| `follow` / `unfollow` | `(jid) => Promise` | Segue / deixa de seguir. |
| `mute` | `(input) => Promise` | Silencia / dessilencia. |
***
privacy
`WaPrivacyCoordinator` — veja [Privacidade](/pt-br/guides/profile-privacy#privacy).
| Method | Signature | Description |
| --------------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `getPrivacySettings` | `() => Promise` | Valor atual de cada categoria de privacidade. |
| `setPrivacySetting` | `(setting, value) => Promise` | Atualiza uma categoria. Um valor no estilo `contact_blacklist` apenas alterna o modo — popule a lista separadamente via disallowed-list + app-state. |
| `getDisallowedList` | `(category) => Promise` | JIDs excluídos por categoria. |
| `getBlocklist` | `() => Promise` | Lista de bloqueio de toda a conta. |
| `blockUser` / `unblockUser` | `(jid) => Promise` | Bloqueia / desbloqueia. Um bloqueio impede o peer de mandar mensagem/ligar para você e oculta seu visto-por-último/online/foto/status dele. |
***
profile
`WaProfileCoordinator` — veja [Perfil](/pt-br/guides/profile-privacy#profile).
| Method | Signature | Description |
| --------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `getProfilePicture` | `(jid, type?: 'preview' \| 'image', existingId?) => Promise` | Envelope da imagem (`{ url?, directPath?, id?, type? }`). `type` default é `'preview'` (variante compacta); `'image'` retorna o original em alta resolução. Passe o `existingId` cacheado para o servidor fazer short-circuit quando a foto não mudou. |
| `setProfilePicture` | `(imageBytes, targetJid?) => Promise` | Define a imagem sua/de um alvo. `imageBytes` é enviado **como está** — pré-codifique um JPEG quadrado. Retorna o id da imagem. |
| `deleteProfilePicture` | `(targetJid?) => Promise` | Remove a imagem (operação de admin para grupos). |
| `getStatus` / `setStatus` | `(jid) / (text) => Promise<…>` | Obtém/define o "Sobre" legado. |
| `setPushName` | `(name) => Promise` | Atualiza o nome de exibição broadcast aos contatos. Aplicado às credenciais locais imediatamente e roteado por uma mutação de app-state; os contatos veem na sua próxima mensagem enviada. String vazia restaura o padrão do dispositivo. |
| `getProfiles` | `(jids) => Promise` | Id de imagem + status em lote. |
| `getDisappearingMode` | `(jids) => Promise` | Configuração de modo temporário em lote. |
| `setDisappearingMode` | `(durationSeconds) => Promise` | Define a duração padrão de modo temporário aplicada a **novos** chats 1:1 (`0`/`86400`/`604800`/`7776000`). Chats existentes mantêm a configuração. |
| `getTextStatuses` | `(jids) => Promise` | Status de texto moderno em lote (emoji + texto). |
| `setTextStatus` | `(input) => Promise` | Define seu status de texto moderno; `text: null`/`''` o limpa. |
| `getUsernames` | `(jids) => Promise` | Consulta de username em lote. |
| `getOwnUsername` | `() => Promise` | Seu registro de username (valor, estado, pin de recuperação). |
| `setUsername` | `(input) => Promise` | Reserva um username. Retorna `true` apenas em `SUCCESS`; caso contrário `false` (em uso/inválido/rate-limited) sem lançar. |
| `deleteUsername` | `() => Promise` | Exclui seu username. |
| `checkUsernameAvailability` | `(username) => Promise` | Disponibilidade + sugestões. |
| `setUsernameKey` | `(pin) => Promise` | Define o PIN de recuperação do username. |
| `getAboutStatus` | `(jid) => Promise` | Texto "Sobre" via MEX. |
| `getLidsByPhoneNumbers` | `(phoneNumbers) => Promise` | Resolve [LIDs](/pt-br/concepts/identities#mapping-a-phone-number-to-its-lid) para números de telefone. |
***
status
`WaStatusCoordinator` — veja [Broadcasts de status](/pt-br/guides/presence-status#status-broadcasts).
| Method | Signature | Description |
| -------------- | --------------------------------------------------------------- | -------------------------------------------- |
| `send` | `(input: WaSendStatusInput) => Promise` | Publica um status para destinatários. |
| `revokeStatus` | `(input) => Promise` | Revoga um status publicado. |
| `setPrivacy` | `(input) => Promise` | Privacidade de status de toda a conta. |
| `setUserMuted` | `(jid, muted) => Promise` | Silencia/dessilencia o status de um contato. |
***
broadcastList
`WaBroadcastListCoordinator`.
| Method | Signature | Description |
| ------------ | ----------------------------------------------------------------------------- | ----------------------------------------------- |
| `setList` | `(input: WaSetBroadcastListInput) => Promise` | Cria/atualiza uma lista (nome + destinatários). |
| `removeList` | `(id) => Promise` | Exclui uma lista. |
| `send` | `(input: WaSendBroadcastListMessageInput) => Promise` | Envia para cada membro. |
Listas de transmissão são **business-only** (apoiadas pelo schema de app-state `BusinessBroadcastList`); contas comuns têm as mutations rejeitadas.
***
business
`WaBusinessCoordinator` — veja [Business](/pt-br/guides/profile-privacy#business).
| Method | Signature | Description |
| -------------------------------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `getBusinessProfile` | `(jids) => Promise` | Perfis de business em lote (sobre, endereço, horários). Funciona de qualquer conta. |
| `getVerifiedName` / `getVerifiedNames` | `(jid) / (jids) => Promise<…>` | Consulta de nome verificado (único / em lote). |
| `editBusinessProfile` | `(input) => Promise` | Edita seu perfil de business. **Business-only.** |
| `updateCoverPhoto` | `(media) => Promise<{ id }>` | Envia/vincula uma foto de capa. **Business-only.** |
| `deleteCoverPhoto` | `(id) => Promise` | Exclui a foto de capa. **Business-only.** |
***
bot
`WaBotCoordinator` — veja [Bots](/pt-br/guides/bots).
| Method | Signature | Description |
| ----------------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
| `listBots` | `() => Promise` | Bots disponíveis à conta, agrupados por seção. |
| `getBotProfile` | `(jid, options?) => Promise` | Perfil de um bot (comandos, prompts, criador). |
| `sendPrompt` | `(to, content, options?) => Promise` | Envia prompt a um bot — caminho direto (`to` é `@bot`) ou caminho de menção (grupo + `options.botJid`). |
| `tryDecryptChunk` | `(event) => Promise` | Descriptografa um chunk de resposta em streaming → `message_bot_chunk`. Chamado automaticamente por mensagem recebida. |
***
email
`WaEmailCoordinator`.
| Method | Signature | Description |
| ------------------------- | --------------------------------------------- | ------------------------------------------------- |
| `getStatus` | `() => Promise` | Vínculo atual (endereço + verificado/confirmado). |
| `setEmail` | `(email, context?) => Promise` | Vincula/revincula um endereço. |
| `requestVerificationCode` | `(input) => Promise` | Envia um código de verificação para o endereço. |
| `verifyCode` | `(code) => Promise` | Submete o código enviado por e-mail. |
| `confirm` | `(context?) => Promise` | Confirmação de propriedade pós-verificação. |
O vínculo de e-mail é **mobile-only** — todo método lança em uma conexão Web/companion. Veja [Conexões mobile](/pt-br/concepts/mobile).
***
mobile
`WaMobileCoordinator` — veja [Hospedando dispositivos companheiros](/pt-br/concepts/mobile#hosting-companion-devices). Requer uma sessão mobile-primary; métodos de link/revoke/publish lançam em uma conexão Web/companion.
| Method | Signature | Description |
| --------------------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `linkCompanion` | `(qr) => Promise` | Vincula um companion pela sua string de QR. Retorna `{ deviceJid, keyIndex }`. |
| `linkCompanionByCode` | `(pairingCode) => Promise` | Vincula um companion pelo código de pareamento de 8 caracteres (o companion precisa ter solicitado um código para esta conta antes). |
| `revokeCompanion` | `(deviceJid, reason?) => Promise` | Desvincula um companion hospedado e republica a key-index list. `reason` tem default `'user_initiated'`. |
| `revokeAllCompanions` | `(reason?, { excludeHostedCompanion? }?) => Promise` | "Log out all companion devices"; `excludeHostedCompanion` (opt-in) poupa os companions que esta conta hospeda. |
| `listCompanions` | `() => Promise` | Os companions que este primary vinculou no epoch atual. |
| `reconcileCompanions` | `() => Promise` | Reconcilia o conjunto rastreado contra o servidor (`usync`); roda automaticamente no connect e em `account_sync`. Retorna os device jids removidos. |
| `publishKeyIndexList` | `() => Promise` | Re-assina e republica a key-index list para o conjunto atual de dispositivos. |
***
lowlevel
`WaLowLevelCoordinator` — referência completa em [API de baixo nível](/pt-br/reference/low-level): `sendNode`, `query`, `registerIncomingHandler`, `unregisterIncomingHandler`, `registerIncomingStanzaFilter`.
***
Para helpers de topo exportados da raiz do pacote — inspeção de mensagem (`getContentType`), normalização de target (`resolveMessageTarget`), predicados de JID e constantes — veja [JIDs, helpers & constantes](/pt-br/reference/jid-helpers). Para business hours tipados, veja [Perfil, privacidade & business](/pt-br/guides/profile-privacy#typed-business-hours).