Skip to main content

Class: Client

Methods​

B()
insiders
​

B(chatId, payload): Promise<MessageId>

🏅May require insiders license

Use this link to get the correct license.

danger

Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.

Use a raw payload within your open-wa session

Parameters​

• chatId: ChatId

• payload

returns: MessageId

Returns​

Promise<MessageId>

Example​

If there is a code block, then both TypeDoc and VSCode will treat text outside of the code block as regular text.

await B('44123456789@c.us', {
 test: 1
})

loadAllEarlierMessages

acceptGroupJoinRequest()​

acceptGroupJoinRequest(messageId): Promise<boolean>

Accepts a request from a recipient to join a group. Takes the message ID of the request message.

Parameters​

• messageId: MessageId

Returns​

Promise<boolean>

addLabel()​

addLabel(label, chatId): Promise<boolean>

Adds label from chat, message or contact. Only for business accounts.

Parameters​

• label: string

• chatId: ChatId

Returns​

Promise<boolean>

addParticipant()​

addParticipant(groupId, participantId): Promise<boolean>

Add participant to Group

If not a group chat, returns NOT_A_GROUP_CHAT.

If the chat does not exist, returns GROUP_DOES_NOT_EXIST

If the participantId does not exist in the contacts, returns NOT_A_CONTACT

If the host account is not an administrator, returns INSUFFICIENT_PERMISSIONS

Parameters​

• groupId: GroupChatId

'0000000000-00000000@g.us'

• participantId: ContactId | ContactId[]

'000000000000@c.us'

Returns​

Promise<boolean>

approveGroupJoinRequest()​

approveGroupJoinRequest(groupChatId, contactId): Promise<string | boolean>

Approves a group join request

Parameters​

• groupChatId: GroupChatId

The group chat id

• contactId: ContactId

The contact id of the person who is requesting to join the group

Returns​

Promise<string | boolean>

Promise<boolean>

archiveChat()​

archiveChat(id, archive): Promise<boolean>

Parameters​

• id: ChatId

The id of the conversation

• archive: boolean

boolean true => archive, false => unarchive

Returns​

Promise<boolean>

boolean true: worked, false: didnt work (probably already in desired state)

autoReject()​

autoReject(message?): Promise<boolean>

Automatically reject calls on the host account device. Please note that the device that is calling you will continue to ring.

Update: Due to the nature of MD, the host account will continue ringing.

Parameters​

• message?: string

optional message to send to the calling account when their call is detected and rejected

Returns​

Promise<boolean>

awaitMessages()​

awaitMessages(c, filter, options?): Promise<Collection<string, Message>>

[FROM DISCORDJS] Similar to createMessageCollector but in promise form. Resolves with a collection of messages that pass the specified filter.

Parameters​

• c: ChatId | Message | Chat

The Mesasge/Chat or Chat Id to base this message colletor on

• filter: CollectorFilter<[Message]>

The filter function to use

• options?: AwaitMessagesOptions = {}

Optional options to pass to the internal collector

Returns​

Promise<Collection<string, Message>>

Example​

// Await !vote messages
const filter = m => m.body.startsWith('!vote');
// Errors: ['time'] treats ending because of the time limit as an error
channel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })
  .then(collected => console.log(collected.size))
  .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));

checkNumberStatus()​

checkNumberStatus(contactId): Promise<NumberCheck>

Checks if a number is a valid WA number

Parameters​

• contactId: ContactId

Returns​

Promise<NumberCheck>

checkReadReceipts()
insiders
​

checkReadReceipts(contactId): Promise<string | boolean>

🏅May require insiders license

Use this link to get the correct license.

Check if a recipient has read receipts on.

This will only work if you have chats sent back and forth between you and the contact 1-1.

Parameters​

• contactId: ContactId

The Id of the contact with which you have an existing conversation with messages already.

Returns​

Promise<string | boolean>

Promise<string | boolean> true or false or a string with an explaintaion of why it wasn't able to determine the read receipts.

clearAllChats()​

clearAllChats(ts?): Promise<boolean>

Clears all chats of all messages. This does not delete chats. Please be careful with this as it will remove all messages from whatsapp web and the host device. This feature is great for privacy focussed bots.

Parameters​

• ts?: number

number A chat that has had a message after ts (epoch timestamp) will not be cleared.

Returns​

Promise<boolean>

clearChat()​

clearChat(chatId): Promise<boolean>

Delete all messages from the chat.

Parameters​

• chatId: ChatId

Returns​

Promise<boolean>

boolean

contactBlock()​

contactBlock(id): Promise<boolean>

Block contact

Parameters​

• id: ContactId

'000000000000@c.us'

Returns​

Promise<boolean>

contactUnblock()​

contactUnblock(id): Promise<boolean>

Unblock contact

Parameters​

• id: ContactId

'000000000000@c.us'

Returns​

Promise<boolean>

createCommunity()
insiders
​

createCommunity(communityName, communitySubject, icon, existingGroups, newGroups?): Promise<`${number}@g.us`>

🏅May require insiders license

Use this link to get the correct license.

Create a new community

Parameters​

• communityName: string

The community name

• communitySubject: string

• icon: DataURL

DataURL of a 1:1 ratio jpeg for the community icon

• existingGroups: GroupChatId[] = []

An array of existing group IDs, that are not already part of a community, to add to this new community.

• newGroups?: NewCommunityGroup[]

An array of new group objects that

Returns​

Promise<`${number}@g.us`>

createGroup()​

createGroup(groupName, contacts): Promise<GroupChatCreationResponse>

Create a group and add contacts to it

Parameters​

• groupName: string

group name: 'New group'

• contacts: ContactId | ContactId[]

Returns​

Promise<GroupChatCreationResponse>

createLabel()
insiders
​

createLabel(label): Promise<string | boolean>

🏅May require insiders license

Use this link to get the correct license.

Adds label from chat, message or contact. Only for business accounts.

Parameters​

• label: string

Returns​

Promise<string | boolean>

false if something went wrong, or the id (usually a number as a string) of the new label (for example "58")

createMessageCollector()​

createMessageCollector(c, filter, options): MessageCollector

Returns a new message collector for the chat which is related to the first parameter c

Parameters​

• c: ChatId | Message | Chat

The Mesasge/Chat or Chat Id to base this message colletor on

• filter: CollectorFilter<[Message]>

A function that consumes a [Message] and returns a boolean which determines whether or not the message shall be collected.

• options: CollectorOptions

The options for the collector. For example, how long the collector shall run for, how many messages it should collect, how long between messages before timing out, etc.

Returns​

MessageCollector

createNewProduct()
insiders
​

createNewProduct(name, price, currency, images, description, url?, internalId?, isHidden?): Promise<Product>

🏅May require insiders license

Use this link to get the correct license.

Add a product to your catalog

Parameters​

• name: string

The name of the product

• price: number

The price of the product

• currency: string

The 3-letter currenct code for the product

• images: string[]

An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required.

• description: string

optional, the description of the product

• url?: string

The url of the product for more information

• internalId?: string

The internal/backoffice id of the product

• isHidden?: boolean

Whether or not the product is shown publicly in your catalog

Returns​

Promise<Product>

product object

cutChatCache()​

cutChatCache(): Promise<object>

This simple function halves the amount of chats in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session. Calling this method will cut the message cache as much as possible, reducing the memory usage of your process. You should use this in conjunction with getAmountOfLoadedMessages to intelligently control the session message cache.

Returns​

Promise<object>

after​

after: object

after.chats​

chats: number

after.msgs​

msgs: number

before​

before: object

before.chats​

chats: number

before.msgs​

msgs: number

cutMsgCache()​

cutMsgCache(): Promise<number>

This simple function halves the amount of messages in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session. Calling this method will cut the message cache to 2000 messages, therefore reducing the memory usage of your process. You should use this in conjunction with getAmountOfLoadedMessages to intelligently control the session message cache.

Returns​

Promise<number>

darkMode()​

darkMode(activate): Promise<boolean>

Start dark mode [NOW GENERALLY AVAILABLE]

Parameters​

• activate: boolean

true to activate dark mode, false to deactivate

Returns​

Promise<boolean>

decryptMedia()​

decryptMedia(message): Promise<DataURL>

Decrypts a media message.

Parameters​

• message: MessageId | Message

This can be the serialized [[MessageId]] or the whole [[Message]] object. It is advised to just use the serialized message ID.

Returns​

Promise<DataURL>

Promise<[[DataURL]]>

deleteAllStatus()​

deleteAllStatus(): Promise<boolean>

Alias for deleteStory

Returns​

Promise<boolean>

deleteAllStories()
restricted
​

deleteAllStories(): Promise<boolean>

🏅May require restricted license

Use this link to get the correct license.

Deletes all your existing stories.

Returns​

Promise<boolean>

boolean. True if it worked.

deleteChat()​

deleteChat(chatId): Promise<boolean>

Delete the conversation from your WA

Parameters​

• chatId: ChatId

Returns​

Promise<boolean>

boolean

deleteMessage()​

deleteMessage(chatId, messageId, onlyLocal): Promise<void>

Deletes message of given message id

Parameters​

• chatId: ChatId

The chat id from which to delete the message.

• messageId: MessageId | MessageId[]

The specific message id of the message to be deleted

• onlyLocal: boolean = false

