🖥️ Sessions

Overview

Session represents a WhatsApp Account (Phone Number) connected to WAHA that you can use to send and receive messages.

Session Lifecycle

Before you can 📤 Send or 📥 Receive messages , you need to Create a session (optionally, Start) and authenticate it using QR code or pairing code.

Here’s Session Lifecycle State Diagram:

Click to open full size.

Session Status

Here’s the list of possible session.status values:

STOPPED - session is stopped
STARTING - session is starting
SCAN_QR_CODE - session is required to scan QR code or login via phone number.
- The SCAN_QR_CODE is issued every time when QR updated (WhatsApp requirements)
- Every time you receive the session.status event with SCAN_QR_CODE status, you need to fetch updated QR ->, because it’s changed.
WORKING - session is working and ready to use
FAILED - session is failed due to some error. It’s likely either authorization is required again or device has been disconnected from that account. Try to Restart the session and if it doesn’t help - Logout and **Start ** the session again.

Features

Here’s the list of features that are available by 🏭 Engines:

	WEBJS	NOWEB	GOWS
List sessions `GET /api/sessions/`	✔️	✔️	✔️
Get session `GET /api/sessions/{name}`	✔️	✔️	✔️
Create session `POST /api/sessions/`	✔️	✔️	✔️
Update session `POST /api/sessions/{name}/`	✔️	✔️	✔️
Delete session `DELETE /api/sessions/{name}/`	✔️	✔️	✔️
Start session `POST /api/sessions/{name}/start`	✔️	✔️	✔️
Stop session `POST /api/sessions/{name}/stop`	✔️	✔️	✔️
Restart session `POST /api/sessions/{name}/restart`	✔️	✔️	✔️
Logout from a session `POST /api/sessions/logout`	✔️	✔️	✔️
Get screenshot `GET /api/screenshot`	✔️	➖	➖
Get me `GET /api/sessions/{session}/me`	✔️	✔️	✔️
Get QR `POST /api/{session}/auth/qr`	✔️	✔️	✔️
Request code `POST /api/{session}/auth/request-code`	✔️	✔️	✔️

If you see the feature is not available in the above list, please create a feature request or leave “+1” comment on the existing one.

Create Session

In order to create (and start) a new session - with Session Config.

POST /api/sessions

{
  // "name" is Optional - it'll be generated automatically
  "name": "default",
  "config": {
    // Read about Session Config below
      ...
  }
}

{
  "name": "session_123123123",
  // if name is not provided - it'll be generated automatically
  "status": "STARTING",
  "engine": {
    "engine": "WEBJS"
  },
  "config": {
    ...
  },
  "me": null
}

WAHA uses session name more like “id”, but we call it name for historical and compatibility reasons.

Postpone start

By default, the session starts right after creation. You can create a session and postpone its start by setting start field to false. It’ll create a session in STOPPED status, and you can start it later by calling POST /api/sessions/{session}/start.

{
  "name": "default",
  "start": false
}

Session Config

Full possible config for a session:

{
  "name": "default",
  "config": {
    "debug": true,
    // Only for NOWEB engine
    "noweb": {
      "store": {
        "enabled": true,
        "fullSync": false
      }
    },
    // Use "metadata" to save additional information.
    "metadata": {
      "user.id": "123",
      "user.email": "email@example.com"
    },
    "webhooks": [
      {
        "url": "https://webhook.site/11111111-1111-1111-1111-11111111",
        "events": [
          "message"
        ],
        // Optional
        "hmac": {
          "key": "your-secret-key"
        },
        // Optional
        "customHeaders": [
          {
            "name": "X-My-Custom-Header",
            "value": "Value"
          }
        ],
        // Optional
        "retries": {
          "delaySeconds": 2,
          "attempts": 15
        }
      }
    ],
    // Optional
    "proxy": {
      "server": "localhost:3128",
      // Optional - username, password
      "username": "username",
      "password": "P@ssw0rd"
    }
  }
}

NOWEB

NOWEB 🏭 Engine has a specific store that allows you to save session data.

You need to add config.noweb field to activate the store:

{
  "name": "default",
  "config": {
    "noweb": {
      "store": {
        "enabled": true,
        "fullSync": false
      }
    }
  }
}

Metadata

metadata is an attribute on Session objects that lets you store more information, structured as key-value pairs, to sessions for your own use and reference. For example, you can store your user’s unique identifier from your system.

Associated metadata field is available in:

List Sessions and Get Session responses
🔄 Webhooks events
📊 Dashboard for view, and search sessions by metadata

{
  "name": "default",
  "config": {
    "metadata": {
      "user.id": "123",
      "user.email": "email@example.com"
    }
  }
}

Sample metadata use cases:

Link IDs: Attach your system’s unique IDs to a Session object to simplify lookups. For example, add your user or tenant id.
Customer details: Annotate a customer by storing an internal information (email, customer name) for your future use, so you don’t have to look into two systems.

WAHA does not use metadata for any internal purposes, it’s up to you how to use it.

Webhooks

You can configure webhooks for a session:

