open-wa v5 is alpha. Use v4.76.0 for mature production systems unless you are validating v5.
The Client APIAPI ExplorerLicensing

Session Client API

Generated client method reference for the session namespace.

Client Session Methods Wally

Session Client API

Generated file warning: this page is generated by packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.

This page documents 16 schema-registry client methods in the session namespace.

getBatteryLevel

Get phone battery level

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
Aliasessession.getBatteryLevel
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getBatteryLevelgetBatteryLevelActive
AliasGET/api/getBatteryLevelgetBatteryLevelActive

Usage

const result = await client.getBatteryLevel({});
const result = await client.session.getBatteryLevel({});
curl -X GET "http://localhost:8080/api/session/getBatteryLevel" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typenumber

getConnectionState

Get connection state

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
Aliasessession.getConnectionState
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getConnectionStategetConnectionStateActive
AliasGET/api/getConnectionStategetConnectionStateActive

Usage

const result = await client.getConnectionState({});
const result = await client.session.getConnectionState({});
curl -X GET "http://localhost:8080/api/session/getConnectionState" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typeunknown

getFeatures

Get enabled features

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
Aliasessession.getFeatures
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getFeaturesgetFeaturesActive
AliasGET/api/getFeaturesgetFeaturesActive

Usage

const result = await client.getFeatures({});
const result = await client.session.getFeatures({});
curl -X GET "http://localhost:8080/api/session/getFeatures" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typeunknown

getHostNumber

Get host phone number

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
Aliasessession.getHostNumber
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getHostNumbergetHostNumberActive
AliasGET/api/getHostNumbergetHostNumberActive

Usage

const result = await client.getHostNumber({});
const result = await client.session.getHostNumber({});
curl -X GET "http://localhost:8080/api/session/getHostNumber" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typestring

getLicenseType

Get license type

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
Aliasessession.getLicenseType
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getLicenseTypegetLicenseTypeActive
AliasGET/api/getLicenseTypegetLicenseTypeActive

Usage

const result = await client.getLicenseType({});
const result = await client.session.getLicenseType({});
curl -X GET "http://localhost:8080/api/session/getLicenseType" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typeunknown | boolean

getLoadedMessageCount

Get loaded message count

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
AliasesgetAmountOfLoadedMessages, session.getAmountOfLoadedMessages, session.getLoadedMessageCount
Deprecated aliasesgetAmountOfLoadedMessages, session.getAmountOfLoadedMessages
Licensenone
WAPI overridegetAmountOfLoadedMessages
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getLoadedMessageCountgetLoadedMessageCountActive
Deprecated aliasGET/api/getAmountOfLoadedMessagesgetAmountOfLoadedMessagesDeprecated
AliasGET/api/getLoadedMessageCountgetLoadedMessageCountActive
Deprecated aliasGET/api/session/getAmountOfLoadedMessagessession.getAmountOfLoadedMessagesDeprecated

Usage

const result = await client.getLoadedMessageCount({});
const result = await client.session.getLoadedMessageCount({});
curl -X GET "http://localhost:8080/api/session/getLoadedMessageCount" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typenumber

getMe

Get host account info

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
Aliasessession.getMe
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getMegetMeActive
AliasGET/api/getMegetMeActive

Usage

const result = await client.getMe({});
const result = await client.session.getMe({});
curl -X GET "http://localhost:8080/api/session/getMe" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typeunknown

getProcessStats

Get process statistics

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
Aliasessession.getProcessStats
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getProcessStatsgetProcessStatsActive
AliasGET/api/getProcessStatsgetProcessStatsActive

Usage

const result = await client.getProcessStats({});
const result = await client.session.getProcessStats({});
curl -X GET "http://localhost:8080/api/session/getProcessStats" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typeunknown

getSnapshot

Take screenshot

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter orderchatId, width, height
Aliasessession.getSnapshot, session.takeScreenshot, takeScreenshot
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getSnapshotgetSnapshotActive
AliasGET/api/getSnapshotgetSnapshotActive
AliasGET/api/session/takeScreenshotsession.takeScreenshotActive
AliasGET/api/takeScreenshottakeScreenshotActive

Usage

const result = await client.getSnapshot({
  chatId: "447123456789@c.us",
  width: 1,
  height: 1,
});
const result = await client.session.getSnapshot({
  chatId: "447123456789@c.us",
  width: 1,
  height: 1,
});
curl -G "http://localhost:8080/api/session/getSnapshot" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "chatId=447123456789@c.us" \
  --data-urlencode "width=1" \
  --data-urlencode "height=1"

Parameters

Prop

Type

Output

PropValue
Return typestring

getUserAgent

Get user agent

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter orderuserAgent
AliasesgetGeneratedUserAgent, session.getGeneratedUserAgent, session.getUserAgent
Deprecated aliasesgetGeneratedUserAgent, session.getGeneratedUserAgent
Licensenone
WAPI overridegetGeneratedUserAgent
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getUserAgentgetUserAgentActive
Deprecated aliasGET/api/getGeneratedUserAgentgetGeneratedUserAgentDeprecated
AliasGET/api/getUserAgentgetUserAgentActive
Deprecated aliasGET/api/session/getGeneratedUserAgentsession.getGeneratedUserAgentDeprecated