If it should only delete locally (message remains on the other recipienct's phone). Defaults to false.

Returns​

Promise<void>

nothing

deleteStaleChats()​

deleteStaleChats(startingFrom?): Promise<boolean>

Deletes chats from a certain index (default 1000). E.g if this startingFrom param is 100 then all chats from index 100 onwards will be deleted.

Parameters​

• startingFrom?: number

the chat index to start from. Please do not set this to anything less than 10 @default: 1000

Returns​

Promise<boolean>

deleteStatus()​

deleteStatus(statusesToDelete): Promise<boolean>

Alias for deleteStory

Parameters​

• statusesToDelete: string | string[]

Returns​

Promise<boolean>

deleteStory()
restricted
​

deleteStory(statusesToDelete): Promise<boolean>

🏅May require restricted license

Use this link to get the correct license.

Consumes a list of id strings of stories to delete.

Parameters​

• statusesToDelete: string | string[]

string [] | string an array of ids of stories to delete.

Returns​

Promise<boolean>

boolean. True if it worked.

demoteParticipant()​

demoteParticipant(groupId, participantId): Promise<boolean>

Demote Admin of Group

If not a group chat, returns NOT_A_GROUP_CHAT.

If the chat does not exist, returns GROUP_DOES_NOT_EXIST

If the participantId does not exist in the group chat, returns NOT_A_PARTICIPANT

If the host account is not an administrator, returns INSUFFICIENT_PERMISSIONS

Parameters​

• groupId: GroupChatId

'0000000000-00000000@g.us'

• participantId: ContactId | ContactId[]

'000000000000@c.us'

Returns​

Promise<boolean>

download()​

download(url, optionsOverride): Promise<DataURL>

A convinience method to download the [[DataURL]] of a file

Parameters​

• url: string

The url

• optionsOverride: any = {}

You can use this to override the axios request config

Returns​

Promise<DataURL>

Promise<DataURL>

downloadFileWithCredentials()​

downloadFileWithCredentials(url): Promise<Base64>

Download via the browsers authenticated session via URL.

Parameters​

• url: string

Returns​

Promise<Base64>

base64 string (non-data url)

downloadProfilePicFromMessage()​

downloadProfilePicFromMessage(message): Promise<Base64>

Download profile pics from the message object.

 const filename = `profilepic_${message.from}.jpeg`;
 const data = await client.downloadProfilePicFromMessage(message);
 const dataUri = `data:image/jpeg;base64,${data}`;
 fs.writeFile(filename, mData, 'base64', function(err) {
   if (err) {
     return console.log(err);
   }
   console.log('The file was saved!');
 });

Parameters​

• message: Message

Returns​

Promise<Base64>

editMessage()​

editMessage(messageId, text): Promise<boolean | MessageId>

NOTE: This is experimental, most accounts do not have access to this feature in their apps.

Edit an existing message

Parameters​

• messageId: MessageId

The message ID to edit

• text: Content

The new text content

Returns​

Promise<boolean | MessageId>

editProduct()
insiders
​

editProduct(productId, name?, price?, currency?, images?, description?, url?, internalId?, isHidden?): Promise<Product>

🏅May require insiders license

Use this link to get the correct license.

Edit a product in your catalog

Parameters​

• productId: string

The catalog ID of the product

• name?: string

The name of the product

• price?: number

The price of the product

• currency?: string

The 3-letter currenct code for the product

• images?: DataURL[]

An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required.

• description?: string

optional, the description of the product

• url?: string

The url of the product for more information

• internalId?: string

The internal/backoffice id of the product

• isHidden?: boolean

Whether or not the product is shown publicly in your catalog

Returns​

Promise<Product>

product object

emitUnreadMessages()​

emitUnreadMessages(): Promise<MessageId[]>

Fires all unread messages to the onMessage listener. Make sure to call this AFTER setting your listeners.

Returns​

Promise<MessageId[]>

array of message IDs

favSticker()​

favSticker(msgId, fav): Promise<string>

Set/Unset a sticker as a fav.

Parameters​

• msgId: MessageId

The message Id related to the sticker you want to fav

• fav: boolean = true

set this to true to fav a sticker, set it to false to remove the sticker from favorites. default true

Returns​

Promise<string>

favId The ID (filehash) of the fav sticker

forceRefocus()​

forceRefocus(): Promise<boolean>

This is a convinient method to click the Use Here button in the WA web session.

Use this when [[STATE]] is CONFLICT. You can read more about managing state here:

[[Detecting Logouts]]

Returns​

Promise<boolean>

forceStaleMediaUpdate()
insiders
​

forceStaleMediaUpdate(messageId): Promise<false | Message>

🏅May require insiders license

Use this link to get the correct license.

If a file is old enough, it will 404 if you try to decrypt it. This will allow you to force the host account to re upload the file and return a decryptable message.

if you run this without a valid insiders key, it will return false and cause an error upon decryption.

Parameters​

• messageId: MessageId

Returns​

Promise<false | Message>

[[Message]] OR false

forceUpdateConnectionState()​

forceUpdateConnectionState(killBeforeReconnect?): Promise<STATE>

Forces the session to update the connection state.

Parameters​

• killBeforeReconnect?: boolean

Returns​

Promise<STATE>

updated connection state

forceUpdateLiveLocation()​

forceUpdateLiveLocation(chatId): Promise<boolean | LiveLocationChangedEvent[]>

A list of participants in the chat who have their live location on. If the chat does not exist, or the chat does not have any contacts actively sharing their live locations, it will return false. If it's a chat with a single contact, there will be only 1 value in the array if the contact has their livelocation on. Please note. This should only be called once every 30 or so seconds. This forces the phone to grab the latest live location data for the number. This can be used in conjunction with onLiveLocation (this will trigger onLiveLocation).

Parameters​

• chatId: ChatId

string Id of the chat you want to force the phone to get the livelocation data for.

Returns​

Promise<boolean | LiveLocationChangedEvent[]>

Promise<LiveLocationChangedEvent []> | boolean

forwardMessages()​

forwardMessages(to, messages, skipMyMessages): Promise<boolean | MessageId[]>

Forward an array of messages to a specific chat using the message ids or Objects

Parameters​

• to: ChatId

'000000000000@c.us'

• messages: MessageId | MessageId[]

this can be any mixture of message ids or message objects

• skipMyMessages: boolean

This indicates whether or not to skip your own messages from the array

Returns​

Promise<boolean | MessageId[]>

gc()​

gc(): Promise<void>

It calls the JavaScript garbage collector

Returns​

Promise<void>

Nothing.

getAllChatIds()​

getAllChatIds(): Promise<ChatId[]>

retrieves all Chat Ids

Returns​

Promise<ChatId[]>

array of [ChatId]

getAllChats()​

getAllChats(withNewMessageOnly): Promise<Chat[]>

Retrieves all chats

Parameters​

• withNewMessageOnly: boolean = false

Returns​

Promise<Chat[]>

array of [Chat]

getAllChatsWithMessages()​

getAllChatsWithMessages(withNewMessageOnly): Promise<Chat[]>

Parameters​

• withNewMessageOnly: boolean = false

Returns​

Promise<Chat[]>

array of [Chat]

Deprecated​

Retrieves all chats with messages

Please use getAllUnreadMessages instead of this to see all messages indicated by the green dots in the chat.

getAllCommunities()​

getAllCommunities(): Promise<`${number}@g.us`[]>

Retrieve all commmunity Ids

Returns​

Promise<`${number}@g.us`[]>

array of group ids

getAllContacts()​

getAllContacts(): Promise<Contact[]>

Retrieves all contacts

Returns​

Promise<Contact[]>

array of [Contact]

getAllGroups()​

getAllGroups(withNewMessagesOnly): Promise<Chat[]>

Retrieve all groups

Parameters​

• withNewMessagesOnly: boolean = false

Returns​

Promise<Chat[]>

array of groups

getAllLabels()​

getAllLabels(): Promise<Label[]>

Returns all labels and the corresponding tagged items.

Returns​

Promise<Label[]>

getAllMessagesInChat()​

getAllMessagesInChat(chatId, includeMe, includeNotifications): Promise<Message[]>

Retrieves all Messages in a chat that have been loaded within the WA web instance.

This does not load every single message in the chat history.

Parameters​

• chatId: ChatId

• includeMe: boolean

• includeNotifications: boolean

Returns​

Promise<Message[]>

Message[]

getAllNewMessages()​

getAllNewMessages(): Promise<Message[]>

Retrieves all new Messages. where isNewMsg==true

Returns​

Promise<Message[]>

list of messages

getAllUnreadMessages()​

getAllUnreadMessages(): Promise<Message[]>

Retrieves all unread Messages. where ack==-1

Returns​

Promise<Message[]>

list of messages

getAmountOfLoadedMessages()​

getAmountOfLoadedMessages(): Promise<number>

Easily get the amount of messages loaded up in the session. This will allow you to determine when to clear chats/cache.

Returns​

Promise<number>

getBatteryLevel()​

getBatteryLevel(): Promise<number>

Returns​

Promise<number>

Number

Deprecated​

No longer works due to multi-device changes Retrieves Battery Level

getBlockedIds()​

getBlockedIds(): Promise<ChatId[]>

retrieves an array of IDs of accounts blocked by the host account.

Returns​

Promise<ChatId[]>

Promise<ChatId[]>

getBusinessProfile()​

getBusinessProfile(id): Promise<BusinessProfile>

Get the business info of a given contact id

Parameters​

• id: ContactId

id of business profile (i.e the number with @c.us)

Returns​

Promise<BusinessProfile>

None

getBusinessProfilesProducts()​

getBusinessProfilesProducts(id): Promise<any>

Find any product listings of the given number. Use this to query a catalog

Parameters​

• id: ContactId

id of business profile (i.e the number with @c.us)

Returns​

Promise<any>

None

getChat()​

getChat(contactId): Promise<Chat>

Retrieves chat object of given contact id

Parameters​

• contactId: ContactId

Returns​

Promise<Chat>

contact detial as promise

getChatById()​

getChatById(contactId): Promise<Chat>

Retrieves chat object of given contact id

Parameters​

• contactId: ContactId

Returns​

Promise<Chat>

contact detial as promise

getChatWithNonContacts()​

getChatWithNonContacts(): Promise<Contact[]>

Returns a list of contact with whom the host number has an existing chat who are also not contacts.

Returns​

Promise<Contact[]>

getChatsByLabel()​

getChatsByLabel(label): Promise<Chat[]>

Get an array of chats that match the label parameter. For example, if you want to get an array of chat objects that have the label "New customer".

This method is case insenstive and only works on business host accounts.

Parameters​

• label: string

Returns​

Promise<Chat[]>

Label​

The label name

getCommonGroups()
insiders
​

getCommonGroups(contactId): Promise<object[]>

🏅May require insiders license

Use this link to get the correct license.

Retrieves the groups that you have in common with a contact

Parameters​

• contactId: ContactId

Returns​

Promise<object[]>

getCommunityAdminIds()​

getCommunityAdminIds(communityId): Promise<object[]>

Retrieves community admin Ids

Parameters​

• communityId: GroupChatId

community id

Returns​

Promise<object[]>

getCommunityAdmins()​

getCommunityAdmins(communityId): Promise<object[]>

Retrieves community admins as Contact objects

Parameters​

• communityId: GroupChatId

community id

Returns​

Promise<object[]>

getCommunityInfo()​

getCommunityInfo(communityId): Promise<GroupMetadata & object>

Returns the community metadata. Like group metadata but with a subGroups property which is the group metadata of the community subgroups.

Parameters​

• communityId: GroupChatId

community id

Returns​

Promise<GroupMetadata & object>

getCommunityParticipantIds()​

getCommunityParticipantIds(communityId): Promise<object[]>

Retrieves community members Ids

Parameters​

• communityId: GroupChatId

community id

Returns​

Promise<object[]>

getCommunityParticipants()​

getCommunityParticipants(communityId): Promise<object[]>

Retrieves community members as Contact objects

Parameters​

• communityId: GroupChatId

community id

Returns​

Promise<object[]>

getConfig()​

getConfig(): ConfigObject

Get the config which was used to set up the client. Sensitive details (like devTools username and password, and browserWSEndpoint) are scrubbed

Returns​

ConfigObject

SessionInfo

getConnectionState()​

getConnectionState(): Promise<STATE>

Returns the connection state

Returns​

Promise<STATE>

getContact()​

getContact(contactId): Promise<Contact>

Retrieves contact detail object of given contact id

Parameters​

• contactId: ContactId

Returns​

Promise<Contact>

contact detial as promise

getEventSignature()​

getEventSignature(simpleListener?): string

Parameters​

• simpleListener?: SimpleListener

Returns​

string

getFavStickers()​

getFavStickers(): Promise<Partial<Message>>

Get an array of fav'ed stickers

Returns​

Promise<Partial<Message>>

getFeatures()​

getFeatures(): Promise<any>

Returns an object with properties of internal features and boolean values that represent if the respective feature is enabled or not.

Returns​

Promise<any>

getGeneratedUserAgent()​

getGeneratedUserAgent(userA?): Promise<string>

Get the generated user agent, this is so you can send it to the decryption module.

Parameters​

• userA?: string

Returns​

Promise<string>

String useragent of wa-web session

getGptArray()​

getGptArray(chatId, last): Promise<object[]>

Returns a properly formatted array of messages from to send to the openai api

Parameters​

• chatId: ChatId

• last: number = 10

The amount of previous messages to retrieve. Defaults to 10

Returns​

Promise<object[]>

getGroupAdmins()​

getGroupAdmins(groupId): Promise<ContactId[]>

Get Admins of a Group

Parameters​

• groupId: GroupChatId

'0000000000-00000000@g.us'

Returns​

Promise<ContactId[]>

getGroupApprovalRequests()​

getGroupApprovalRequests(groupChatId): Promise<ContactId[]>

Gets the contact IDs of members requesting approval to join the group

Parameters​

• groupChatId: GroupChatId

Returns​

Promise<ContactId[]>

Promise<ContactId[]>

getGroupInfo()​

getGroupInfo(groupId): Promise<any>

Returns the title and description of a given group id.

Parameters​

• groupId: GroupChatId

group id

Returns​

Promise<any>

getGroupInviteLink(chatId): Promise<string>

Retrieves an invite link for a group chat. returns false if chat is not a group.

Parameters​

• chatId: ChatId

Returns​

Promise<string>

Promise<string>

getGroupMembers()​

getGroupMembers(groupId): Promise<Contact[]>

Returns group members [Contact] objects

Parameters​

• groupId: GroupChatId

Returns​

Promise<Contact[]>

getGroupMembersId()​

getGroupMembersId(groupId): Promise<ContactId[]>

Retrieves group members as [Id] objects

Parameters​

• groupId: GroupChatId

group id

Returns​

Promise<ContactId[]>

getHostNumber()​

getHostNumber(): Promise<string>

Retrieves the host device number. Use this number when registering for a license key

Returns​

Promise<string>

Number

getIndicatedNewMessages()​

getIndicatedNewMessages(): Promise<Message[]>

Retrieves all unread Messages as indicated by the red dots in WA web. This returns an array of objects and are structured like so:

[{
"id": "000000000000@g.us", //the id of the chat
"indicatedNewMessages": [] //array of messages, not including any messages by the host phone
}]

Returns​

Promise<Message[]>

list of messages

getInstanceId()​

getInstanceId(): string

Get the INSTANCE_ID of the current session

Returns​

string

getIsPlugged()​

getIsPlugged(): Promise<boolean>

Retrieves whether or not phone is plugged in (i.e on charge)

Returns​

Promise<boolean>

Number

getIssueLink(): Promise<string>

Generate a pre-filled github issue link to easily report a bug

Returns​

Promise<string>

getKickedGroups()​

getKickedGroups(): Promise<GroupChatId[]>

Returns an array of group ids where the host account has been kicked

Returns​

Promise<GroupChatId[]>

getLastMsgTimestamps()​

getLastMsgTimestamps(): Promise<object[]>

Get an array of chatIds with their respective last message's timestamp.

This is useful for determining what chats are old/stale and need to be deleted.

Returns​

Promise<object[]>

getLastSeen()​

getLastSeen(chatId): Promise<number | boolean>

Retrieves the epoch timestamp of the time the contact was last seen. This will not work if:

  1. They have set it so you cannot see their last seen via privacy settings.
  2. You do not have an existing chat with the contact.
  3. The chatId is for a group In both of those instances this method will return undefined.

Parameters​

• chatId: ChatId

The id of the chat.

Returns​

Promise<number | boolean>

number timestamp when chat was last online or undefined.

getLicenseLink(params?): Promise<string>

Generate a license link

Parameters​

• params?: string

Returns​

Promise<string>

getLicenseType()​

getLicenseType(): Promise<false | LicenseType>

Returns the the type of license key used by the session.

Returns​

Promise<false | LicenseType>

getListenerQueues()​

getListenerQueues(): object

If you have set onAnyMessage or onMessage with the second parameter (PQueue options) then you may want to inspect their respective PQueue's.

Returns​

object

onAck​

onAck: PQueue<PriorityQueue, DefaultAddOptions>

onAddedToGroup​

onAddedToGroup: PQueue<PriorityQueue, DefaultAddOptions>

onAnyMessage​

onAnyMessage: PQueue<PriorityQueue, DefaultAddOptions>

onBattery​

onBattery: PQueue<PriorityQueue, DefaultAddOptions>

onBroadcast​

onBroadcast: PQueue<PriorityQueue, DefaultAddOptions>

onButton​

onButton: PQueue<PriorityQueue, DefaultAddOptions>

onCallState​

onCallState: PQueue<PriorityQueue, DefaultAddOptions>

onChatDeleted​

onChatDeleted: PQueue<PriorityQueue, DefaultAddOptions>

onChatOpened​

onChatOpened: PQueue<PriorityQueue, DefaultAddOptions>

onChatState​

onChatState: PQueue<PriorityQueue, DefaultAddOptions>

onContactAdded​

onContactAdded: PQueue<PriorityQueue, DefaultAddOptions>

onGlobalParticipantsChanged​

onGlobalParticipantsChanged: PQueue<PriorityQueue, DefaultAddOptions>

onGroupApprovalRequest​

onGroupApprovalRequest: PQueue<PriorityQueue, DefaultAddOptions>

onGroupChange​

onGroupChange: PQueue<PriorityQueue, DefaultAddOptions>

onIncomingCall​

onIncomingCall: PQueue<PriorityQueue, DefaultAddOptions>

onLabel​

onLabel: PQueue<PriorityQueue, DefaultAddOptions>

onLogout​

onLogout: PQueue<PriorityQueue, DefaultAddOptions>

onMessage​

onMessage: PQueue<PriorityQueue, DefaultAddOptions>

onMessageDeleted​

onMessageDeleted: PQueue<PriorityQueue, DefaultAddOptions>

onNewProduct​

onNewProduct: PQueue<PriorityQueue, DefaultAddOptions>

onOrder​

onOrder: PQueue<PriorityQueue, DefaultAddOptions>

onPlugged​

onPlugged: PQueue<PriorityQueue, DefaultAddOptions>

onPollVote​

onPollVote: PQueue<PriorityQueue, DefaultAddOptions>

onReaction​

onReaction: PQueue<PriorityQueue, DefaultAddOptions>

onRemovedFromGroup​

onRemovedFromGroup: PQueue<PriorityQueue, DefaultAddOptions>

onStateChanged​

onStateChanged: PQueue<PriorityQueue, DefaultAddOptions>

onStory​

onStory: PQueue<PriorityQueue, DefaultAddOptions>

getMe()​

getMe(): Promise<any>

Returns an object with all of your host device details

Returns​

Promise<any>

getMessageById()​

getMessageById(messageId): Promise<Message>

Retrieves message object of given message id

Parameters​

• messageId: MessageId

Returns​

Promise<Message>

message object

getMessageInfo()
insiders
​

getMessageInfo(messageId): Promise<MessageInfo>

🏅May require insiders license

Use this link to get the correct license.

Get the detailed message info for a group message sent out by the host account.

Parameters​

• messageId: MessageId

The message Id

Returns​

Promise<MessageInfo>

getMessageReaders()​

getMessageReaders(messageId): Promise<Contact[]>

Returns an array of contacts that have read the message. If the message does not exist, it will return an empty array. If the host account has disabled read receipts this may not work! Each of these contact objects have a property t which represents the time at which that contact read the message.

Parameters​

• messageId: MessageId

The message id

Returns​

Promise<Contact[]>

getMyLastMessage()​

getMyLastMessage(chatId?): Promise<Message>

Retrieves the last message sent by the host account in any given chat or globally.

Parameters​

• chatId?: ChatId

This is optional. If no chat Id is set then the last message sent by the host account will be returned.

Returns​

Promise<Message>

message object or undefined if the host account's last message could not be found.

getMyStatusArray()​

getMyStatusArray(): Promise<Message[]>

Alias for deleteStory

Returns​

Promise<Message[]>

getMyStoryArray()
restricted
​

getMyStoryArray(): Promise<Message[]>

🏅May require restricted license

Use this link to get the correct license.

Retrieves all existing stories.

Only works with a Story License Key

Returns​

Promise<Message[]>

getOrder()
insiders
​

getOrder(id): Promise<Order>

🏅May require insiders license

Use this link to get the correct license.

Retrieves an order object

Parameters​

• id: string | MessageId

Returns​

Promise<Order>

order object

getPage()​

getPage(): Page

Returns​

Page

getPollData()​

getPollData(messageId): Promise<PollData>

Returns poll data including results and votes.

Parameters​

• messageId: MessageId

The message id of the Poll

Returns​

Promise<PollData>

getProcessStats()​

getProcessStats(): Promise<any>

Get the stats of the current process and the corresponding browser process.

Returns​

Promise<any>

getProfilePicFromServer()​

getProfilePicFromServer(chatId): Promise<string>

Retrieves chat picture

Parameters​

• chatId: ChatId

Returns​

Promise<string>

Url of the chat picture or undefined if there is no picture for the chat.

getSessionId()​

getSessionId(): string

Returns​

string

getSessionInfo()​

getSessionInfo(): SessionInfo

Get the session info

Returns​

SessionInfo

SessionInfo

getSingleProperty()​

getSingleProperty(namespace, id, property): Promise<any>

This allows you to get a single property of a single object from the session. This limints the amouunt of data you need to sift through, reduces congestion between your process and the session and the flexibility to build your own specific getters.

Example - get message read state (ack):

const ack  = await client.getSingleProperty('Msg',"true_12345678912@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",'ack')

Parameters​

• namespace: namespace

• id: string

id of the object to get from the specific namespace

• property: string

the single property key to get from the object.

Returns​

Promise<any>

any If the property or the id cannot be found, it will return a 404

getSnapshot()​

getSnapshot(chatId?, width?, height?): Promise<DataURL>

Returns a PNG DataURL screenshot of the session

Parameters​

• chatId?: ChatId

Chat ID to open before taking a snapshot

• width?: number

Width of the viewport for the snapshot. Height also required if you want to resize.

• height?: number

Height of the viewport for the snapshot. Width also required if you want to resize.

Returns​

Promise<DataURL>

Promise<DataURL>

getStarredMessages()​

getStarredMessages(chatId?): Promise<Message[]>

Retrieves the starred messages in a given chat

Parameters​

• chatId?: ChatId

Chat ID to filter starred messages by

Returns​

Promise<Message[]>

message object

getStatus()​

getStatus(contactId): Promise<object>

Get the status of a contact

Parameters​

• contactId: ContactId

to '000000000000@c.us'

Returns​

Promise<object>

id​

id: string

status​

status: string

getStickerDecryptable()​

getStickerDecryptable(messageId): Promise<false | Message>

Parameters​

• messageId: MessageId

The message ID message.id

Returns​

Promise<false | Message>

message object OR false

Deprecated​

Retrieves a message object which results in a valid sticker instead of a blank one. This also works with animated stickers.

If you run this without a valid insiders key, it will return false and cause an error upon decryption.

getStoryViewers()
restricted
​

getStoryViewers(id?): Promise<ContactId[] | object>

🏅May require restricted license

Use this link to get the correct license.

Retrieves an array of user ids that have 'read' your story.

Parameters​

• id?: string

string The id of the story

Returns​

Promise<ContactId[] | object>

getTunnelCode()​

getTunnelCode(): Promise<string>

The EASY API uses this string to secure a subdomain on the openwa public tunnel service.

Returns​

Promise<string>

getUnreadMessages()​

getUnreadMessages(includeMe, includeNotifications, use_unread_count): Promise<Chat & object[]>

Retrieves all unread Messages

Parameters​

• includeMe: boolean

• includeNotifications: boolean

• use_unread_count: boolean

Returns​

Promise<Chat & object[]>

any

getUnsentMessages()​

getUnsentMessages(): Promise<Message[]>

Retreive an array of messages that are not yet sent to the recipient via the host account device (i.e no ticks)

Returns​

Promise<Message[]>

getVCards()​

getVCards(msgId): Promise<string[]>

Extracts vcards from a message.This works on messages of typ vcard or multi_vcard

Parameters​

• msgId: MessageId

string id of the message to extract the vcards from

Returns​

Promise<string[]>

[vcard]

[
{
displayName:"Contact name",
vcard: "loong vcard string"
}
]

or false if no valid vcards found.

Please use vcf to convert a vcard string into a json object

getWAVersion()​

getWAVersion(): Promise<string>

Returns​

Promise<string>

ghostForward()​

ghostForward(to, messageId): Promise<boolean | MessageId>

Ghost forwarding is like a normal forward but as if it were sent from the host phone [i.e it doesn't show up as forwarded.] Any potential abuse of this method will see it become paywalled.

Parameters​

• to: ChatId

• messageId: MessageId

Returns​

Promise<boolean | MessageId>

Promise<MessageId | boolean>

healthCheck()​

healthCheck(): Promise<HealthCheck>

Runs a health check to help you determine if/when is an appropiate time to restart/refresh the session.

Returns​

Promise<HealthCheck>

iAmAdmin()​

iAmAdmin(): Promise<GroupChatId[]>

Returns an array of group ids where the host account is admin

Returns​

Promise<GroupChatId[]>

inviteInfo()​

inviteInfo(link): Promise<any>

Get the details of a group through the invite link

Parameters​

• link: string

This can be an invite link or invite code

Returns​

Promise<any>

isChatMuted()​

isChatMuted(chatId): Promise<boolean>

Checks if a chat is muted

Parameters​

• chatId: ChatId

The id of the chat you want to check

Returns​

Promise<boolean>

boolean. false if the chat does not exist.

isChatOnline()​

isChatOnline(chatId): Promise<string | boolean>

Checks if a chat contact is online. Not entirely sure if this works with groups.

It will return true if the chat is online, false if the chat is offline, PRIVATE if the privacy settings of the contact do not allow you to see their status and NO_CHAT if you do not currently have a chat with that contact.

Parameters​

• chatId: ChatId

chat id: xxxxx@c.us

Returns​

Promise<string | boolean>

isConnected()​

isConnected(): Promise<boolean>

Retrieves if the phone is online. Please note that this may not be real time.

Returns​

Promise<boolean>

Boolean

isGroupIdUnsafe()
insiders
​

isGroupIdUnsafe(groupChatId): Promise<string | boolean>

🏅May require insiders license

Use this link to get the correct license.

Checks whether or not the group id provided is known to be unsafe by the contributors of the library.

Parameters​

• groupChatId: GroupChatId

The group chat you want to deteremine is unsafe

Returns​

Promise<string | boolean>

Promise <boolean | string> This will either return a boolean indiciating whether this group chat id is considered unsafe or an error message as a string

isPhoneDisconnected()​

isPhoneDisconnected(): Promise<boolean>

Check if the "Phone not Cconnected" message is showing in the browser. If it is showing, then this will return true.

Returns​

Promise<boolean>

boolean

joinGroupViaLink(link, returnChatObj?): Promise<string | number | boolean | Chat>

Joins a group via the invite link, code, or message

Parameters​

• link: string

This param is the string which includes the invite link or code. The following work:

If you have been removed from the group previously, it will return 401

• returnChatObj?: boolean

boolean When this is set to true and if the group was joined successfully, it will return a serialzed Chat object which includes group information and metadata. This is useful when you want to immediately do something with group metadata.

Returns​

Promise<string | number | boolean | Chat>

Promise<string | boolean | number> Either false if it didn't work, or the group id.

joinWebBeta()​

joinWebBeta(join): Promise<boolean>

Join or leave the wa web beta program. Will return true of operation was successful.

Parameters​

• join: boolean

true to join the beta, false to leave

Returns​

Promise<boolean>

keepMessage()​

keepMessage(id, keep): Promise<boolean>

Keep a message inside an ephemeral chat

Parameters​

• id: MessageId

The id of the message

• keep: boolean

Returns​

Promise<boolean>

boolean true: worked

kill()​

kill(reason): Promise<boolean>

Shuts down the page and browser

Parameters​

• reason: string = "MANUALLY_KILLED"

Returns​

Promise<boolean>

true

leaveGroup()​

leaveGroup(groupId): Promise<boolean>

Removes the host device from the group

Parameters​

• groupId: GroupChatId

group id

Returns​

Promise<boolean>

listWebhooks()​

listWebhooks(): Promise<Webhook[]>

Retreives an array of webhook objects

Returns​

Promise<Webhook[]>

loadAllEarlierMessages()​

loadAllEarlierMessages(contactId): Promise<Message[]>

Load all messages in chat object from server.

Parameters​

• contactId: ContactId

Returns​

Promise<Message[]>

Message[]

loadAndGetAllMessagesInChat()​

loadAndGetAllMessagesInChat(chatId, includeMe, includeNotifications): Promise<Message[]>

loads and Retrieves all Messages in a chat

Parameters​

• chatId: ChatId

• includeMe: boolean

• includeNotifications: boolean

Returns​

Promise<Message[]>

any

loadEarlierMessages()​

loadEarlierMessages(contactId): Promise<Message[]>

Load more messages in chat object from server. Use this in a while loop. This should return up to 50 messages at a time

Parameters​

• contactId: ContactId

Returns​

Promise<Message[]>

Message []

loadEarlierMessagesTillDate()​

loadEarlierMessagesTillDate(contactId, timestamp): Promise<Message[]>

Load all messages until a given timestamp in chat object from server.

Parameters​

• contactId: ContactId

• timestamp: number

in seconds

Returns​

Promise<Message[]>

Message[]

logger()​

logger(): any

Grab the logger for this session/process

Returns​

any

logout()​

logout(preserveSessionData): Promise<boolean>

Logs out from the session.

Parameters​

• preserveSessionData: boolean = false

skip session.data.json file invalidation Please be careful when using this as it can exit the whole process depending on your config

Returns​

Promise<boolean>

markAllRead()​

markAllRead(): Promise<boolean>

Runs sendSeen on all chats

Returns​

Promise<boolean>

markAsUnread()​

markAsUnread(chatId): Promise<boolean>

Sets a chat status to unread. May be useful to get host's attention

Parameters​

• chatId: ChatId

chat id: xxxxx@c.us

Returns​

Promise<boolean>

metrics()​

metrics(): Promise<any>

Returns some metrics of the session/page.

Returns​

Promise<any>

Promise<any>

middleware()​

middleware(useSessionIdInPath, PORT?): (req, res, next) => Promise<any>

This exposes a simple express middlware that will allow users to quickly boot up an api based off this client. Checkout demo/index.ts for an example How to use the middleware:


import { create } from '@open-wa/wa-automate';
const express = require('express')
const app = express()
app.use(express.json())
const PORT = 8082;

function start(client){
  app.use(client.middleware()); //or client.middleware(true) if you require the session id to be part of the path (so localhost:8082/sendText beccomes localhost:8082/sessionId/sendText)
  app.listen(PORT, function () {
    console.log(`\n• Listening on port ${PORT}!`);
  });
  ...
}

create({
  sessionId:'session1'
}).then(start)

All requests need to be POST requests. You use the API the same way you would with client. The method can be the path or the method param in the post body. The arguments for the method should be properly ordered in the args array in the JSON post body.

Example:

  await client.sendText('4477777777777@c.us','test')
  //returns "true_4477777777777@c.us_3EB0645E623D91006252"

as a request with a path:

const axios = require('axios').default;
axios.post('localhost:8082/sendText', {
    args: [
       "4477777777777@c.us",    
       "test"    
        ]
  })

or as a request without a path:

const axios = require('axios').default;
axios.post('localhost:8082', {
    method:'sendText',
    args: [
       "4477777777777@c.us",    
       "test"   
        ]
})

As of 1.9.69, you can also send the argyments as an object with the keys mirroring the paramater names of the relative client functions

Example:

const axios = require('axios').default;
axios.post('localhost:8082', {
    method:'sendText',
    args: {
       "to":"4477777777777@c.us",    
       "content":"test"   
        }
})

Parameters​

• useSessionIdInPath: boolean = false

boolean Set this to true if you want to keep each session in it's own path.

For example, if you have a session with id host if you set useSessionIdInPath to true, then all requests will need to be prefixed with the path host. E.g localhost:8082/sendText becomes localhost:8082/host/sendText

• PORT?: number

Returns​

Function

Parameters​

• req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

• res: Response<any, Record<string, any>>

• next: NextFunction

Returns​

Promise<any>

muteChat()
insiders
​

muteChat(chatId, muteDuration): Promise<string | number | boolean>

🏅May require insiders license

Use this link to get the correct license.

Mutes a conversation for a given duration. If already muted, this will update the muted duration. Mute durations are relative from when the method is called.

Parameters​

• chatId: ChatId

The id of the conversation you want to mute

• muteDuration: ChatMuteDuration

ChatMuteDuration enum of the time you want this chat to be muted for.

Returns​

Promise<string | number | boolean>

boolean true: worked or error code or message

onNewProduct()
insiders
​

onNewProduct(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Listens to new orders. Only works on business accounts

Parameters​

• fn

Returns​

Promise<boolean | Listener>

onOrder()
insiders
​

onOrder(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Listens to new orders. Only works on business accounts

Parameters​

• fn

Returns​

Promise<boolean | Listener>

pinChat()​

pinChat(id, pin): Promise<boolean>

Pin/Unpin chats

Parameters​

• id: ChatId

The id of the conversation

• pin: boolean

boolean true => pin, false => unpin

Returns​

Promise<boolean>

boolean true: worked

pinMessage()​

pinMessage(id, pin, pinDuration): Promise<boolean>

Pin/Unpin message

Parameters​

• id: MessageId

The id of the message

• pin: boolean

boolean true => pin, false => unpin

• pinDuration: MessagePinDuration = "ThirtyDays"

The length of time to pin the message. Default ThirtyDays

Returns​

Promise<boolean>

boolean true: worked

postImageStatus()
restricted
​

postImageStatus(data, caption): Promise<string | boolean | MessageId>

🏅May require restricted license

Use this link to get the correct license.

Posts an image story.

Parameters​

• data: DataURL

data url string data:[<MIME-type>][;charset=<encoding>][;base64],<data>

• caption: Content

The caption for the story

Returns​

Promise<string | boolean | MessageId>

Promise<string | boolean> returns status id if it worked, false if it didn't

postTextStatus()
restricted
​

postTextStatus(text, textRgba, backgroundRgba, font): Promise<string | boolean | MessageId>

🏅May require restricted license

Use this link to get the correct license.

Sends a formatted text story.

Parameters​

• text: Content

The text to be displayed in the story

• textRgba: string

The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"

• backgroundRgba: string

The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"

• font: number

The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from: 0: Sans Serif 1: Serif 2: Norican Regular 3: Bryndan Write 4: Bebasneue Regular 5: Oswald Heavy

Returns​

Promise<string | boolean | MessageId>

Promise<string | boolean> returns status id if it worked, false if it didn't

postThumbnailStatus()
restricted
​

postThumbnailStatus(url, text, textRgba, backgroundRgba, font, thumbnail?): Promise<MessageId>

🏅May require restricted license

Use this link to get the correct license.

Sends a formatted text story with a thumbnail.

Parameters​

• url: string

The URL to share in the story

• text: Content

The text to be displayed in the story

• textRgba: string

The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"

• backgroundRgba: string

The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"

• font: number

The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:

• thumbnail?: Base64

base64 thumbnail override, if not provided the link server will try to figure it out. 0: Sans Serif 1: Serif 2: Norican Regular 3: Bryndan Write

Returns​

Promise<MessageId>

Promise<MessageId> returns status id if it worked, false if it didn't

postVideoStatus()
restricted
​

postVideoStatus(data, caption): Promise<string | boolean | MessageId>

🏅May require restricted license

Use this link to get the correct license.

Posts a video story.

Parameters​

• data: DataURL

data url string data:[<MIME-type>][;charset=<encoding>][;base64],<data>

• caption: Content

The caption for the story

Returns​

Promise<string | boolean | MessageId>

Promise<string | boolean> returns status id if it worked, false if it didn't

prepEventData()​

prepEventData(data, event, extras?): EventPayload

Parameters​

• data: JsonObject

• event: SimpleListener

• extras?: JsonObject

Returns​

EventPayload

promoteParticipant()​

promoteParticipant(groupId, participantId): Promise<boolean>

Promote Participant to Admin in Group

If not a group chat, returns NOT_A_GROUP_CHAT.

If the chat does not exist, returns GROUP_DOES_NOT_EXIST

If the participantId does not exist in the group chat, returns NOT_A_PARTICIPANT

If the host account is not an administrator, returns INSUFFICIENT_PERMISSIONS

Parameters​

• groupId: GroupChatId

'0000000000-00000000@g.us'

• participantId: ContactId | ContactId[]

'000000000000@c.us'

Returns​

Promise<boolean>

react()​

react(messageId, emoji): Promise<boolean>

React to a message

Parameters​

• messageId: MessageId

Message ID of the message you want to react to

• emoji: string

1 single emoji to add to the message as a reacion

Returns​

Promise<boolean>

boolean

refresh()​

refresh(): Promise<boolean>

Refreshes the page and reinjects all necessary files. This may be useful for when trying to save memory This will attempt to re register all listeners EXCEPT onLiveLocation and onParticipantChanged

Returns​

Promise<boolean>

registerWebhook()​

registerWebhook(url, events, requestConfig, concurrency): Promise<false | Webhook>

The client can now automatically handle webhooks. Use this method to register webhooks.

Parameters​

• url: string

The webhook url

• events: SimpleListener[] | "all"

An array of [[SimpleListener]] enums or all (to register all possible listeners)

• requestConfig: AxiosRequestConfig<any> = {}

By default the request is a post request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config

• concurrency: number = 5

the amount of concurrent requests to be handled by the built in queue. Default is 5.

Returns​

Promise<false | Webhook>

A webhook object. This will include a webhook ID and an array of all successfully registered Listeners.

rejectGroupJoinRequest()​

rejectGroupJoinRequest(groupChatId, contactId): Promise<string | boolean>

Rejects a group join request *

Parameters​

• groupChatId: GroupChatId

The group chat id *

• contactId: ContactId

The contact id of the person who is requesting to join the group *

Returns​

Promise<string | boolean>

Promise<boolean>

removeAllListeners()​

removeAllListeners(): boolean

Returns​

boolean

removeLabel()​

removeLabel(label, chatId): Promise<boolean>

Removes label from chat, message or contact. Only for business accounts.

Parameters​

• label: string

• chatId: ChatId

Returns​

Promise<boolean>

removeListener()​

removeListener(listener): boolean

//////////////////////// LISTENERS

Parameters​

• listener: SimpleListener

Returns​

boolean

removeParticipant()​

removeParticipant(groupId, participantId): Promise<boolean>

Remove participant of Group

If not a group chat, returns NOT_A_GROUP_CHAT.

If the chat does not exist, returns GROUP_DOES_NOT_EXIST

If the participantId does not exist in the group chat, returns NOT_A_PARTICIPANT

If the host account is not an administrator, returns INSUFFICIENT_PERMISSIONS

Parameters​

• groupId: GroupChatId

0000000000-00000000@g.us

• participantId: ContactId

000000000000@c.us

Returns​

Promise<boolean>

removeProduct()​

removeProduct(productId): Promise<boolean>

Remove a product from the host account's catalog

Parameters​

• productId: string

The id of the product

Returns​

Promise<boolean>

boolean

removeWebhook()​

removeWebhook(webhookId): Promise<boolean>

Removes a webhook.

Returns true if the webhook was found and removed. false if the webhook was not found and therefore could not be removed. This does not unregister any listeners off of other webhooks.

Parameters​

• webhookId: string

The ID of the webhook

Returns​

Promise<boolean>

Retruns​

boolean

reply()​

reply(to, content, quotedMsgId, sendSeen?): Promise<boolean | MessageId>

Sends a reply to a given message. Please note, you need to have at least sent one normal message to a contact in order for this to work properly.

Parameters​

• to: ChatId

string chatid

• content: Content

string reply text

• quotedMsgId: MessageId

string the msg id to reply to.

• sendSeen?: boolean

boolean If set to true, the chat will 'blue tick' all messages before sending the reply

Returns​

Promise<boolean | MessageId>

Promise<MessageId | false> false if didn't work, otherwise returns message id.

reportSpam()
restricted
​

reportSpam(id): Promise<boolean>

🏅May require restricted license

Use this link to get the correct license.

Report a contact for spam, block them and attempt to clear chat.

Parameters​

• id: ChatId

'000000000000@c.us'

Returns​

Promise<boolean>

resizePage()​

resizePage(width, height): Promise<boolean>

Easily resize page on the fly. Useful if you're showing screenshots in a web-app.

Parameters​

• width: number = 1920

• height: number = 1080

Returns​

Promise<boolean>

revokeGroupInviteLink(chatId): Promise<string | boolean>

Revokes the current invite link for a group chat. Any previous links will stop working

Parameters​

• chatId: ChatId

Returns​

Promise<string | boolean>

Promise<boolean>

sendAdvancedButtons()​

sendAdvancedButtons(to, body, buttons, text, footer, filename): Promise<boolean | MessageId>

Parameters​

• to: ChatId

chat id

• body: string | LocationButtonBody

The body of the buttons message

• buttons: AdvancedButton[]

Array of buttons - limit is 3!

• text: string

• footer: string

The footer of the buttons message

• filename: string

Required if body is a file!!

Returns​

Promise<boolean | MessageId>

Deprecated​

danger

Template messages (URL & CALL buttons) are broken for the foreseeable future. Please DO NOT get a license solely for access to URL or CALL buttons. They are no longer reliable due to recent changes at WA. WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.

THIS IS NOT WORKING FOR GROUPS YET.

ADVANCED ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS.

Send advanced buttons with media body. This is an insiders feature for MD accounts.

Body can be location, image, video or document. Buttons can be quick reply, url or call buttons.

sendAudio()​

sendAudio(to, file, quotedMsgId?): Promise<MessageId>

Send an audio file with the default audio player (not PTT/voice message)

Parameters​

• to: ChatId

chat id xxxxx@c.us

• file: AdvancedFile

• quotedMsgId?: MessageId

string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message

Returns​

Promise<MessageId>

sendBanner()​

sendBanner(to, base64): Promise<boolean | MessageId>

Send a banner image

Note this is a bit of hack on top of a location message. During testing it is shown to not work on iPhones.

Parameters​

• to: ChatId

• base64: Base64

base64 encoded jpeg

Returns​

Promise<boolean | MessageId>

sendButtons()​

sendButtons(to, body, buttons, title?, footer?): Promise<boolean | MessageId>

Parameters​

• to: ChatId

chat id

• body: string | LocationButtonBody

The body of the buttons message

• buttons: Button[]

Array of buttons - limit is 3!

• title?: string

The title/header of the buttons message

• footer?: string

The footer of the buttons message

Returns​

Promise<boolean | MessageId>

Deprecated​

danger

WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts. THIS IS NOT WORKING FOR GROUPS YET.

BUTTONS ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS.

Send generic quick reply buttons. This is an insiders feature for MD accounts.

sendContact()​

sendContact(to, contactId): Promise<boolean | MessageId>

Sends contact card to given chat id. You can use this to send multiple contacts but they will show up as multiple single-contact messages.

Parameters​

• to: ChatId

'xxxx@c.us'

• contactId: ContactId | ContactId[]

Returns​

Promise<boolean | MessageId>

sendCustomProduct()​

sendCustomProduct(to, image, productData): Promise<boolean | MessageId>

Parameters​

• to: ChatId

• image: DataURL

• productData: CustomProduct

Returns​

Promise<boolean | MessageId>

Deprecated​

Feature Currently only available with Premium License accounts.

Send a custom product to a chat. Please see [[CustomProduct]] for details.

Caveats:

  • URL will not work (unable to click), you will have to send another message with the URL.
  • Recipient will see a thin banner under picture that says "Something went wrong"
  • This will only work if you have at least 1 product already in your catalog
  • Only works on Business accounts

sendEmoji()​

sendEmoji(to, emojiId, messageId?): Promise<string | boolean | MessageId>

Send a discord emoji to a chat as a sticker

Parameters​

• to: ChatId

ChatId The chat id you want to send the webp sticker to

• emojiId: string

The discord emoji id without indentifying chars. In discord you would write :who:, here use who

• messageId?: MessageId

message id of the message you want this sticker to reply to. @license:insiders@

Returns​

Promise<string | boolean | MessageId>

sendFavSticker()​

sendFavSticker(chatId, favId): Promise<MessageId>

Set/Unset a sticker as a fav.

Parameters​

• chatId: ChatId

The chat in which you want to send the sticker

• favId: string

set this to true to favourite a sticker, set it to false to remove the sticker from favorites

Returns​

Promise<MessageId>

MessageId of the sent sticker message

sendFile()​

sendFile(to, file, filename, caption, quotedMsgId?, waitForId?, ptt?, withoutPreview?, hideTags?, viewOnce?, requestConfig?): Promise<boolean | MessageId>

Sends a file to given chat, with caption or not, using base64. This is exactly the same as sendImage

Please note that any file that resolves to mime-type octet-stream will, by default, resolve to an MP4 file.

If you want a specific filetype, then explcitly select the correct mime-type from https://www.iana.org/assignments/media-types/media-types.xhtml

Parameters​

• to: ChatId

chat id xxxxx@c.us

• file: AdvancedFile

DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ./ or ../) path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg).

• filename: string

string xxxxx

• caption: Content

string xxxxx With an INSIDERS LICENSE-KEY you can also tag people in groups with @[number]. For example if you want to mention the user with the number 44771234567, just add @44771234567 in the caption.

• quotedMsgId?: MessageId

string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message

• waitForId?: boolean

boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.

• ptt?: boolean

boolean default: false set this to true if you want to send the file as a push to talk file.

• withoutPreview?: boolean

boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.

• hideTags?: boolean

boolean default: false [INSIDERS] set this to try silent tag someone in the caption

• viewOnce?: boolean

• requestConfig?: any

Returns​

Promise<boolean | MessageId>

Promise <boolean | MessageId> This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true

sendFileFromUrl()​

sendFileFromUrl(to, url, filename, caption, quotedMsgId?, requestConfig?, waitForId?, ptt?, withoutPreview?, hideTags?, viewOnce?): Promise<boolean | MessageId>

Sends a file by Url or custom options

Parameters​

• to: ChatId

chat id xxxxx@c.us

• url: string

string https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4

• filename: string

string 'video.mp4'

• caption: Content

string xxxxx

• quotedMsgId?: MessageId

string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message

• requestConfig?: AxiosRequestConfig<any> = {}

By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config

• waitForId?: boolean

boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.

• ptt?: boolean

boolean default: false set this to true if you want to send the file as a push to talk file.

• withoutPreview?: boolean

boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.

• hideTags?: boolean

• viewOnce?: boolean

Returns​

Promise<boolean | MessageId>

sendGiphy()​

sendGiphy(to, giphyMediaUrl, caption): Promise<MessageId>

Sends a video to given chat as a gif by using a giphy link, with caption or not, using base64

Parameters​

• to: ChatId

chat id xxxxx@c.us

• giphyMediaUrl: string

string https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif => https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4

• caption: Content

string xxxxx

Returns​

Promise<MessageId>

sendGiphyAsSticker()​

sendGiphyAsSticker(to, giphyMediaUrl): Promise<string | boolean | MessageId>

Send a giphy GIF as an animated sticker.

Parameters​

• to: ChatId

ChatId

• giphyMediaUrl: string | URL

URL | string This is the giphy media url and has to be in the format https://media.giphy.com/media/RJKHjCAdsAfQPn03qQ/source.gif or it can be just the id RJKHjCAdsAfQPn03qQ

Returns​

Promise<string | boolean | MessageId>

sendImage()​

sendImage(to, file, filename, caption, quotedMsgId?, waitForId?, ptt?, withoutPreview?, hideTags?, viewOnce?, requestConfig?): Promise<boolean | MessageId>

Sends a image to given chat, with caption or not, using base64

Parameters​

• to: ChatId

chat id xxxxx@c.us

• file: AdvancedFile

DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ./ or ../) path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg).