{
  "name": "default",
  "config": {
    "webhooks": [
      {
        "url": "https://webhook.site/11111111-1111-1111-1111-11111111",
        "events": [
          "message"
        ]
      }
    ]
  }
}

Full possible webhook config:

{
  "name": "default",
  "config": {
    "webhooks": [
      {
        "url": "https://webhook.site/11111111-1111-1111-1111-11111111",
        "events": [
          "message"
        ],
        // Optional
        "hmac": {
          "key": "your-secret-key"
        },
        // Optional
        "customHeaders": [
          {
            "name": "X-My-Custom-Header",
            "value": "Value"
          }
        ],
        // Optional
        "retries": {
          "delaySeconds": 2,
          "attempts": 15
        }
      }
    ],
  }
}

👉 Read more about available options on 🔄 Webhooks page.

Proxy

You can configure proxy for a session by setting config.proxy fields when you create or update a session.

server - proxy server address, without http:// or https:// prefixes
username and password - set this if the proxy requires authentication

No authentication

{
  "name": "default",
  "config": {
    "proxy": {
      "server": "localhost:3128"
    }
  }
}

Proxy with authentication

{
  "name": "default",
  "config": {
    "proxy": {
      "server": "localhost:3128",
      "username": "username",
      "password": "P@ssw0rd"
    }
  }
}

You can configure proxy when for all sessions by set up environment variables. Read more about it on Proxy page -> or Configuration page ->.

👉 Read more about NOWEB Store Configuration.

Debug

You can enable debug mode for a session by setting config.debug field to true. It’ll show you more logs in the console. Can be useful for debugging purposes when you’re experiencing some issues.

{
  "name": "default",
  "config": {
    "debug": true
  }
}

Update Session

In order to update a session - call PUT /api/sessions/{session} with a full new configuration (see the possible config in Session Config section)

{
  "name": "default",
  "config": {
    "webhooks": [
      {
        "url": "https://webhook.site/11111111-1111-1111-1111-11111111",
        "events": [
          "message"
        ]
      }
    ]
  }
}

⚠️ If the session not in STOPPED status, it’ll be stopped and started with a new configuration.

Start Session

In order to start a session - call

POST /api/sessions/{session}/start

🎯 Idempotent operation - you can call it multiple times, and it’ll start the session only if it’s not running.

Stop Session

In order to stop a session - call

POST /api/sessions/{session}/stop

ℹ️ Stop doesn’t Log out or Delete anything

🎯 Idempotent operation - you can call it multiple times, and it’ll stop the session only if it’s running.

Restart Session

In order to start a session - call

POST /api/sessions/{session}/restart

⚠️ If the session is already running (status is not STOPPED), it’ll be stopped and started.

Logout Session

In order to log out the session - call

POST /api/sessions/{session}/logout

⚠️ If the session is running (not in STOPPED status), it’ll be logged out and started from scratch.

👉 If the session in WORKING status it’ll also remove associated device from Connected Devices list in the app.

ℹ️ Log out removes session information (authentication info and data), but keeps the session’s configuration, so you can start a new session with the same configuration.

Delete Session

In order to delete a session - call

DELETE /api/sessions/{session}

⚠️ Delete also logs out the session (removes both session configuration and data).

⚠️ Delete also stops the session if it’s running (session status is not STOPPED)

🎯 Idempotent operation - you can call it multiple times, and it’ll stop the session only if it exists.

List Sessions

To get session list - call

GET /api/sessions

[
  {
    "name": "default",
    "status": "WORKING",
    "config": {
      "proxy": null,
      "webhooks": [
        {
          "url": "https://webhook.site/11111111-1111-1111-1111-11111111",
          "events": [
            "message",
            "session.status"
          ],
          "hmac": null,
          "retries": null,
          "customHeaders": null
        }
      ],
      "debug": false
    },
    "me": {
      "id": "79111111@c.us",
      "pushName": "WAHA"
    },
    "engine": {
      "engine": "NOWEB"
    }
  }
]

You can add ?all=true parameter to the request it’ll show you ALL session, including STOPPED.

GET /api/sessions?all=true

Get Session

To get information about a specific session - call

GET /api/sessions/{session}

{
  "name": "default",
  "status": "WORKING",
  "config": {
    "proxy": null,
    "webhooks": [
      {
        "url": "https://webhook.site/11111111-1111-1111-1111-11111111",
        "events": [
          "message",
          "session.status"
        ],
        "hmac": null,
        "retries": null,
        "customHeaders": null
      }
    ],
    "debug": false
  },
  "me": {
    "id": "79111111@c.us",
    "pushName": "WAHA"
  },
  "engine": {
    "engine": "NOWEB"
  }
}

Get screenshot

Get screenshot of the session’s screen.

Binary

GET /api/screenshot?session=default

Base64

You can get screenshot in base64 format by adding Accept: application/json header to the request.

GET /api/screenshot?session=default

Accept: application/json

{
  "mimetype": "image/png",
  "data": "base64-encoded-data"
}

You can change it in Swagger by clicking on Media Type dropdown and selecting application/json:

