Tipos de mensagem

Tudo o que você envia passa por client.message.send(to, content, options?). O argumento content é um WaSendMessageContent:

type WaSendMessageContent =
  | string                        // atalho para uma mensagem de texto
  | WaSendTextMessage             // type: 'text'
  | WaSendReactionMessage         // type: 'reaction'
  | WaSendRevokeMessage           // type: 'revoke'
  | WaSendPinMessage              // type: 'pin' | 'unpin'
  | WaSendKeepMessage             // type: 'keep' | 'unkeep'
  | WaSendPollMessage             // type: 'poll'
  | WaSendPollVoteMessage         // type: 'poll-vote'
  | WaSendEventMessage            // type: 'event'
  | WaSendEventResponseMessage    // type: 'event-response'
  | WaSendMediaMessage            // type: 'image' | 'video' | 'ptv' | 'audio' | 'document' | 'sticker' | 'sticker-pack'
  | Proto.IMessage                // protobuf bruto — qualquer coisa não coberta acima

Existem duas maneiras de enviar: um builder tipado (um objeto com um discriminador type — a biblioteca valida e preenche os campos de protocolo para você) ou um Proto.IMessage bruto (você mesmo monta o protobuf). O mesmo send() aceita ambos.

Atalho

Uma string simples é enviada como uma mensagem de texto:

await client.message.send(jid, 'Hello!')

Builders tipados

Cada builder é discriminado pelo seu campo type. Campos em negrito são obrigatórios.

Texto e mídia

`type`	Tipo	Campos obrigatórios	Guia
`text`	`WaSendTextMessage`	`text`	Enviando mensagens
`image`	`WaSendMediaMessage`	`media` (mimetype opcional com um processor `detectMimetype`)	Mídia
`video`	`WaSendMediaMessage`	`media` (mimetype opcional com um processor `detectMimetype`)	Mídia
`ptv`	`WaSendMediaMessage`	`media` (mimetype opcional com um processor `detectMimetype`)	Mídia
`audio`	`WaSendMediaMessage`	`media` (mimetype opcional com um processor `detectMimetype`)	Mídia
`document`	`WaSendMediaMessage`	`media` (mimetype opcional com um processor `detectMimetype`)	Mídia
`sticker`	`WaSendMediaMessage`	`media` (mimetype padrão é `image/webp`)	Mídia
`sticker-pack`	`WaSendStickerPackMessage`	`stickerPackId`, `name`, `publisher`, `stickers`, `trayIcon`	Mídia

Os builders de mídia também aceitam qualquer campo não-gerenciado da mensagem protobuf subjacente (por exemplo caption, gifPlayback, ptt, fileName) via o mapeamento UserMediaFields. Campos gerenciados pelo protocolo (url, mediaKey, fileSha256, directPath, …) são preenchidos pelo builder. mimetype é opcional. A ordem de resolução é: um mimetype explícito que você passa vence; senão o builder chama media.processor.detectMimetype (fornecido por @zapo-js/media-utils quando file-type está instalado); senão lança erro para image/video/audio/document/ptv. Stickers usam image/webp por padrão.

Interativos

`type`	Tipo	Campos obrigatórios	Guia
`reaction`	`WaSendReactionMessage`	`emoji`, `target`	Reações
`poll`	`WaSendPollMessage`	`name`, `options`	Enquetes
`poll-vote`	`WaSendPollVoteMessage`	`poll`, `selectedOptionNames`	Votação
`event`	`WaSendEventMessage`	`name`, `startTime`	Eventos
`event-response`	`WaSendEventResponseMessage`	`event`, `response`	Resposta a evento
`pin` / `unpin`	`WaSendPinMessage`	`target` (+ `durationSecs` opcional)	Fixar
`keep` / `unkeep`	`WaSendKeepMessage`	`target`	Manter no chat
`revoke`	`WaSendRevokeMessage`	`target`	Revogar

target é um WaMessageTargetInput — uma WaMessageKey ({ remoteJid, id, fromMe, participant? }) ou um evento message recebido passado literalmente (sua key é usada). Os pais de poll/event exigem adicionalmente authorJid e o messageSecret de 32 bytes. Para revoke, sender vs admin é auto-detectado por target.fromMe (false dispara um admin revoke). Não há opção subtype.

`Proto.IMessage` bruto

Para qualquer coisa sem um builder tipado, passe uma mensagem protobuf bruta. A biblioteca inspeciona o campo preenchido e resolve automaticamente os atributos da stanza — type da mensagem ([resolveMessageTypeAttr]), type de mídia, polltype, event_type, view_once e edit — então você só define o campo de conteúdo.

import { proto } from 'zapo-js'

await client.message.send(jid, {
  conversation: 'A raw text message'
})

Texto

Campo	Notas
`conversation`	Texto simples.
`extendedTextMessage`	Texto com contexto (links, menções, respostas). Um `matchedText` não-vazio o torna uma mensagem de link/mídia.

Mídia

Campo	Tipo de mídia resolvido
`imageMessage`	`image`
`videoMessage`	`video` (ou `gif` quando `gifPlayback`)
`ptvMessage`	`ptv`
`audioMessage`	`audio` (ou `ptt` quando `ptt`)
`documentMessage` / `documentWithCaptionMessage`	`document`
`stickerMessage`	`sticker`
`stickerPackMessage`	`sticker-pack`

Campos de mídia brutos exigem mídia previamente enviada (as chaves de criptografia, o directPath e os digests já devem estar definidos). Para enviar a partir de bytes/um arquivo, use os builders de mídia tipados em vez disso — eles realizam o upload para você.

Localização e contatos