• filename: string

string xxxxx

• caption: Content

string xxxxx

• quotedMsgId?: MessageId

• waitForId?: boolean

• ptt?: boolean

• withoutPreview?: boolean

• hideTags?: boolean

boolean default: false [INSIDERS] set this to try silent tag someone in the caption

• viewOnce?: boolean

• requestConfig?: any

Returns​

Promise<boolean | MessageId>

Promise <boolean | string> This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true

sendImageAsSticker()​

sendImageAsSticker(to, image, stickerMetadata?): Promise<string | boolean | MessageId>

This function takes an image (including animated GIF) and sends it as a sticker to the recipient. This is helpful for sending semi-ephemeral things like QR codes. The advantage is that it will not show up in the recipients gallery. This function automatiicaly converts images to the required webp format.

Parameters​

• to: ChatId

• image: string | Base64 | DataURL | Buffer

• stickerMetadata?: StickerMetadata

Returns​

Promise<string | boolean | MessageId>

sendImageAsStickerAsReply()
insiders
​

sendImageAsStickerAsReply(to, image, messageId, stickerMetadata?): Promise<string | boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

This function takes an image and sends it as a sticker to the recipient as a reply to another message.

Parameters​

• to: ChatId

The recipient id.

• image: string | Base64 | DataURL | Buffer

