You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/README.md
+3-16Lines changed: 3 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,35 +3,22 @@
3
3
4
4
> [!CAUTION]
5
5
> NOTICE OF BREAKING CHANGE.
6
-
>
6
+
>
7
7
> As of 7.0.0, multiple breaking changes were introduced into the library.
8
-
>
8
+
>
9
9
> Please check out https://whiskey.so/migrate-latest for more information.
10
10
11
11
Baileys is a WebSockets-based TypeScript library for interacting with the WhatsApp Web API.
12
12
13
13
Join the WhiskeySockets community via the link: https://whiskey.so/discord
14
14
15
15
16
-
> [!IMPORTANT]
17
-
> I made a survey for users of the project to ask questions, and provide Baileys valuable insights regarding its users. I will be publishing the results of this form (after filtering) as well so we can study and understand where we need to work.
18
-
>
19
-
> The survey is anonymous and requires no personal info at all. You are required to sign-in with Google to keep responses to one person. You are able to edit your response after you submit. The deadline for this form is September 30, 2025.
20
-
>
21
-
> I encourage you to put the effort, all it takes is 5-10 minutes and you get to ask me any questions you have.
22
-
>
23
-
> \- Rajeh (purpshell)
24
-
>
25
-
> Fill in the survey via the link: https://whiskey.so/survey
26
-
27
-
28
-
29
16
30
17
# Usage & Guide
31
18
32
19
> [!IMPORTANT]
33
20
> The new guide is a work in progress. Expect missing pages/content. [Report missing or incorrect content.](https://github.com/WhiskeySockets/baileys.wiki-site/issues/new)
34
-
>
21
+
>
35
22
> **You can still access the old guide here:**[README.md](https://github.com/WhiskeySockets/Baileys/tree/master/README.md), or the [NPM homepage](https://npmjs.com/package/baileys).
Copy file name to clipboardExpand all lines: README.md
+43-55Lines changed: 43 additions & 55 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,23 +5,11 @@
5
5
6
6
> [!CAUTION]
7
7
> NOTICE OF BREAKING CHANGE.
8
-
>
8
+
>
9
9
> As of 7.0.0, multiple breaking changes were introduced into the library.
10
-
>
10
+
>
11
11
> Please check out https://whiskey.so/migrate-latest for more information.
12
12
13
-
> [!IMPORTANT]
14
-
> I made a survey for users of the project to ask questions, and provide Baileys valuable insights regarding its users. I will be publishing the results of this form (after filtering) as well so we can study and understand where we need to work.
15
-
>
16
-
> The survey is anonymous and requires no personal info at all. You are required to sign-in with Google to keep responses to one person. You are able to edit your response after you submit. The deadline for this form is September 30, 2025.
17
-
>
18
-
> I encourage you to put the effort, all it takes is 5-10 minutes and you get to ask me any questions you have.
19
-
>
20
-
> \- Rajeh (purpshell)
21
-
>
22
-
> Fill in the survey via the link: https://whiskey.so/survey
23
-
24
-
25
13
# Important Note
26
14
This is a temporary README.md, the new guide is in development and will this file will be replaced with .github/README.md (already a default on GitHub).
27
15
@@ -39,16 +27,16 @@ Use at your own discretion. Do not spam people with this. We discourage any stal
39
27
40
28
##
41
29
42
-
- Baileys does not require Selenium or any other browser to be interface with WhatsApp Web, it does so directly using a **WebSocket**.
43
-
- Not running Selenium or Chromium saves you like **half a gig** of ram :/
30
+
- Baileys does not require Selenium or any other browser to be interface with WhatsApp Web, it does so directly using a **WebSocket**.
31
+
- Not running Selenium or Chromium saves you like **half a gig** of ram :/
44
32
- Baileys supports interacting with the multi-device & web versions of WhatsApp.
45
33
- Thank you to [@pokearaujo](https://github.com/pokearaujo/multidevice) for writing his observations on the workings of WhatsApp Multi-Device. Also, thank you to [@Sigalor](https://github.com/sigalor/whatsapp-web-reveng) for writing his observations on the workings of WhatsApp Web and thanks to [@Rhymen](https://github.com/Rhymen/go-whatsapp/) for the __go__ implementation.
46
34
47
35
> [!IMPORTANT]
48
36
> The original repository had to be removed by the original author - we now continue development in this repository here.
49
37
This is the only official repository and is maintained by the community.
50
38
> **Join the Discord [here](https://discord.gg/WeJM5FP9GG)**
51
-
39
+
52
40
## Example
53
41
54
42
Do check out & run [example.ts](Example/example.ts) to see an example usage of the library.
- WhatsApp automatically removes old media from their servers. For the device to access said media -- a re-upload is required by another device that has it. This can be accomplished using:
755
+
- WhatsApp automatically removes old media from their servers. For the device to access said media -- a re-upload is required by another device that has it. This can be accomplished using:
768
756
```ts
769
757
awaitsock.updateMediaMessage(msg)
770
758
```
@@ -790,17 +778,17 @@ const key: WAMessageKey
790
778
awaitsock.readMessages([key])
791
779
```
792
780
793
-
The message ID is the unique identifier of the message that you are marking as read.
781
+
The message ID is the unique identifier of the message that you are marking as read.
794
782
On a `WAMessage`, the `messageID` can be accessed using ```messageID=message.key.id```.
795
783
796
784
### Update Presence
797
785
798
786
- ```presence``` can be one of [these](https://baileys.whiskeysockets.io/types/WAPresence.html)
799
787
- The presence expires after about 10 seconds.
800
-
- This lets the person/group with `jid` know whether you're online, offline, typing etc.
788
+
- This lets the person/group with `jid` know whether you're online, offline, typing etc.
801
789
802
790
```ts
803
-
awaitsock.sendPresenceUpdate('available', jid)
791
+
awaitsock.sendPresenceUpdate('available', jid)
804
792
```
805
793
806
794
> [!NOTE]
@@ -849,12 +837,12 @@ await sock.chatModify(
849
837
messages: [
850
838
{
851
839
id: 'ATWYHDNNWU81732J',
852
-
fromMe: true,
840
+
fromMe: true,
853
841
timestamp: '1654823909'
854
842
}
855
843
]
856
844
}
857
-
},
845
+
},
858
846
jid
859
847
)
860
848
@@ -915,7 +903,7 @@ await sock.chatModify({
915
903
```ts
916
904
// turn on disappearing messages
917
905
awaitsock.sendMessage(
918
-
jid,
906
+
jid,
919
907
// this is 1 week in seconds -- how long you want messages to appear for
0 commit comments