// Localização estática
await client.message.send(jid, {
  locationMessage: { degreesLatitude: -23.55, degreesLongitude: -46.63, name: 'HQ' }
})

// Localização ao vivo (resolvida como `live-location`)
await client.message.send(jid, {
  liveLocationMessage: { degreesLatitude: -23.55, degreesLongitude: -46.63 }
})

// Contato único (vCard)
await client.message.send(jid, {
  contactMessage: { displayName: 'Maria', vcard: 'BEGIN:VCARD\n...\nEND:VCARD' }
})

// Múltiplos contatos
await client.message.send(jid, {
  contactsArrayMessage: { displayName: 'Team', contacts: [/* IContactMessage[] */] }
})

Campo	Tipo de mídia resolvido
`locationMessage`	`location` (ou `live-location` quando `isLive`)
`liveLocationMessage`	`live-location`
`contactMessage`	`vcard`
`contactsArrayMessage`	`contact_array`

Interativos e business

Campo	Tipo resolvido
`buttonsMessage`	`button`
`buttonsResponseMessage`	`button_response`
`listMessage`	`list`
`listResponseMessage`	`list_response`
`interactiveMessage` (native flow)	interactive
`interactiveResponseMessage`	`native_flow_response`
`templateButtonReplyMessage`	text
`orderMessage`	`order`
`productMessage`	`product`
`groupInviteMessage`	`url`

await client.message.send(jid, {
  groupInviteMessage: {
    groupJid, inviteCode, inviteExpiration, groupName
  }
})

Enquetes e eventos (bruto)

Campo	Resolvido
`pollCreationMessage` / `…V2` / `…V3` / `…V5`	`poll` (`polltype: creation`)
`pollUpdateMessage`	`poll` (`polltype: vote`)
`pollResultSnapshotMessage`	text
`eventMessage`	`event` (`event_type: creation`)
`encEventResponseMessage`	`event` (`event_type: response`)

Mensagens de criação de enquete e de evento auto-persistem seu messageSecret para que votos/respostas posteriores possam ser criptografados.

Protocolo, edições e sistema

Campo	Notas
`protocolMessage`	Revogações (`REVOKE`), edições (`MESSAGE_EDIT`), sincronização ephemeral, requisições de welcome.
`editedMessage`	Wrapper de mensagem editada (atributo `edit`).
`reactionMessage` / `encReactionMessage`	Reação (`type: reaction`); `text` vazio revoga.
`pinInChatMessage`	Fixar/desafixar (`edit: pin_in_chat`).
`keepInChatMessage`	Manter no chat.
`encCommentMessage`	Comentário em uma mensagem.
`requestPhoneNumberMessage`	Solicitar um número de telefone.
`newsletterAdminInviteMessage`	Convite de admin de newsletter.
`secretEncryptedMessage`	Carrega `secretEncType`: `EVENT_EDIT`, `POLL_EDIT`, `POLL_ADD_OPTION`, `MESSAGE_EDIT`, `MESSAGE_SCHEDULE`.
`messageHistoryNotice` / `messageHistoryBundle`	Compartilhamento de histórico de grupo.

Wrappers

Estes envolvem uma mensagem interna; a biblioteca os desembrulha ao resolver os atributos: ephemeralMessage, viewOnceMessage, viewOnceMessageV2, deviceSentMessage, groupMentionedMessage, botInvokeMessage, documentWithCaptionMessage. Para visualização única especificamente, prefira a opção de envio viewOnce em vez de embrulhar manualmente.

A superfície protobuf completa está disponível sob o namespace proto exportado — proto.Message, proto.Message.ProtocolMessage.Type, etc. Use-o para construir qualquer campo acima e para referenciar valores de enum.

Cookbook de proto bruto

Payloads concretos de client.message.send(jid, …) para cada tipo bruto vivem no guia de envios proto brutos. Esta referência traz apenas as tabelas de mapeamento de tipos acima; o guia tem os exemplos de envio mais os cards de pagamento (PIX / review-and-pay).

Wrapper de mensagem temporária (ephemeralMessage)

Envolva qualquer mensagem para que ela herde o timer ephemeral do chat. Isto é uma mecânica de wrapper — a mensagem interna é o que efetivamente renderiza:

await client.message.send(jid, {
  ephemeralMessage: { message: { conversation: 'This disappears' } }
})

Para o toggle ephemeral do chat inteiro (protocolMessage + EPHEMERAL_SETTING), veja a seção Alternar mensagens temporárias no guia.

Primeiros passos

Conceitos

Guias

Plugins

Referência

Avançado

Engenharia reversa

Tipos de mensagem

Atalho

Builders tipados

Texto e mídia

Interativos

`Proto.IMessage` bruto

Texto

Mídia

Localização e contatos

Interativos e business

Enquetes e eventos (bruto)

Protocolo, edições e sistema

Wrappers

Cookbook de proto bruto

Wrapper de mensagem temporária (ephemeralMessage)

​Atalho

​Builders tipados

​Texto e mídia

​Interativos

​Proto.IMessage bruto

​Texto

​Mídia

​Localização e contatos

​Interativos e business

​Enquetes e eventos (bruto)

​Protocolo, edições e sistema

​Wrappers

​Cookbook de proto bruto

​Wrapper de mensagem temporária (ephemeralMessage)

Atalho

Builders tipados

Texto e mídia

Interativos

`Proto.IMessage` bruto

Texto

Mídia

Localização e contatos

Interativos e business

Enquetes e eventos (bruto)

Protocolo, edições e sistema

Wrappers

Cookbook de proto bruto

Wrapper de mensagem temporária (ephemeralMessage)