• messageId: MessageId

The id of the message to reply to

• stickerMetadata?: StickerMetadata

Sticker metadata

Returns​

Promise<string | boolean | MessageId>

sendImageWithProduct()​

sendImageWithProduct(to, image, caption, bizNumber, productId): Promise<boolean | MessageId>

Sends product with image to chat

Parameters​

• to: ChatId

• image: Base64

• caption: Content

string the caption you want to add to this message

• bizNumber: ContactId

string the @c.us number of the business account from which you want to grab the product

• productId: string

string the id of the product within the main catalog of the aforementioned business

Returns​

Promise<boolean | MessageId>

sendLinkWithAutoPreview()​

sendLinkWithAutoPreview(to, url, text?, thumbnail?, quotedMsgId?, customSize?): Promise<boolean | MessageId>

Automatically sends a link with the auto generated link preview. You can also add a custom message.

Parameters​

• to: ChatId

• url: string

string A link.

• text?: Content

string Custom text as body of the message, this needs to include the link or it will be appended after the link.

• thumbnail?: Base64

Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.

• quotedMsgId?: MessageId

[INSIDERS] Send this link preview message in response to a given quoted message

• customSize?

[INSIDERS] Anchor the size of the thumbnail

• customSize.height?: number

• customSize.width?: number

Returns​

