whatsapp-rust

An async Rust library for WhatsApp Web. Pair a device, send and receive end-to-end encrypted messages, and build on a modular protocol stack.

Documentation · llms.txt · llms-full.txt

Capabilities

• QR and pairing-code authentication with persistent sessions.
• End-to-end encrypted direct and group messaging, media, reactions, receipts, and history sync.
• Groups, communities, newsletters, status, contacts, and privacy controls.
• Audio and video calls, both 1:1 and group, plus call links and screen sharing. The optional voip feature provides native relay transport and MLOW/Opus audio. Video takes application-supplied H.264 frames (media API and codec options).
• Replaceable storage, transport, HTTP client, and runtime. The default features include SQLite, Tokio WebSocket, ureq, and Tokio. Applications still choose a storage backend. Native plugins are opt-in.

Quick start

[dependencies]
whatsapp-rust = "0.7"
tokio = { version = "1", features = ["macros", "rt-multi-thread", "signal"] }

use whatsapp_rust::prelude::*;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let bot = Bot::builder()
        .with_backend(SqliteStore::open("whatsapp.db").await?)
        .on_qr_code(|code, _timeout| async move {
            println!("Scan to pair:\n{code}");
        })
        .on_message(|ctx| async move {
            if ctx.message.text_content() == Some("ping") {
                let _ = ctx.reply("pong").await;
            }
        })
        .build()
        .await?;

    bot.run().await;
    Ok(())
}

The main crate re-exports the bundled stack. You do not need to add its sibling crates separately. To use a specific Git revision instead of crates.io:

[dependencies]
whatsapp-rust = { git = "https://github.com/oxidezap/whatsapp-rust", rev = "<commit>" }

See the documentation for configuration, alternative backends, and API examples.

Related projects

• oxidezap/client: desktop and browser client built on this library as a complete application.
• whatsapp-rust-esp32: end-to-end-encrypted client on ESP32 microcontrollers, demonstrating the core on constrained hardware.
• whatsapp-rust-bridge: Rust/WebAssembly utilities for JavaScript, including protocol, Signal, and media operations.
• baileyrs: JavaScript library backed by Rust/WASM with a Baileys-compatible API.
• whatspec: extracts a language-neutral protocol specification from WhatsApp Web. Its IR supplies protocol definitions generated here.

Used by

Browse GitHub's indexed public dependents for the crates.io package and the repository entry. GitHub's lists are incomplete and exclude private repositories. A zero on the repository entry does not mean nobody uses the library via Git. The sidebar counter, when shown, covers only one package.

Disclaimer

This is an unofficial client, not affiliated with WhatsApp or Meta. Using it may violate Meta's Terms of Service and could result in account suspension.

Acknowledgements

Inspired by whatsmeow and Baileys.