Skip to content

Home
Guide
Handling Response
Changelog

Sidebar Navigation

Introduction

About WAHA
Getting Started
Handling Response
Changelog

API

🖥️ Sessions
- List Sessions
  Get Session
  Create Session
  Update Session
  Delete Session
  Start Session
  Stop Session
  Restart Session
  Logout Session
  Get Screenshot
  Get Me
📤 Send Messages
- 💬 Basic Messages
  - Send Text
    Send Location
    Send Link Preview
    Send Link Custom Preview
  📂 Media Messages
  - Send Image
    Send File
    Send Voice
    Send Video
  🔘 Interactive Messages
  - Send Poll
    Send Poll Vote
    Send List
    Send Buttons Reply
  ⚙️ Message Actions
  - Forward Message
    Send Reaction
    Star Message
    Send Seen
  🔍 Retrieval & Utils
  - Send Contact Vcard
  ⌨️ Presence
  - Start Typing
    Stop Typing
🎥 Media
- Convert Voice
  Convert Video
🆔 Profile
- Get Profile
  Set Profile Name
  Set Profile Status
  Set Profile Picture
  Delete Profile Picture
💬 Chats
- Get All Chats ⚠️
  Get Chats Overview ⚠️
  Get Chat Picture ⚠️
  Mark Chat Unread ⚠️
  Archive Chat ⚠️
  Unarchive Chat ⚠️
  Delete Chat ⚠️
  Read Messages ⚠️
  Get Messages ⚠️
  Get Message By ID ⚠️
  Pin Message ⚠️
  Unpin Message ⚠️
  Edit Message ⚠️
  Delete Message ⚠️
  Delete All Messages ⚠️
👤 Contacts
- c.us
  - All Contacts
    Get Contact
    Update Contact
    Check Exists
    Get About
    Profile Picture
    Block Contact
    Unblock Contact
  LIDs
  - Known LIDs
    Count of LIDs
    Phone Number by LID
    LID by Phone Number
📢 Channels
- Channels API
  - Preview Channel Messages ⚠️
    Create Channel ⚠️
    Get Channel ⚠️
    List Channels ⚠️
    Delete Channel ⚠️
    Get Messages ⚠️
  Search API
  - Search by View ⚠️
    Search by Text ⚠️
    Views for Search ⚠️
    Countries for Search ⚠️
    Categories for Search ⚠️
🟢 Status
- Send Text Status
  Send Image Status
👥 Groups
- Create Group ⚠️
  List Groups ⚠️
  Count Groups ⚠️
  Get Join Info ⚠️
  Join Group ⚠️
  Get Group ⚠️
  Delete Group ⚠️
  Leave Group ⚠️
  Get Group Picture ⚠️
  Update Group Picture ⚠️
  Delete Group Picture ⚠️
  Update Group Description ⚠️
  Update Group Subject ⚠️
  Get Invite Code ⚠️
  Revoke Invite Code ⚠️
  Get Info Admin Only ⚠️
  Set Info Admin Only ⚠️
  Get Messages Admin Only ⚠️
  Set Messages Admin Only ⚠️
  Get Participants ⚠️
  Add Participant ⚠️
  Remove Participant ⚠️
  Promote Participant ⚠️
  Demote Participant ⚠️
✅ Presence
- Get All Presence
  Set Presence
  Subscribe to Presence
🏷️ Labels
- Get All Labels ⚠️
  Create Label ⚠️
  Update Label ⚠️
  Delete Label ⚠️
  Get Chats by Label ⚠️
  Get Labels by Chat ⚠️
  Put Labels to Chat ⚠️
📅 Event Message
- Send Event Message ⚠️
📞 Calls
- Configure Calls ⚠️
🧩 Apps
- List Apps
  Create App
  Update App
  Delete App
🔭 Observability
- Ping
  Get Server Version
  Get Server Environment
  Get Server Status
  Restart Server
  Health Check
  Node Heapsnapshot
  Node CPU Profiling
  Browser Trace

Webhook Events

🖥️ Sessions
- Session Status ⚠️
  Message ⚠️
  Message Any ⚠️
  Message Ack ⚠️
  Message Revoked ⚠️
  Message Reaction ⚠️
  QR Code ⚠️
  Engine Event ⚠️
📥 Receive Messages
- Overview ⚠️
  Message ⚠️
  Message Any ⚠️
  Message Ack ⚠️
  Message Revoked ⚠️
  Message Reaction ⚠️
  Message Waiting ⚠️
  Media ⚠️
  Polls ⚠️
📶 Polls
- Poll Vote ⚠️
  Poll Vote Failed ⚠️
💬 Chats
- Chat Archive ⚠️
👥 Groups
- Group Join (v2) ⚠️
  Group Leave (v2) ⚠️
  Group Participants (v2) ⚠️
  Group Update (v2) ⚠️
✅ Presence
- Presence Update ⚠️
🏷️ Labels
- Label Upsert ⚠️
  Label Deleted ⚠️
  Label Chat Added ⚠️
  Label Chat Deleted ⚠️
📅 Event Message
- Event Response ⚠️
  Event Response Failed ⚠️
📞 Calls
- Call Accepted ⚠️
  Call Rejected ⚠️

References

DTOs
- App Data
  Chat Data
  Chat Request Data
  Contact Data
  Contact Update Data
  Health Check Data
  Health Indicator Data
  Image Status Data
  Lid Data
  Link Preview Data
  Media Convert Data
  Message Button Reply Data
  Message Contact Vcard Data
  Message File Data
  Message Forward Data
  Message Image Data
  Message Link Custom Preview Data
  Message List Data
  Message List Row Data
  Message List Section Data
  Message Location Data
  Message Poll Data
  Message Poll Vote Data
  Message Reaction Data
  Message Star Data
  Message Text Data
  Message Update Data
  Message Video Data
  Message Voice Data
  Phone Number Data
  Ping Response Data
  Poll Data
  Presence Data
  Profile Data
  Screenshot Data
  Seen Data
  Server Status Data
  Server Version Data
  Session Config Client Data
  Session Config Data
  Session Config GOWS Data
  Session Config Ignore Data
  Session Config NOWEB Data
  Session Config WEBJS Data
  Session Create Data
  Session Data
  Session Engine Data
  Session Me Data
  Session Proxy Data
  Session Update Data
  Session Webhook Custom Header Data
  Session Webhook Data
  Session Webhook HMAC Data
  Session Webhook Retry Data
  Text Status Data
  Vcard Contact Data
Enums
- Session Status
  Presence
  Engine
  Version
  App Type

On this page

Views for Search

List all views available for search.

DANGER

This feature is not implemented yet, please submit a PR.

Engines

WEBJS	WPP	NOWEB	GOWS
➕	➕	➕	➕

References

WAHA Channels Documentation

Pager

Previous pageSearch by Text ⚠️

Next pageCountries for Search ⚠️

Released under the MIT License.

Copyright © 2025-present Things Telemetry