Promise<boolean | MessageId>

sendListMessage()​

sendListMessage(to, sections, title, description, actionText): Promise<boolean | MessageId>

Parameters​

• to: ChatId

• sections: Section[]

The Sections of rows for the list message

• title: string

The title of the list message

• description: string

The description of the list message

• actionText: string

The action text of the list message

Returns​

Promise<boolean | MessageId>

Deprecated​

danger

It is not currently possible to send a listmessage to a group chat. This is a WA limitation. Please DO NOT get a license solely for access to list messages in group chats.

LIST MESSAGES ARE DEPRECATED TILL FURTHER NOTICE

Send a list message. This will not work when being sent from business accounts!

sendLocation()​

sendLocation(to, lat, lng, loc, address?, url?): Promise<boolean | MessageId>

Note: address and url are parameters available to insiders only.

Sends a location message to given chat

Parameters​

• to: ChatId

chat id: xxxxx@c.us

• lat: string

latitude: '51.5074'

• lng: string

longitude: '0.1278'

• loc: string

location text: 'LONDON!'

• address?: string

address text: '1 Regents Park!'

• url?: string

address text link: 'https://example.com'

Returns​

Promise<boolean | MessageId>

sendMessageWithThumb()​

sendMessageWithThumb(thumb, url, title, description, text, chatId, quotedMsgId?, customSize?): Promise<boolean | MessageId>

