whatsapp-web.js
A WhatsApp API client that connects through the WhatsApp Web browser app
It uses Puppeteer to run a real instance of Whatsapp Web to avoid getting blocked.
@@ -1990,6 +1990,11 @@ client.initialize();Source: structures/
Source: structures/
Message type buttons
See ButtonSpec
buttons of message
Creates button array from simple array
buttons
Array of Array of string
+Array of ButtonSpec
@@ -220,7 +221,7 @@ Returns: [{ buttonId:'customId',buttonText:{'displayText':&#
Array of Array of string
Array of FormattedButtonSpec
Indicates if the chat is muted or not
Promise containing Boolean
result
+Promise containing Boolean
+
result
Promise containing Boolean
result
+Promise containing Boolean
+
result
Yes
The amount of messages to return. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.
-Defaults to 50.
The amount of messages to return. If no limit is specified, the available messages will be returned. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.
Promise containing boolean
New pin state. Could be false if the max number of pinned chats was reached.
+Promise containing boolean
+
New pin state. Could be false if the max number of pinned chats was reached.
Promise containing Message
Message that was just sent
+Promise containing Message
+
Message that was just sent
Promise containing Boolean
result
+Promise containing Boolean
+
result
Promise containing boolean
New pin state
+Promise containing boolean
+
New pin state
Promise containing string
Id of the joined Chat
+Promise containing string
+
Id of the joined Chat
Object
createRes
+Object
+
createRes
string
createRes.gid - ID for the group that was just created
+string
+
createRes.gid - ID for the group that was just created
Object with string properties
createRes.missingParticipants - participants that were not added to the group. Keys represent the ID for participant that was not added and its value is a status code that represents the reason why participant could not be added. This is usually 403 if the user's privacy settings don't allow you to add them to groups.
+Object with string properties
+
createRes.missingParticipants - participants that were not added to the group. Keys represent the ID for participant that was not added and its value is a status code that represents the reason why participant could not be added. This is usually 403 if the user's privacy settings don't allow you to add them to groups.
Promise containing object
Invite information
+Promise containing object
+
Invite information
Promise containing boolean
New pin state. Could be false if the max number of pinned chats was reached.
+Promise containing boolean
+
New pin state. Could be false if the max number of pinned chats was reached.
Promise containing Message
Message that was just sent
+Promise containing Message
+
Message that was just sent
Promise containing boolean
result
+Promise containing boolean
+
result
Promise containing boolean
New pin state
+Promise containing boolean
+
New pin state
object
batteryStatus
+object
+
batteryStatus
number
batteryStatus.battery - The current battery percentage
+number
+
batteryStatus.battery - The current battery percentage
boolean
batteryStatus.plugged - Indicates if the phone is plugged in (true) or not (false)
+boolean
+
batteryStatus.plugged - Indicates if the phone is plugged in (true) or not (false)
Promise containing {status: number}
Object with status code indicating if the operation was successful
+Promise containing {status: number}
+
Object with status code indicating if the operation was successful
Yes
The amount of messages to return. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.
-Defaults to 50.
The amount of messages to return. If no limit is specified, the available messages will be returned. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.
Promise containing string
Group's invite code
+Promise containing string
+
Group's invite code
Promise containing {status: number}
Object with status code indicating if the operation was successful
+Promise containing {status: number}
+
Object with status code indicating if the operation was successful
Promise containing boolean
Returns true if the setting was properly updated. This can return false if the user does not have the necessary permissions.
+Promise containing boolean
+
Returns true if the setting was properly updated. This can return false if the user does not have the necessary permissions.
Promise containing boolean
Returns true if the setting was properly updated. This can return false if the user does not have the necessary permissions.
+Promise containing boolean
+
Returns true if the setting was properly updated. This can return false if the user does not have the necessary permissions.
Group Invite Data
Indicates if the message will disappear after it expires
+Indicates if the message was forwarded
@@ -572,7 +580,7 @@ diff --git a/docs/MessageMedia.html b/docs/MessageMedia.html index 6bab41c..c8e2222 100644 --- a/docs/MessageMedia.html +++ b/docs/MessageMedia.html @@ -4,7 +4,7 @@ -Yes
The amount of messages to return. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.
-Defaults to 50.
The amount of messages to return. If no limit is specified, the available messages will be returned. Note that the actual number of returned messages may be smaller if there aren't enough messages in the conversation. Set this to Infinity to load all messages.
Promise containing MessageMedia
media in webp format
+Promise containing MessageMedia
+
media in webp format
Promise containing MessageMedia
media in webp format
+Promise containing MessageMedia
+
media in webp format
Promise containing MessageMedia
media in webp format
+Promise containing MessageMedia
+
media in webp format
LIST_RESPONSE
++
+
BUTTONS_RESPONSE
@@ -888,6 +907,214 @@BROADCAST_NOTIFICATION
++
+
CALL_LOG
++
+
CIPHERTEXT
++
+
DEBUG
++
+
E2E_NOTIFICATION
++
+
GP2
++
+
GROUP_NOTIFICATION
++
+
HSM
++
+
INTERACTIVE
++
+
NATIVE_FLOW
++
+
NOTIFICATION
++
+
NOTIFICATION_TEMPLATE
++
+
OVERSIZED
++
+
PROTOCOL
++
+
REACTION
++
+
TEMPLATE_BUTTON_REPLY
++
+
Button spec used in Buttons constructor
+| Name | +Type | +Optional | +Description | +
|---|---|---|---|
|
+ id + |
+
+ string + |
+
+ Yes + |
+
+ Custom ID to set on the button. A random one will be generated if one is not passed. + |
+
|
+ body + |
+
+ string + |
+
+ + |
+
+ The text to show on the button. + |
+
ID that represents a contact
@@ -1192,6 +1467,64 @@| Name | +Type | +Optional | +Description | +
|---|---|---|---|
|
+ buttonId + |
+
+ string + |
+
+ + |
+ + | +
|
+ type + |
+
+ number + |
+
+ + |
+ + | +
|
+ buttonText + |
+
+ Object + |
+
+ + |
+ + | +
Group participant information
@@ -1647,7 +1980,7 @@ diff --git a/docs/index.html b/docs/index.html index ae60120..00df7b1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,7 +4,7 @@ -
A WhatsApp API client that connects through the WhatsApp Web browser app
It uses Puppeteer to run a real instance of Whatsapp Web to avoid getting blocked.
@@ -1990,6 +1990,11 @@ client.initialize();