Click to open full size.

Get me

ℹ️ You’ll get the same info if you request GET /api/sessions/{session} in me field.

Get information about the associated account for that session (if any).

GET /api/sessions/{session}/me

Authenticated and working session’s response:

{
  "id": "11111111111@c.us",
  "pushName": "string"
}

Stopped or not authenticated session returns null:

null

Get QR

The simplest way to authenticate a new session - get QR code and scan it on your device.

GET /api/{session}/auth/qr

You’ll get QR image that you can scan and get authenticated

You can get QR in different formats:

binary image - GET /api/{session}/auth/qr
base64 image - GET /api/{session}/auth/qr and set Accept: application/json header
raw - GET /api/{session}/auth/qr?format=raw

Binary

Binary image - default format, you’ll get image in response

# Get image - binary
GET /api/{session}/auth/qr

# OR
GET /api/{session}/auth/qr?format=image

# OR specify Accept header as well
GET /api/{session}/auth/qr?format=image
Accept: image/png

Base64

Base64 image - you’ll get image in base64 format in response if you set Accept: application/json header.

GET /api/{session}/auth/qr?format=image

Accept: application/json

{
  "mimetype": "image/png",
  "data": "base64-encoded-data"
}

You can change it in Swagger by clicking on Media Type dropdown and selecting application/json:

Click to open full size.

Raw

Raw - you’ll get raw data in response, you can use it to generate QR code on your side with the value.

GET /api/{session}/auth/qr?format=raw

{
  "value": "value-that-you-need-to-use-to-generate-qr-code"
}

Get pairing code

See the list of engines that support the features ->.

You can link a session with phone number - make a request to the endpoint.

POST /api/{session}/auth/request-code

Body example:

{
  "phoneNumber": "12132132130"
}

You’ll get code in the need to enter in WhatsApp app to authenticate the session:

{
  "code": "ABCD-ABCD"
}

👉 Always add to QR code auth flow in your application as a fallback, because the pairing code is not always available and works as expected.

Webhooks

See the list of engines that support the feature ->.

session.status

The session.status event is triggered when the session status changes.

{
  "event": "session.status",
  "session": "default",
  "me": {
    "id": "7911111@c.us",
    "pushName": "~"
  },
  "payload": {
    "status": "WORKING"
  },
  "engine": "WEBJS",
  "environment": {
    "version": "2023.10.12",
    "engine": "WEBJS",
    "tier": "PLUS"
  }
}

Advanced sessions

With WAHA Plus version you can save session state to avoid scanning QR code everytime, configure autostart options so when the docker container restarts - it restores all previously run sessions!

Session persistent

If you want to save your session and do not scan QR code everytime when you launch WAHA - connect the session storage to the container ->

Autostart

By default, WAHA track which session have been run on which worker and restart it when worker got restarted. If you want to disable it - set WAHA_WORKER_RESTART_SESSIONS=False in environment variable.

Multiple sessions

If you want to save server’s CPU and Memory - run multiple sessions inside one docker container! Plus version supports multiple sessions in one container.

DEPRECATED

Before new granular API we have a simple API to control the session.

Kindly switch to new API that allows you to control the session in a more flexible way.

Start

The endpoint Create (if not exists), Update (if existed before) and Start a new session.

POST /api/sessions/start

Accepts the same configuration as Create and Update API.

{
  "name": "default",
  "config": {
    "webhooks": [
      {
        "url": "https://webhook.site/11111111-1111-1111-1111-11111111",
        "events": [
          "message"
        ]
      }
    ]
  }
}

Stop

POST /api/sessions/stop

Stop if logout: false
Stop, Logout and Delete session if logout: true

{
  "name": "default",
  "logout": true
}

Logout

Logout and Delete session.

POST /api/sessions/logout

{
  "name": "default"
}

Edit this page on GitHub

📥 Receive messages

🆔 Profile

🖥️ Sessions

Overview#

Session Lifecycle#

Session Status#

Features#

Create Session#

Postpone start#

Session Config#

NOWEB#

Metadata#

Webhooks#

Proxy#

Debug#

Update Session#

Start Session#

Stop Session#

Restart Session#

Logout Session#

Delete Session#

List Sessions#

Get Session#

Get screenshot#

Binary#

Base64#

Get me#

Get QR#

Binary#

Base64#

Raw#

Get pairing code#

Webhooks#

session.status#

Advanced sessions#

Session persistent#

Autostart#

Multiple sessions#

DEPRECATED#

Start#

Stop#

Logout#

Overview

Session Lifecycle

Session Status

Features

Create Session

Postpone start

Session Config

NOWEB

Metadata

Webhooks

Proxy

Debug

Update Session

Start Session

Stop Session

Restart Session

Logout Session

Delete Session

List Sessions

Get Session

Get screenshot

Binary

Base64

Get me

Get QR

Binary

Base64

Raw

Get pairing code

Webhooks

session.status

Advanced sessions

Session persistent

Autostart

Multiple sessions

DEPRECATED

Start

Stop

Logout