Sends a link to a chat that includes a link preview.

Parameters​

• thumb: string

The base 64 data of the image you want to use as the thunbnail. This should be no more than 200x200px. Note: Dont need data url on this param

• url: string

The link you want to send

• title: string

The title of the link

• description: string

The long description of the link preview

• text: Content

The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically.

• chatId: ChatId

The chat you want to send this message to.

• quotedMsgId?: MessageId

[INSIDERS] Send this link preview message in response to a given quoted message

• customSize?

[INSIDERS] Anchor the size of the thumbnail

• customSize.height?: number

• customSize.width?: number

Returns​

Promise<boolean | MessageId>

sendMp4AsSticker()​

sendMp4AsSticker(to, file, processOptions, stickerMetadata?, messageId?): Promise<string | boolean | MessageId>

Use this to send an mp4 file as a sticker. This can also be used to convert GIFs from the chat because GIFs in WA are actually tiny mp4 files.

Parameters​

• to: ChatId

ChatId The chat id you want to send the webp sticker to

• file: string | Base64 | DataURL | Buffer

[[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the mp4 file

• processOptions: Mp4StickerConversionProcessOptions = defaultProcessOptions

• stickerMetadata?: StickerMetadata

• messageId?: MessageId

message id of the message you want this sticker to reply to. @license:insiders@

Returns​

Promise<string | boolean | MessageId>

sendMultipleContacts()
insiders
​

sendMultipleContacts(to, contactIds): Promise<boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

Sends multiple contacts as a single message

Parameters​

• to: ChatId

'xxxx@c.us'

• contactIds: ContactId[]

Returns​

Promise<boolean | MessageId>

sendPaymentRequest()​

sendPaymentRequest(to, amount, currency, message?): Promise<boolean | MessageId>

[UNTESTED - REQUIRES FEEDBACK] Sends a payment request message to given chat

Parameters​

• to: ChatId

chat id: xxxxx@c.us

• amount: number

number the amount to request in 1000 format (e.g £10 => 10000)

• currency: string

string The 3 letter currency code

• message?: string

string optional message to send with the payment request

Returns​

Promise<boolean | MessageId>

sendPoll()​

sendPoll(to, name, options, quotedMsgId?, allowMultiSelect?): Promise<MessageId>

Send a poll to a group chat

Parameters​

• to: GroupChatId

chat id - a group chat is required

• name: string

the name of the poll

• options: string[]

an array of poll options

• quotedMsgId?: MessageId

A message to quote when sending the poll

• allowMultiSelect?: boolean

Whether or not to allow multiple selections. default false

Returns​

Promise<MessageId>

sendProduct()
insiders
​

sendProduct(chatId, productId): Promise<MessageId>

🏅May require insiders license

Use this link to get the correct license.

Send a product to a chat

Parameters​

• chatId: ChatId

The chatId

• productId: string

The id of the product

Returns​

Promise<MessageId>

MessageID

sendPtt()​

sendPtt(to, file, quotedMsgId?): Promise<MessageId>

Attempts to send a file as a voice note. Useful if you want to send an mp3 file.

Parameters​

• to: ChatId

chat id xxxxx@c.us

• file: AdvancedFile

base64 data:image/xxx;base64,xxx or the path of the file you want to send.

• quotedMsgId?: MessageId

string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message

Returns​

Promise<MessageId>

Promise <boolean | string> This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true

sendRawWebpAsSticker()​

sendRawWebpAsSticker(to, webpBase64, animated): Promise<string | boolean | MessageId>

You can use this to send a raw webp file.

Parameters​

• to: ChatId

ChatId The chat id you want to send the webp sticker to

• webpBase64: Base64

Base64 The base64 string of the webp file. Not DataURl

• animated: boolean = false

Boolean Set to true if the webp is animated. Default false

Returns​

Promise<string | boolean | MessageId>

sendRawWebpAsStickerAsReply()
insiders
​

sendRawWebpAsStickerAsReply(to, messageId, webpBase64, animated): Promise<string | boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

You can use this to send a raw webp file.

Parameters​

• to: ChatId

ChatId The chat id you want to send the webp sticker to

• messageId: MessageId

MessageId Message ID of the message to reply to

• webpBase64: Base64

Base64 The base64 string of the webp file. Not DataURl

• animated: boolean = false

Boolean Set to true if the webp is animated. Default false

Returns​

Promise<string | boolean | MessageId>

sendReplyWithMentions()​

sendReplyWithMentions(to, content, replyMessageId, hideTags?, mentions?): Promise<boolean | MessageId>

Sends a reply to given chat that includes mentions, replying to the provided replyMessageId. In order to use this method correctly you will need to send the text like this: "@4474747474747 how are you?" Basically, add a @ symbol before the number of the contact you want to mention.

Parameters​

• to: ChatId

chat id: xxxxx@c.us

• content: Content

text message

• replyMessageId: MessageId

id of message to reply to

• hideTags?: boolean

Removes all tags within the message

• mentions?: ContactId[]

You can optionally add an array of contact IDs to tag only specific people

Returns​

Promise<boolean | MessageId>

sendSeen()​

sendSeen(chatId): Promise<boolean>

Sets a chat status to seen. Marks all messages as ack: 3

Parameters​

• chatId: ChatId

chat id: xxxxx@c.us

Returns​

Promise<boolean>

sendStickerfromUrl()​

sendStickerfromUrl(to, url, requestConfig, stickerMetadata?): Promise<string | boolean | MessageId>

Sends a sticker (including GIF) from a given URL

Parameters​

• to: ChatId

• url: string

• requestConfig: AxiosRequestConfig<any> = {}

By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config

• stickerMetadata?: StickerMetadata

Returns​

Promise<string | boolean | MessageId>

Promise<MessageId | boolean>

sendStickerfromUrlAsReply()
insiders
​

sendStickerfromUrlAsReply(to, url, messageId, requestConfig, stickerMetadata?): Promise<boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

Sends a sticker from a given URL

Parameters​

• to: ChatId

The recipient id.

• url: string

The url of the image

• messageId: MessageId

The id of the message to reply to

• requestConfig: AxiosRequestConfig<any> = {}

By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config

• stickerMetadata?: StickerMetadata

Returns​

Promise<boolean | MessageId>

Promise<MessageId | boolean>

sendText()
restricted
​

sendText(to, content): Promise<boolean | MessageId>

🏅May require restricted license

Use this link to get the correct license.

Sends a text message to given chat

A license is NOT required to send messages with existing chats/contacts. A license is only required for starting conversations with new numbers.

Parameters​

• to: ChatId

chat id: xxxxx@c.us

• content: Content

text message

Returns​

Promise<boolean | MessageId>

sendTextWithMentions()​

sendTextWithMentions(to, content, hideTags?, mentions?): Promise<boolean | MessageId>

Sends a text message to given chat that includes mentions. In order to use this method correctly you will need to send the text like this: "@4474747474747 how are you?" Basically, add a @ symbol before the number of the contact you want to mention.

Parameters​

• to: ChatId

chat id: xxxxx@c.us

• content: Content

text message

• hideTags?: boolean

Removes all tags within the message

• mentions?: ContactId[]

You can optionally add an array of contact IDs to tag only specific people

Returns​

Promise<boolean | MessageId>

sendVCard()​

sendVCard(chatId, vcard, contactName?, contactNumber?): Promise<boolean>

Send VCARD

Parameters​

• chatId: ChatId

'000000000000@c.us'

• vcard: string

vcard as a string, you can send multiple contacts vcard also.

• contactName?: string

The display name for the contact. Ignored on multiple vcards

• contactNumber?: string

If supplied, this will be injected into the vcard (VERSION 3 ONLY FROM VCARDJS) with the WA id to make it show up with the correct buttons on WA. The format of this param should be including country code, without any other formating. e.g: 4477777777777 Ignored on multiple vcards

Returns​

Promise<boolean>

sendVideoAsGif()​

sendVideoAsGif(to, file, filename, caption, quotedMsgId?, requestConfig?): Promise<MessageId>

Sends a video to given chat as a gif, with caption or not, using base64

Parameters​

• to: ChatId

chat id xxxxx@c.us

• file: AdvancedFile

DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with ./ or ../) path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg).

