https://github.com/tulir/whatsmeow

Go library for the WhatsApp web multidevice API
https://github.com/tulir/whatsmeow

go golang whatsapp whatsapp-web

Last synced: about 2 months ago
JSON representation

Go library for the WhatsApp web multidevice API

• Host: GitHub
• URL: https://github.com/tulir/whatsmeow
• Owner: tulir
• License: mpl-2.0
• Created: 2021-10-06T18:48:01.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T16:28:44.000Z (4 months ago)
• Last Synced: 2024-05-22T17:44:10.257Z (4 months ago)
• Topics: go, golang, whatsapp, whatsapp-web
• Language: Go
• Homepage: https://go.mau.fi/whatsmeow
• Size: 4.09 MB
• Stars: 1,860
• Watchers: 74
• Forks: 350
• Open Issues: 63
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-golang-repositories - whatsmeow

README

        
# whatsmeow

[![Go Reference](https://pkg.go.dev/badge/go.mau.fi/whatsmeow.svg)](https://pkg.go.dev/go.mau.fi/whatsmeow)

whatsmeow is a Go library for the WhatsApp web multidevice API.

## Discussion

Matrix room: [#whatsmeow:maunium.net](https://matrix.to/#/#whatsmeow:maunium.net)

For questions about the WhatsApp protocol (like how to send a specific type of

message), you can also use the [WhatsApp protocol Q&A] section on GitHub

discussions.

[WhatsApp protocol Q&A]: https://github.com/tulir/whatsmeow/discussions/categories/whatsapp-protocol-q-a

## Usage

The [godoc](https://pkg.go.dev/go.mau.fi/whatsmeow) includes docs for all methods and event types.

There's also a [simple example](https://godocs.io/go.mau.fi/whatsmeow#example-package) at the top.

Also see [mdtest](./mdtest) for a CLI tool you can easily try out whatsmeow with.

## Features

Most core features are already present:

* Sending messages to private chats and groups (both text and media)

* Receiving all messages

* Managing groups and receiving group change events

* Joining via invite messages, using and creating invite links

* Sending and receiving typing notifications

* Sending and receiving delivery and read receipts

* Reading and writing app state (contact list, chat pin/mute status, etc)

* Sending and handling retry receipts if message decryption fails

* Sending status messages (experimental, may not work for large contact lists)

Things that are not yet implemented:

* Sending broadcast list messages (this is not supported on WhatsApp web either)

* Calls