Usage

const result = await client.getUserAgent({
  userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
});
const result = await client.session.getUserAgent({
  userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
});
curl -G "http://localhost:8080/api/session/getUserAgent" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "userAgent=Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"

Parameters

Prop

Type

Output

PropValue
Return typestring

getWAVersion

Get WhatsApp Web version

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
AliasesgetWhatsAppVersion, session.getWAVersion, session.getWhatsAppVersion
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/getWAVersiongetWAVersionActive
AliasGET/api/getWAVersiongetWAVersionActive
AliasGET/api/getWhatsAppVersiongetWhatsAppVersionActive
AliasGET/api/session/getWhatsAppVersionsession.getWhatsAppVersionActive

Usage

const result = await client.getWAVersion({});
const result = await client.session.getWAVersion({});
curl -X GET "http://localhost:8080/api/session/getWAVersion" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typestring

healthCheck

Health check

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
Aliasessession.healthCheck
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/healthCheckhealthCheckActive
AliasGET/api/healthCheckhealthCheckActive

Usage

const result = await client.healthCheck({});
const result = await client.session.healthCheck({});
curl -X GET "http://localhost:8080/api/session/healthCheck" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typeunknown

isPlugged

Check if phone is charging

Overview

PropValue
Namespacesession
Actionread
Functionalityboth
Positional parameter order-
AliasesgetIsPlugged, session.getIsPlugged, session.isPlugged
Deprecated aliasesgetIsPlugged, session.getIsPlugged
Licensenone
WAPI overridegetIsPlugged
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryGET/api/session/isPluggedisPluggedActive
Deprecated aliasGET/api/getIsPluggedgetIsPluggedDeprecated
AliasGET/api/isPluggedisPluggedActive
Deprecated aliasGET/api/session/getIsPluggedsession.getIsPluggedDeprecated

Usage

const result = await client.isPlugged({});
const result = await client.session.isPlugged({});
curl -X GET "http://localhost:8080/api/session/isPlugged" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

PropValue
Return typeboolean

setMyName

Set host name

Overview

PropValue
Namespacesession
Actionupdate
Functionalitypersonal-only
Positional parameter ordername
Aliasessession.setDisplayName, session.setMyName, session.setName, setDisplayName
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPUT/api/session/setNamesetMyNameActive
AliasPUT/api/session/setDisplayNamesession.setDisplayNameActive
AliasPUT/api/session/setMyNamesession.setMyNameActive
AliasPUT/api/setDisplayNamesetDisplayNameActive
AliasPUT/api/setMyNamesetMyNameActive

Usage

const result = await client.setMyName({
  name: "OpenWA Bot",
});
const result = await client.session.setName({
  name: "OpenWA Bot",
});
curl -X PUT "http://localhost:8080/api/session/setName" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "name": "OpenWA Bot"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeboolean

setMyStatus

Set host status

Overview

PropValue
Namespacesession
Actionupdate
Functionalityboth
Positional parameter orderstatusText
Aliasessession.setMyStatus, session.setStatus, session.setStatusText, setStatusText
Deprecated aliases-
Licensenone
WAPI override-
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPUT/api/session/setStatussetMyStatusActive
AliasPUT/api/session/setMyStatussession.setMyStatusActive
AliasPUT/api/session/setStatusTextsession.setStatusTextActive
AliasPUT/api/setMyStatussetMyStatusActive
AliasPUT/api/setStatusTextsetStatusTextActive

Usage

const result = await client.setMyStatus({
  statusText: "Available",
});
const result = await client.session.setStatus({
  statusText: "Available",
});
curl -X PUT "http://localhost:8080/api/session/setStatus" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "statusText": "Available"
  }'

Parameters

Prop

Type

Output

PropValue
Return typeboolean

setProfilePictureInsiders

Set profile picture

Overview

PropValue
Namespacesession
Actionupdate
Functionalityboth
Positional parameter orderimage
Aliasessession.setProfilePic, session.setProfilePicture, setProfilePic
Deprecated aliasessession.setProfilePic, setProfilePic
Licenseinsiders
WAPI overridesetProfilePic
DeprecatedNo

Routes

TypeMethodPathNameStatus
PrimaryPUT/api/session/setProfilePicturesetProfilePictureActive
Deprecated aliasPUT/api/session/setProfilePicsession.setProfilePicDeprecated
Deprecated aliasPUT/api/setProfilePicsetProfilePicDeprecated
AliasPUT/api/setProfilePicturesetProfilePictureActive

Usage

const result = await client.setProfilePicture({
  image: "data:image/png;base64,iVBORw0KGgo...",
});
const result = await client.session.setProfilePicture({
  image: "data:image/png;base64,iVBORw0KGgo...",
});
curl -X PUT "http://localhost:8080/api/session/setProfilePicture" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{
    "image": "data:image/png;base64,iVBORw0KGgo..."
  }'

Parameters

Prop

Type

Output

PropValue
Return typeboolean
Wally the Walrus typing

Was this helpful?

Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!

On this page