• filename: string

string xxxxx

• caption: Content

string xxxxx

• quotedMsgId?: MessageId

string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message

• requestConfig?: AxiosRequestConfig<any> = {}

By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config

Returns​

Promise<MessageId>

sendYoutubeLink(to, url, text, thumbnail?, quotedMsgId?, customSize?): Promise<boolean | MessageId>

Automatically sends a youtube link with the auto generated link preview. You can also add a custom message.

Parameters​

• to: ChatId

• url: string

string A youtube link.

• text: Content = ''

string Custom text as body of the message, this needs to include the link or it will be appended after the link.

• thumbnail?: Base64

string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.

• quotedMsgId?: MessageId

[INSIDERS] Send this link preview message in response to a given quoted message

• customSize?

[INSIDERS] Anchor the size of the thumbnail

• customSize.height?: number

• customSize.width?: number

Returns​

Promise<boolean | MessageId>

setChatBackgroundColourHex()
insiders
​

setChatBackgroundColourHex(hex): Promise<boolean>

🏅May require insiders license

Use this link to get the correct license.

Set the wallpaper background colour

Parameters​

• hex: string

'#FFF123'

Returns​

Promise<boolean>

setChatEphemeral()
insiders
​

setChatEphemeral(chatId, ephemeral): Promise<boolean>

🏅May require insiders license

Use this link to get the correct license.

Turn the ephemeral setting in a chat to on or off

Parameters​

• chatId: ChatId

The ID of the chat

• ephemeral: boolean | EphemeralDuration

true to turn on the ephemeral setting to 1 day, false to turn off the ephemeral setting. Other options: 604800 | 7776000

Returns​

Promise<boolean>

Promise<boolean> true if the setting was set, false if the chat does not exist

setChatState()​

setChatState(chatState, chatId): Promise<boolean>

Sets the chat state

Parameters​

• chatState: ChatState

The state you want to set for the chat. Can be TYPING (0), RECRDING (1) or PAUSED (2).

• chatId: ChatId

Returns​

Promise<boolean>

setGroupApprovalMode()​

setGroupApprovalMode(groupId, requireApproval): Promise<boolean>

Turn on or off the approval requirement for new members to join a group

Parameters​

• groupId: GroupChatId

'0000000000-00000000@g.us' the group id.

• requireApproval: boolean

set to true to turn on the approval requirement, false to turn off

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupDescription()​

setGroupDescription(groupId, description): Promise<boolean>

Change the group chant description

Parameters​

• groupId: GroupChatId

'0000000000-00000000@g.us' the group id.

• description: string

string The new group description

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupEditToAdminsOnly()​

setGroupEditToAdminsOnly(groupId, onlyAdmins): Promise<boolean>

Change who can and cannot edit a groups details

Parameters​

• groupId: GroupChatId

'0000000000-00000000@g.us' the group id.

• onlyAdmins: boolean

boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupIcon()​

setGroupIcon(groupId, image): Promise<boolean>

Change the icon for the group chat

Parameters​

• groupId: GroupChatId

123123123123_1312313123@g.us The id of the group

• image: DataURL

Returns​

Promise<boolean>

boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big.

setGroupIconByUrl()​

setGroupIconByUrl(groupId, url, requestConfig): Promise<boolean>

Change the icon for the group chat

Parameters​

• groupId: GroupChatId

123123123123_1312313123@g.us The id of the group

• url: string

• requestConfig: AxiosRequestConfig<any> = {}

By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config

Returns​

Promise<boolean>

boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big.

setGroupTitle()
insiders
​

setGroupTitle(groupId, title): Promise<boolean>

🏅May require insiders license

Use this link to get the correct license.

Change the group chat title

Parameters​

• groupId: GroupChatId

'0000000000-00000000@g.us' the group id.

• title: string

string The new group title

Returns​

Promise<boolean>

boolean true if action completed successfully.

setGroupToAdminsOnly()​

setGroupToAdminsOnly(groupId, onlyAdmins): Promise<boolean>

Change who can and cannot speak in a group

Parameters​

• groupId: GroupChatId

'0000000000-00000000@g.us' the group id.

• onlyAdmins: boolean

boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group

Returns​

Promise<boolean>

boolean true if action completed successfully.

setMyName()​

setMyName(newName): Promise<boolean>

Set your profile name

Please note, this does not work on business accounts!

Parameters​

• newName: string

String new name to set for your profile

Returns​

Promise<boolean>

setMyStatus()​

setMyStatus(newStatus): Promise<boolean | void>

set your about me

Parameters​

• newStatus: string

String new profile status

Returns​

Promise<boolean | void>

setPresence()​

setPresence(available): Promise<boolean | void>

Set presence to available or unavailable.

Parameters​

• available: boolean

if true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);

Returns​

Promise<boolean | void>

setProfilePic()​

setProfilePic(data): Promise<boolean>

Sets the profile pic of the host number.

Parameters​

• data: DataURL

string data url image string.

Returns​

Promise<boolean>

Promise<boolean> success if true

simulateRecording()​

simulateRecording(to, on): Promise<boolean>

Simulate '...recording' in chat

Parameters​

• to: ChatId

'xxxx@c.us'

• on: boolean

turn on similated recording, false to turn it off you need to manually turn this off.

Returns​

Promise<boolean>

simulateTyping()​

simulateTyping(to, on): Promise<boolean>

Simulate '...typing' in chat

Parameters​

• to: ChatId

'xxxx@c.us'

• on: boolean

turn on similated typing, false to turn it off you need to manually turn this off.

Returns​

Promise<boolean>

starMessage()​

starMessage(messageId): Promise<boolean>

Star a message

Parameters​

• messageId: MessageId

Message ID of the message you want to star

Returns​

Promise<boolean>

true

syncContacts()​

syncContacts(): Promise<boolean>

Syncs contacts with phone. This promise does not resolve so it will instantly return true.

Returns​

Promise<boolean>

tagEveryone()
insiders
​

tagEveryone(groupId, content, hideTags?, formatting?, messageBeforeTags?): Promise<boolean | MessageId>

🏅May require insiders license

Use this link to get the correct license.

Tags everyone in the group with a message

Parameters​

• groupId: GroupChatId

group chat id: xxxxx@g.us

• content: Content

text message to add under all of the tags

• hideTags?: boolean

Removes all tags within the message

• formatting?: string

The formatting of the tags. Use

• messageBeforeTags?: boolean

set to true to show the message before all of the tags

Returns​

Promise<boolean | MessageId>

Promise<MessageId>

Mention​

to indicate the actual tag.

Default​

@mention

testButtons()​

testButtons(chatId): Promise<any>

Parameters​

• chatId: ChatId

Returns​

Promise<any>

Deprecated​

danger

Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.

Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658

testCallback()​

testCallback(callbackToTest, testData): Promise<boolean>

Use this simple command to test firing callback events.

Parameters​

• callbackToTest: SimpleListener

• testData: any

Returns​

Promise<boolean>

false if the callback was not registered/does not exist

unmuteChat()
insiders
​

unmuteChat(chatId): Promise<string | number | boolean>

🏅May require insiders license

Use this link to get the correct license.

Unmutes a conversation.

Parameters​

• chatId: ChatId

Returns​

Promise<string | number | boolean>

boolean true: worked or error code or message

unstarMessage()​

unstarMessage(messageId): Promise<boolean>

Unstar a message

Parameters​

• messageId: MessageId

Message ID of the message you want to unstar

Returns​

Promise<boolean>

true

updateWebhook()​

updateWebhook(webhookId, events): Promise<false | Webhook>

Update registered events for a specific webhook. This will override all existing events. If you'd like to remove all listeners from a webhook, consider using [[removeWebhook]].

In order to update authentication details for a webhook, remove it completely and then reregister it with the correct credentials.

Parameters​

• webhookId: string

• events: SimpleListener[] | "all"

Returns​

Promise<false | Webhook>

waitAllQEmpty()​

waitAllQEmpty(): Promise<true | void[]>

Wait for all queues to be empty

Returns​

Promise<true | void[]>

waitWhQIdle()​

waitWhQIdle(): Promise<true | void>

Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process.

Returns​

Promise<true | void>

Events​

onAck()​

onAck(fn): Promise<boolean | Listener>

Listens to messages acknowledgement Changes

Parameters​

• fn

callback function that handles a [[Message]] as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onAddedToGroup()​

onAddedToGroup(fn): Promise<boolean | Listener>

Fires callback with Chat object every time the host phone is added to a group.

Parameters​

• fn

callback function that handles a [[Chat]] (group chat) as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onAnyMessage()​

onAnyMessage(fn, queueOptions?): Promise<boolean | Listener>

Listens to all new messages

Parameters​

• fn

callback

• queueOptions?: Options<PriorityQueue, DefaultAddOptions>

PQueue options. Set to {} for default PQueue.

Returns​

Promise<boolean | Listener>

Fires​

[[Message]]

onBattery()​

onBattery(fn): Promise<boolean | Listener>

Parameters​

• fn

callback

Returns​

Promise<boolean | Listener>

Deprecated​

Listens to battery changes

caution

This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers.

Fires​

number

onBroadcast()​

onBroadcast(fn): Promise<boolean | Listener>

Listens to broadcast messages

Parameters​

• fn

callback

Returns​

Promise<boolean | Listener>

Fires​

[[Message]]

onButton()​

onButton(fn): Promise<boolean | Listener>

Listens to button message responses

Parameters​

• fn

callback

Returns​

Promise<boolean | Listener>

Fires​

[[Message]]

onCallState()​

onCallState(fn): Promise<boolean | Listener>

Listens to changes on call state

Parameters​

• fn

Returns​

Promise<boolean | Listener>

Observable stream of call objects

onChatDeleted()​

onChatDeleted(fn): Promise<boolean | Listener>

Listens to when a chat is deleted by the host account

Parameters​

• fn

callback

Returns​

Promise<boolean | Listener>

Fires​

[[Chat]]

onChatOpened()
insiders
​

onChatOpened(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode.

Parameters​

• fn

callback function that handles a [[ChatId]] as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onChatState()
insiders
​

onChatState(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Listens to chat state, including when a specific user is recording and typing within a group chat.

Here is an example of the fired object:

Parameters​

• fn

Returns​

Promise<boolean | Listener>

Fires​

{
"chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring
"user": "22222222222@c.us", //the user that is causing this state
"state": "composing, //can also be 'available', 'unavailable', 'recording' or 'composing'
}

onContactAdded()
insiders
​

onContactAdded(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Fires callback with contact id when a new contact is added on the host phone.

Parameters​

• fn

callback function that handles a [[Chat]] as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onGlobalParticipantsChanged()​

onGlobalParticipantsChanged(fn): Promise<boolean | Listener>

Listens to add and remove events on Groups on a global level. It is memory efficient and doesn't require a specific group id to listen to.

Parameters​

• fn

callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onGroupApprovalRequest()​

onGroupApprovalRequest(fn): Promise<boolean | Listener>

Listents to group approval requests. Emits a message object. Use it with message.isGroupApprovalRequest() to check if it is a group approval request.

Parameters​

• fn

callback function that handles a [[Message]] as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onGroupChange()​

onGroupChange(fn): Promise<boolean | Listener>

Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed.

Parameters​

• fn

callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onIncomingCall()​

onIncomingCall(fn): Promise<boolean | Listener>

Listens to new incoming calls

Parameters​

• fn

Returns​

Promise<boolean | Listener>

Observable stream of call request objects

onLabel()​

onLabel(fn): Promise<boolean | Listener>

Listens to label change events

Parameters​

• fn

callback

Returns​

Promise<boolean | Listener>

Fires​

[[Label]]

onLiveLocation()​

onLiveLocation(chatId, fn): Promise<boolean>

Listens to live locations from a chat that already has valid live locations

Parameters​

• chatId: ChatId

the chat from which you want to subscribes to live location updates

• fn

callback that takes in a LiveLocationChangedEvent

Returns​

Promise<boolean>

boolean, if returns false then there were no valid live locations in the chat of chatId

Emits​

<LiveLocationChangedEvent> LiveLocationChangedEvent

onLogout()​

onLogout(fn, priority?): Promise<boolean>

Listens to a log out event

Parameters​

• fn

callback

• priority?: number

A priority of -1 will mean the callback will be triggered after all the non -1 callbacks

Returns​

Promise<boolean>

Fires​

true

onMessage()​

onMessage(fn, queueOptions?): Promise<boolean | Listener>

Listens to incoming messages

Parameters​

• fn

callback

• queueOptions?: Options<PriorityQueue, DefaultAddOptions>

PQueue options. Set to {} for default PQueue.

Returns​

Promise<boolean | Listener>

Fires​

[[Message]]

onMessageDeleted()​

onMessageDeleted(fn): Promise<boolean | Listener>

Listens to when a message is deleted by a recipient or the host account

Parameters​

• fn

callback

Returns​

Promise<boolean | Listener>

Fires​

[[Message]]

onParticipantsChanged()​

onParticipantsChanged(groupId, fn, legacy): Promise<boolean | Listener>

Listens to add and remove events on Groups. This can no longer determine who commited the action and only reports the following events add, remove, promote, demote

Parameters​

• groupId: GroupChatId

group id: xxxxx-yyyy@c.us

• fn

callback

• legacy: boolean = false

Returns​

Promise<boolean | Listener>

Observable stream of participantChangedEvent

onPlugged()​

onPlugged(fn): Promise<boolean | Listener>

Listens to when host device is plugged/unplugged

Parameters​

• fn

callback

Returns​

Promise<boolean | Listener>

Fires​

boolean true if plugged, false if unplugged

onPollVote()​

onPollVote(fn): Promise<boolean | Listener>

Listens to poll vote events

Parameters​

• fn

callback

Returns​

Promise<boolean | Listener>

Fires​

[[PollData]]

onReaction()
insiders
​

onReaction(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Listens to reaction add and change events

Parameters​

• fn

callback

Returns​

Promise<boolean | Listener>

Fires​

[[ReactionEvent]]

onRemovedFromGroup()
insiders
​

onRemovedFromGroup(fn): Promise<boolean | Listener>

🏅May require insiders license

Use this link to get the correct license.

Fires callback with Chat object every time the host phone is removed to a group.

Parameters​

• fn

callback function that handles a [[Chat]] (group chat) as the first and only parameter.

Returns​

Promise<boolean | Listener>

true if the callback was registered

onStateChanged()​

onStateChanged(fn): Promise<boolean | Listener>

Listens to changes in state

Parameters​

• fn

Returns​

Promise<boolean | Listener>

Fires​

STATE observable sream of states

onStory()
restricted
​

onStory(fn): Promise<boolean | Listener>

🏅May require restricted license

Use this link to get the correct license.

Listens to when a contact posts a new story.

Parameters​

• fn

callback

Returns​

Promise<boolean | Listener>

Fires​

e.g

{
from: '123456789@c.us'
id: 'false_132234234234234@status.broadcast'
}