7.0.6 • Published 5 months ago

rikky01 v7.0.6

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

Baileys - Typescript/Javascript WhatsApp Web API

GitHub Downloads (all assets, all releases) NPM Downloads GitHub code size in bytes GitHub License Discord GitHub Repo stars GitHub forks

Important Note

This library was originally a project for CS-2362 at Ashoka University and is in no way affiliated with or endorsed by WhatsApp. Use at your own discretion. Do not spam people with this. We discourage any stalkerware, bulk or automated messaging usage.

Liability and License Notice

Baileys and its maintainers cannot be held liable for misuse of this application, as stated in the MIT license. The maintainers of Baileys do not in any way condone the use of this application in practices that violate the Terms of Service of WhatsApp. The maintainers of this application call upon the personal responsibility of its users to use this application in a fair way, as it is intended to be used.

  • Baileys does not require Selenium or any other browser to be interface with WhatsApp Web, it does so directly using a WebSocket.
  • Not running Selenium or Chromimum saves you like half a gig of ram :/
  • Baileys supports interacting with the multi-device & web versions of WhatsApp.
  • Thank you to @pokearaujo for writing his observations on the workings of WhatsApp Multi-Device. Also, thank you to @Sigalor for writing his observations on the workings of WhatsApp Web and thanks to @Rhymen for the go implementation.

!IMPORTANT The original repository had to be removed by the original author - we now continue development in this repository here. This is the only official repository and is maintained by the community. Join the Discord here

Example

Do check out & run example.ts to see an example usage of the library. The script covers most common use cases. To run the example script, download or clone the repo and then type the following in a terminal: 1. cd path/to/Baileys 2. yarn 3. yarn example

Install

Use the stable version:

yarn add @itsukichan/baileys

Use the edge version (no guarantee of stability, but latest fixes + features)

yarn add github:Itsukichann/Baileys

Then import your code using:

import makeWASocket from '@itsukichan/baileys'

Links

Index

Connecting Account

WhatsApp provides a multi-device API that allows Baileys to be authenticated as a second WhatsApp client by scanning a QR code or Pairing Code with WhatsApp on your phone.

!NOTE Here is a simple example of event handling

!TIP You can see all supported socket configs here (Recommended)

Starting socket with QR-CODE

!TIP You can customize browser name if you connect with QR-CODE, with Browser constant, we have some browsers config, see here

import makeWASocket from '@itsukichan/baileys'

const suki = makeWASocket({
    // can provide additional config here
    browser: Browsers.ubuntu('My App'),
    printQRInTerminal: true
})

If the connection is successful, you will see a QR code printed on your terminal screen, scan it with WhatsApp on your phone and you'll be logged in!

Starting socket with Pairing Code

!IMPORTANT Pairing Code isn't Mobile API, it's a method to connect Whatsapp Web without QR-CODE, you can connect only with one device, see here

The phone number can't have + or () or -, only numbers, you must provide country code

import makeWASocket from '@itsukichan/baileys'

const suki = makeWASocket({
    // can provide additional config here
    printQRInTerminal: false //need to be false
})

if (!suki.authState.creds.registered) {
    const number = 'XXXXXXXXXXX'
    const code = await suki.requestPairingCode(number)
    console.log(code)
}

Receive Full History

  1. Set syncFullHistory as true
  2. Baileys, by default, use chrome browser config
    • If you'd like to emulate a desktop connection (and receive more message history), this browser setting to your Socket config:
const suki = makeWASocket({
    ...otherOpts,
    // can use Windows, Ubuntu here too
    browser: Browsers.macOS('Desktop'),
    syncFullHistory: true
})

Important Notes About Socket Config

Caching Group Metadata (Recommended)

  • If you use baileys for groups, we recommend you to set cachedGroupMetadata in socket config, you need to implement a cache like this:

    const groupCache = new NodeCache({stdTTL: 5 * 60, useClones: false})

const suki = makeWASocket({
    cachedGroupMetadata: async (jid) => groupCache.get(jid)
})

suki.ev.on('groups.update', async ([event]) => {
    const metadata = await suki.groupMetadata(event.id)
    groupCache.set(event.id, metadata)
})

suki.ev.on('group-participants.update', async (event) => {
    const metadata = await suki.groupMetadata(event.id)
    groupCache.set(event.id, metadata)
})

Improve Retry System & Decrypt Poll Votes

  • If you want to improve sending message, retrying when error occurs and decrypt poll votes, you need to have a store and set getMessage config in socket like this:
    const suki = makeWASocket({
    getMessage: async (key) => await getMessageFromStore(key)
})

Receive Notifications in Whatsapp App

  • If you want to receive notifications in whatsapp app, set markOnlineOnConnect to false
    const suki = makeWASocket({
    markOnlineOnConnect: false
})

Saving & Restoring Sessions

You obviously don't want to keep scanning the QR code every time you want to connect.

So, you can load the credentials to log back in:

import makeWASocket, { useMultiFileAuthState } from '@itsukichan/baileys'

const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')

// will use the given state to connect
// so if valid credentials are available -- it'll connect without QR
const suki = makeWASocket({ auth: state })

// this will be called as soon as the credentials are updated
suki.ev.on('creds.update', saveCreds)

!IMPORTANT useMultiFileAuthState is a utility function to help save the auth state in a single folder, this function serves as a good guide to help write auth & key states for SQL/no-SQL databases, which I would recommend in any production grade system.

!NOTE When a message is received/sent, due to signal sessions needing updating, the auth keys (authState.keys) will update. Whenever that happens, you must save the updated keys (authState.keys.set() is called). Not doing so will prevent your messages from reaching the recipient & cause other unexpected consequences. The useMultiFileAuthState function automatically takes care of that, but for any other serious implementation -- you will need to be very careful with the key state management.

Handling Events

  • Baileys uses the EventEmitter syntax for events. They're all nicely typed up, so you shouldn't have any issues with an Intellisense editor like VS Code.

!IMPORTANT The events are these, it's important you see all events

You can listen to these events like this:

const suki = makeWASocket()
suki.ev.on('messages.upsert', ({ messages }) => {
    console.log('got messages', messages)
})

Example to Start

!NOTE This example includes basic auth storage too

import makeWASocket, { DisconnectReason, useMultiFileAuthState } from '@itsukichan/baileys'
import { Boom } from '@hapi/boom'

async function connectToWhatsApp () {
    const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')
    const suki = makeWASocket({
        // can provide additional config here
        auth: state,
        printQRInTerminal: true
    })
    suki.ev.on('connection.update', (update) => {
        const { connection, lastDisconnect } = update
        if(connection === 'close') {
            const shouldReconnect = (lastDisconnect.error as Boom)?.output?.statusCode !== DisconnectReason.loggedOut
            console.log('connection closed due to ', lastDisconnect.error, ', reconnecting ', shouldReconnect)
            // reconnect if not logged out
            if(shouldReconnect) {
                connectToWhatsApp()
            }
        } else if(connection === 'open') {
            console.log('opened connection')
        }
    })
    suki.ev.on('messages.upsert', event => {
        for (const m of event.messages) {
            console.log(JSON.stringify(m, undefined, 2))

            console.log('replying to', m.key.remoteJid)
            await suki.sendMessage(m.key.remoteJid!, { text: 'Hello Word' })
        }
    })

    // to storage creds (session info) when it updates
    suki.ev.on('creds.update', saveCreds)
}
// run in main file
connectToWhatsApp()

!IMPORTANT In messages.upsert it's recommended to use a loop like for (const message of event.messages) to handle all messages in array

Decrypt Poll Votes

  • By default poll votes are encrypted and handled in messages.update
  • That's a simple example
suki.ev.on('messages.update', event => {
    for(const { key, update } of event) {
        if(update.pollUpdates) {
            const pollCreation = await getMessage(key)
            if(pollCreation) {
                console.log(
                    'got poll update, aggregation: ',
                    getAggregateVotesInPollMessage({
                        message: pollCreation,
                        pollUpdates: update.pollUpdates,
                    })
                )
            }
        }
    }
})
  • getMessage is a store implementation (in your end)

Summary of Events on First Connection

  1. When you connect first time, connection.update will be fired requesting you to restart sock
  2. Then, history messages will be received in messaging.history-set

Implementing a Data Store

  • Baileys does not come with a defacto storage for chats, contacts, or messages. However, a simple in-memory implementation has been provided. The store listens for chat updates, new messages, message updates, etc., to always have an up-to-date version of the data.

!IMPORTANT I highly recommend building your own data store, as storing someone's entire chat history in memory is a terrible waste of RAM.

It can be used as follows:

import makeWASocket, { makeInMemoryStore } from '@itsukichan/baileys'
// the store maintains the data of the WA connection in memory
// can be written out to a file & read from it
const store = makeInMemoryStore({ })
// can be read from a file
store.readFromFile('./baileys_store.json')
// saves the state to a file every 10s
setInterval(() => {
    store.writeToFile('./baileys_store.json')
}, 10_000)

const suki = makeWASocket({ })
// will listen from this socket
// the store can listen from a new socket once the current socket outlives its lifetime
store.bind(suki.ev)

suki.ev.on('chats.upsert', () => {
    // can use 'store.chats' however you want, even after the socket dies out
    // 'chats' => a KeyedDB instance
    console.log('got chats', store.chats.all())
})

suki.ev.on('contacts.upsert', () => {
    console.log('got contacts', Object.values(store.contacts))
})

The store also provides some simple functions such as loadMessages that utilize the store to speed up data retrieval.

Whatsapp IDs Explain

  • id is the WhatsApp ID, called jid too, of the person or group you're sending the message to.
    • It must be in the format [country code][phone number]@s.whatsapp.net - Example for people: +19999999999@s.whatsapp.net. - For groups, it must be in the format 123456789-123345@g.us.
    • For broadcast lists, it's [timestamp of creation]@broadcast.
    • For stories, the ID is status@broadcast.

Utility Functions

  • getContentType, returns the content type for any message
  • getDevice, returns the device from message
  • makeCacheableSignalKeyStore, make auth store more fast
  • downloadContentFromMessage, download content from any message

Sending Messages

  • Send all types of messages with a single function

    • Here you can see all message contents supported, like text message

    • Here you can see all options supported, like quote message

      const jid: string
const content: AnyMessageContent
const options: MiscMessageGenerationOptions

suki.sendMessage(jid, content, options)

Non-Media Messages

Text Message

await suki.sendMessage(jid, { text: 'hello word' })

Quote Message (works with all types)

await suki.sendMessage(jid, { text: 'hello word' }, { quoted: message })

Mention User (works with most types)

  • @number is to mention in text, it's optional
await suki.sendMessage(
    jid,
    {
        text: '@12345678901',
        mentions: ['12345678901@s.whatsapp.net']
    }
)

Forward Messages

  • You need to have message object, can be retrieved from store or use a message object
const msg = getMessageFromStore() // implement this on your end
await suki.sendMessage(jid, { forward: msg }) // WA forward the message!

Location Message

await suki.sendMessage(
    jid, 
    {
        location: {
            degreesLatitude: 24.121231,
            degreesLongitude: 55.1121221
        }
    }
)

Contact Message

const vcard = 'BEGIN:VCARD\n' // metadata of the contact card
            + 'VERSION:3.0\n' 
            + 'FN:Jeff Singh\n' // full name
            + 'ORG:Ashoka Uni;\n' // the organization of the contact
            + 'TEL;type=CELL;type=VOICE;waid=911234567890:+91 12345 67890\n' // WhatsApp ID + phone number
            + 'END:VCARD'

await suki.sendMessage(
    id,
    { 
        contacts: { 
            displayName: 'Itsukichann', 
            contacts: [{ vcard }] 
        }
    }
)

Reaction Message

  • You need to pass the key of message, you can retrieve from store or use a key object
await suki.sendMessage(
    jid,
    {
        react: {
            text: '💖', // use an empty string to remove the reaction
            key: message.key
        }
    }
)

Pin Message

  • You need to pass the key of message, you can retrieve from store or use a key object

  • Time can be:

TimeSeconds
24h86.400
7d604.800
30d2.592.000
await suki.sendMessage(
    jid,
    {
        pin: {
            type: 1, // 2 to remove
            time: 86400,
            key: Key
        }
    }
)

Poll Message

await suki.sendMessage(
    jid,
    {
        poll: {
            name: 'My Poll',
            values: ['Option 1', 'Option 2', ...],
            selectableCount: 1,
            toAnnouncementGroup: false // or true
        }
    }
)

Call Message

await suki.sendMessage(
    jid,
    {
        call: {
            name: 'Hay',
            type: 1 // 2 for video
        }
    }
)

Event Message

await suki.sendMessage(
    jid,
    {
        event: {
            name: 'holiday together!',
            description: 'who wants to come along?'
        }
    }
)

Order Message

await suki.sendMessage(
    jid,
    {
        order: {
            orderId: '574xxx',
            thumbnail: 'your_thumbnail', 
            itemCount: 'your_count',
            status: 'your_status', // INQUIRY || ACCEPTED || DECLINED
            surface: 'CATALOG',
            message: 'your_caption',
            orderTitle: "your_title",
            sellerJid: 'your_jid'',
            token: 'your_token',
            totalAmount1000: 'your_amount',
            totalCurrencyCode: 'IDR'
        }
    }
)

Product Message

await suki.sendMessage(
    jid,
    {
        product: {
            productImage: {   // for using buffer >> productImage: your_buffer
              url: your_url
            },
            productId: 'your_id', 
            title: 'your_title',
            description: 'your_description', 
            currencyCode: 'IDR', 
            priceAmount1000: 'your_amount', 
            retailerId: 'your_reid', // optional use if needed
            url: 'your_url', // optional use if needed
            productImageCount: 'your_imageCount', 
            firstImageId: 'your_image', // optional use if needed
            salePriceAmount1000: 'your_priceSale', 
            signedUrl: 'your_url' // optional use if needed
        },
       businessOwnerJid: 'your_jid' 
    }
)

Payment Message

await suki.sendMessage(
    jid,
    {
        payment: {
            note: 'Hi!',
            currency: 'IDR', // optional 
            offset: 0, // optional
            amount: '10000', // optional
            expiry: 0, // optional
            from: '628xxxx@s.whatsapp.net', // optional
            image: { // optional
               placeholderArgb: "your_background", // optional
               textArgb: "your_text",  // optional
               subtextArgb: "your_subtext" // optional
            }
        }
    }
)

Payment Invite Message

await suki.sendMessage(
    id, 
    { 
        paymentInvite: {
            type: number, // 1 || 2 || 3
            expiry: 0 
        }   
    }
)

Admin Invite Message

await suki.sendMessage(
    jid,
    {
        adminInvite: {
            jid: '123xxx@newsletter',
            name: 'newsletter_name', 
            caption: 'Please be my channel admin',
            expiration: 86400,
            jpegThumbnail: Buffer // optional
        }
    }
)

Group Invite Message

await suki.sendMessage(
    jid,
    {
        groupInvite: {
            jid: '123xxx@g.us',
            name: 'group_name', 
            caption: 'Please Join My Whatsapp Group',
            code: 'code_invite',
            expiration: 86400,
            jpegThumbnail: Buffer, // optional            
        }
    }
)

Share Phone Number Message

await suki.sendMessage(
    jid,
    {
        sharePhoneNumber: {
        }
    }
)

Request Phone Number Message

await suki.sendMessage(
    jid,
    {
        requestPhoneNumber: {
        }
    }
)

Buttons Message

await suki.sendMessage(
    jid,
    {
        text: 'This is a button message!',  // image: buffer or // image: { url: url } If you want to use images
        caption: 'caption', // Use this if you are using an image or video
        footer: 'Hello World!',  
        buttons: [{ 
            buttonId: 'Id1', 
            buttonText: { 
                 displayText: 'Button 1'
              }
          }, 
          { 
            buttonId: 'Id2', 
            buttonText: { 
                 displayText: 'Button 2'
              }
          }, 
          { 
            buttonId: 'Id3', 
            buttonText: { 
                 displayText: 'Button 3'
              }
         }], 
        viewOnce: true 
    }
)

Buttons List Message

await suki.sendMessage(
    jid,
    {
        text: 'This is a list!', 
        footer: 'Hello World!', 
        title: 'Amazing boldfaced list title', 
        buttonText: 'Required, text on the button to view the list', 
        sections: [
           {
         	title: 'Section 1',
         	rows: [{
                title: 'Option 1', 
                rowId: 'option1'
             },
 	        {
                title: 'Option 2', 
                rowId: 'option2', 
                description: 'This is a description'
           }]
       },
       {
       	title: 'Section 2',
       	rows: [{
               title: 'Option 3', 
               rowId: 'option3'
           },
	       {
               title: 'Option 4', 
               rowId: 'option4', 
               description: 'This is a description V2'
           }]
       }]
    }
)

Buttons Cards Message

await suki.sendMessage(
    jid,
    {
       text: 'This is a body', 
       footer: 'This is a footer', 
       cards: [[
          'url', // image or video
          'Title', 
          'Body', 
          'Footer', 
          'buttonType',  // cta_url || cta_copy || cta_call || cta_catalog || cta_reminder || cta_cancel_reminder || address_message || send_location || quick_reply
          'buttonText', 
          'buttonId'
        ]], 
        type: 'image' // or video
    }
)

Buttons Template Message

await suki.sendMessage(
    jid,
    {
       text: 'This is a template message!', 
       footer: 'Hello World!', 
       templateButtons: [{
           index: 1,
           urlButton: {
                displayText: 'Follow Me', 
                url: 'https://whatsapp.com/channel/0029Vag9VSI2ZjCocqa2lB1y'
             }, 
         }, 
         {
            index: 2,
            callButton: {
                displayText: 'Call Me!', 
                phoneNumber: '628xxx'
            }, 
        }, 
        {
           index: 3,
           quickReplyButton: {
                displayText: 'This is a reply, just like normal buttons!', 
                id: 'id-like-buttons-message'
            }, 
       }]
    }
)

Buttons Interactive Message

await suki.sendMessage(
    jid,
    {
        text: 'This is an Interactive message!',
        title: 'Hiii',
        subtitle: 'There is a subtitle', 
        footer: 'Hello World!',
        interactiveButtons: [
            {
                name: 'quick_reply',
                buttonParamsJson: JSON.stringify({
                    display_text: 'Click Me!',
                    id: 'your_id'
                })
            },
            {
                name: 'cta_url',
                buttonParamsJson: JSON.stringify({
                    display_text: 'Follow Me',
                    url: 'https://whatsapp.com/channel/0029Vag9VSI2ZjCocqa2lB1y',
                    merchant_url: 'https://whatsapp.com/channel/0029Vag9VSI2ZjCocqa2lB1y'
                })
            },
            {
                name: 'cta_copy',
                buttonParamsJson: JSON.stringify({
                    display_text: 'Click Me!',
                    copy_code: 'https://whatsapp.com/channel/0029Vag9VSI2ZjCocqa2lB1y'
                })
            },
            {
                name: 'cta_call',
                buttonParamsJson: JSON.stringify({
                    display_text: 'Call Me!',
                    phone_number: '628xxx'
                })
            },
            {
                name: 'cta_catalog',
                buttonParamsJson: JSON.stringify({
                    business_phone_number: '628xxx'
                })
            },
            {
                name: 'cta_reminder',
                buttonParamsJson: JSON.stringify({
                    display_text: '...'
                })
            },
            {
                name: 'cta_cancel_reminder',
                buttonParamsJson: JSON.stringify({
                    display_text: '...'
                })
            },
            {
                name: 'address_message',
                buttonParamsJson: JSON.stringify({
                    display_text: '...'
                })
            },
            {
                name: 'send_location',
                buttonParamsJson: JSON.stringify({
                    display_text: '...'
                })
            },
            {
                name: 'open_webview',
                buttonParamsJson: JSON.stringify({
                    title: 'Follow Me!',
                    link: {
                        in_app_webview: true, // or false
                        url: 'https://whatsapp.com/channel/0029Vag9VSI2ZjCocqa2lB1y'
                    }
                })
            },
            {
                name: 'single_select',
                buttonParamsJson: JSON.stringify({
                    title: 'Click Me!',
                    sections: [
                        {
                            title: 'Title 1',
                            highlight_label: 'Highlight label 1',
                            rows: [
                                {
                                    header: 'Header 1',
                                    title: 'Title 1',
                                    description: 'Description 1',
                                    id: 'Id 1'
                                },
                                {
                                    header: 'Header 2',
                                    title: 'Title 2',
                                    description: 'Description 2',
                                    id: 'Id 2'
                                }
                            ]
                        }
                    ]
                })
            }
        ]
    }
);

// If you want to use an image
await suki.sendMessage(
    jid, 
    {
       image: { 
          url: 'https://example.jpg' 
       },
       caption: 'Body',
       title: 'Title',
       subtitle: 'Subtitle', 
       footer: 'Footer',
       interactiveButtons: [
           {
               name: 'quick_reply',
               buttonParamsJson: JSON.stringify({
                   display_text: 'DisplayText',
                   id: 'ID1'
               })
           }
       ]
    }
);

// If you want to use an video
await suki.sendMessage(
    jid, 
    {
        video: { 
          url: 'https://example.mp4' 
       },
       caption: 'Body',
       title: 'Title', 
       subtitle: 'Subtitle', 
       footer: 'Footer',
       interactiveButtons: [
           {
               name: 'quick_reply',
               buttonParamsJson: JSON.stringify({
                   display_text: 'DisplayText',
                   id: 'ID1'
               })
           }
       ]
    }
);

// If you want to use an document
await suki.sendMessage(
    jid, 
    {
        document: { 
          url: 'https://example.jpg' 
       }, 
       mimetype: 'image/jpeg', 
       jpegThumbnail: await suki.resize('https://example.jpg', 320, 320), 
       caption: 'Body',
       title: 'Title',
       subtitle: 'Subtitle', 
       footer: 'Footer',
       interactiveButtons: [
           {
               name: 'quick_reply',
               buttonParamsJson: JSON.stringify({
                   display_text: 'DisplayText',
                   id: 'ID1'
               })
           }
       ]
    }
);

// If you want to use an location
await suki.sendMessage(
    jid, 
    {
        location: { 
          degressLatitude: 0,
          degressLongitude: -1
       },
       caption: 'Body',
       title: 'Title', 
       subtitle: 'Subtitle', 
       footer: 'Footer',
       interactiveButtons: [
           {
               name: 'quick_reply',
               buttonParamsJson: JSON.stringify({
                   display_text: 'DisplayText',
                   id: 'ID1'
               })
           }
       ]
    }
);

// if you want to use an product
await suki.sendMessage(
    jid,
    {
        product: {
            productImage: { 
               url: 'https://example.jpg'
            },
            productId: '836xxx',
            title: 'Title',
            description: 'Description',
            currencyCode: 'IDR',
            priceAmount1000: '283xxx',
            retailerId: 'Itsukichann',
            url: 'https://example.com',
            productImageCount: 1
        },
        businessOwnerJid: '628xxx@s.whatsapp.net',
        caption: 'Body',
        title: 'Title', 
        subtitle: 'Subtitle', 
        footer: 'Footer',
        interactiveButtons: [
            {
                name: 'quick_reply',
                buttonParamsJson: JSON.stringify({
                    display_text: 'DisplayText',
                    id: 'ID1'
                })
            }
        ]
    }
);

Status Mentions Message

await suki.sendStatusMentions(
    {
      image: {
       url: 'url.jpg'
       }, 
       caption: 'Hi'
    }, 
    '1234xxx@g.us'
)

// Use this if you want private mentions
await suki.sendStatusMentions(
    {
      image: {
       url: 'https://example.com.jpg'
       }, 
       caption: 'Hi'
    }, 
    '628xxx@s.whatsapp.net', 
     true
)

Send Album Message

await suki.sendAlbumMessage(
   jid, 
   [{
       type: 'image', or video
       data: Buffer // or  data: { url:
       caption: 'caption'
   }]
{ quoted? , annotations? delay? })

### Sending Messages with Link Previews

1. By default, wa does not have link generation when sent from the web
2. Baileys has a function to generate the content for these link previews
3. To enable this function's usage, add `link-preview-js` as a dependency to your project with `yarn add link-preview-js`
4. Send a link:
```ts
await suki.sendMessage(
    jid,
    {
        text: 'Hi, this was sent using https://github.com/whiskeysockets/baileys'
    }
)

Media Messages

Sending media (video, stickers, images) is easier & more efficient than ever.

!NOTE In media messages, you can pass { stream: Stream } or { url: Url } or Buffer directly, you can see more here

  • When specifying a media url, Baileys never loads the entire buffer into memory; it even encrypts the media as a readable stream.

!TIP It's recommended to use Stream or Url to save memory

Gif Message

  • Whatsapp doesn't support .gif files, that's why we send gifs as common .mp4 video with gifPlayback flag
await suki.sendMessage(
    jid, 
    { 
        video: fs.readFileSync('Media/ma_gif.mp4'),
        caption: 'hello word',
        gifPlayback: true
    }
)

Video Message

await suki.sendMessage(
    id, 
    { 
        video: {
            url: './Media/ma_gif.mp4'
        },
        caption: 'hello word',	    
    }
)

Video Ptv Message

await suki.sendMessage(
    id, 
    { 
        video: {
            url: './Media/ma_gif.mp4'
        },
        ptv: true	    
    }
)

Audio Message

  • To audio message work in all devices you need to convert with some tool like ffmpeg with this flags:
        codec: libopus //ogg file
    ac: 1 //one channel
    avoid_negative_ts
    make_zero
    • Example:
      ffmpeg -i input.mp4 -avoid_negative_ts make_zero -ac 1 output.ogg
await suki.sendMessage(
    jid, 
    {
        audio: {
            url: './Media/audio.mp3'
        },
        mimetype: 'audio/mp4'
    }
)

Image Message

await suki.sendMessage(
    id, 
    { 
        image: {
            url: './Media/ma_img.png'
        },
        caption: 'hello word'
    }
)

View Once Message

  • You can send all messages above as viewOnce, you only need to pass viewOnce: true in content object
await suki.sendMessage(
    id, 
    { 
        image: {
            url: './Media/ma_img.png'
        },
        viewOnce: true, //works with video, audio too
        caption: 'hello word'
    }
)

Modify Messages

Deleting Messages (for everyone)

const msg = await suki.sendMessage(jid, { text: 'hello word' })
await suki.sendMessage(jid, { delete: msg.key })

Note: deleting for oneself is supported via chatModify, see in this section

Editing Messages

  • You can pass all editable contents here
await suki.sendMessage(jid, {
      text: 'updated text goes here',
      edit: response.key,
    });

Manipulating Media Messages

Thumbnail in Media Messages

  • For media messages, the thumbnail can be generated automatically for images & stickers provided you add jimp or sharp as a dependency in your project using yarn add jimp or yarn add sharp.
  • Thumbnails for videos can also be generated automatically, though, you need to have ffmpeg installed on your system.

Downloading Media Messages

If you want to save the media you received

import { createWriteStream } from 'fs'
import { downloadMediaMessage, getContentType } from '@itsukichan/baileys'

suki.ev.on('messages.upsert', async ({ [m] }) => {
    if (!m.message) return // if there is no text or media message
    const messageType = getContentType(m) // get what type of message it is (text, image, video...)

    // if the message is an image
    if (messageType === 'imageMessage') {
        // download the message
        const stream = await downloadMediaMessage(
            m,
            'stream', // can be 'buffer' too
            { },
            { 
                logger,
                // pass this so that baileys can request a reupload of media
                // that has been deleted
                reuploadRequest: suki.updateMediaMessage
            }
        )
        // save to file
        const writeStream = createWriteStream('./my-download.jpeg')
        stream.pipe(writeStream)
    }
}

Re-upload Media Message to Whatsapp

  • 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: 
await suki.updateMediaMessage(msg)

Reject Call

  • You can obtain callId and callFrom from call event
await suki.rejectCall(callId, callFrom)

Send States in Chat

Reading Messages

  • A set of message keys must be explicitly marked read now.
  • You cannot mark an entire 'chat' read as it were with Baileys Web. This means you have to keep track of unread messages.
const key: WAMessageKey
// can pass multiple keys to read multiple messages as well
await suki.readMessages([key])

The message ID is the unique identifier of the message that you are marking as read. On a WAMessage, the messageID can be accessed using messageID = message.key.id.

Update Presence

  • presence can be one of these
  • The presence expires after about 10 seconds.
  • This lets the person/group with jid know whether you're online, offline, typing etc. 
await suki.sendPresenceUpdate('available', jid)

!NOTE If a desktop client is active, WA doesn't send push notifications to the device. If you would like to receive said notifications -- mark your Baileys client offline using suki.sendPresenceUpdate('unavailable')

Modifying Chats

WA uses an encrypted form of communication to send chat/app updates. This has been implemented mostly and you can send the following updates:

!IMPORTANT If you mess up one of your updates, WA can log you out of all your devices and you'll have to log in again.

Archive a Chat

const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
await suki.chatModify({ archive: true, lastMessages: [lastMsgInChat] }, jid)

Mute/Unmute a Chat

  • Supported times:
TimeMiliseconds
Removenull
8h86.400.000
7d604.800.000
// mute for 8 hours
await suki.chatModify({ mute: 8 * 60 * 60 * 1000 }, jid)
// unmute
await suki.chatModify({ mute: null }, jid)

Mark a Chat Read/Unread

const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
// mark it unread
await suki.chatModify({ markRead: false, lastMessages: [lastMsgInChat] }, jid)

Delete a Message for Me

await suki.chatModify(
    {
        clear: {
            messages: [
                {
                    id: 'ATWYHDNNWU81732J',
                    fromMe: true, 
                    timestamp: '1654823909'
                }
            ]
        }
    }, 
    jid
)

Delete a Chat

const lastMsgInChat = await getLastMessageInChat(jid) // implement this on your end
await suki.chatModify({
        delete: true,
        lastMessages: [
            {
                key: lastMsgInChat.key,
                messageTimestamp: lastMsgInChat.messageTimestamp
            }
        ]
    },
    jid
)

Pin/Unpin a Chat

await suki.chatModify({
        pin: true // or `false` to unpin
    },
    jid
)

Star/Unstar a Message

await suki.chatModify({
        star: {
            messages: [
                {
                    id: 'messageID',
                    fromMe: true // or `false`
                }
            ],
            star: true // - true: Star Message; false: Unstar Message
        }
    },
    jid
)

Disappearing Messages

  • Ephemeral can be:
TimeSeconds
Remove0
24h86.400
7d604.800
90d7.776.000
  • You need to pass in Seconds, default is 7 days
// turn on disappearing messages
await suki.sendMessage(
    jid, 
    // this is 1 week in seconds -- how long you want messages to appear for
    { disappearingMessagesInChat: WA_DEFAULT_EPHEMERAL }
)

// will send as a disappearing message
await suki.sendMessage(jid, { text: 'hello' }, { ephemeralExpiration: WA_DEFAULT_EPHEMERAL })

// turn off disappearing messages
await suki.sendMessage(
    jid, 
    { disappearingMessagesInChat: false }
)

User Querys

Check If ID Exists in Whatsapp

const [result] = await suki.onWhatsApp(jid)
if (result.exists) console.log (`${jid} exists on WhatsApp, as jid: ${result.jid}`)

Query Chat History (groups too)

  • You need to have oldest message in chat
const msg = await getOldestMessageInChat(jid)
await suki.fetchMessageHistory(
    50, //quantity (max: 50 per query)
    msg.key,
    msg.messageTimestamp
)
  • Messages will be received in messaging.history-set event

Fetch Status

const status = await suki.fetchStatus(jid)
console.log('status: ' + status)

Fetch Profile Picture

  • To get the display picture of some person, group and channel
// for low res picture
const ppUrl = await suki.profilePictureUrl(jid)
console.log(ppUrl)

Fetch Bussines Profile (such as description or category)

const profile = await suki.getBusinessProfile(jid)
console.log('business description: ' + profile.description + ', category: ' + profile.category)

Fetch Someone's Presence (if they're typing or online)

// the presence update is fetched and called here
suki.ev.on('presence.update', console.log)

// request updates for a chat
await suki.presenceSubscribe(jid)

Change Profile

Change Profile Status

await suki.updateProfileStatus('Hello World!')

Change Profile Name

await suki.updateProfileName('My name')

Change Display Picture (groups too)

  • To change your display picture or a group's

!NOTE Like media messages, you can pass { stream: Stream } or { url: Url } or Buffer directly, you can see more here

await suki.updateProfilePicture(jid, { url: './new-profile-picture.jpeg' })

Remove display picture (groups too)

await suki.removeProfilePicture(jid)

Groups

  • To change group properties you need to be admin

Create a Group

// title & participants
const group = await suki.groupCreate('My Fab Group', ['1234@s.whatsapp.net', '4564@s.whatsapp.net'])
console.log('created group with id: ' + group.gid)
await suki.sendMessage(group.id, { text: 'hello there' }) // say hello to everyone on the group

Add/Remove or Demote/Promote

// id & people to add to the group (will throw error if it fails)
await suki.groupParticipantsUpdate(
    jid, 
    ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
    'add' // replace this parameter with 'remove' or 'demote' or 'promote'
)

Change Subject (name)

await suki.groupUpdateSubject(jid, 'New Subject!')

Change Description

await suki.groupUpdateDescription(jid, 'New Description!')

Change Settings

// only allow admins to send messages
await suki.groupSettingUpdate(jid, 'announcement')
// allow everyone to send messages
await suki.groupSettingUpdate(jid, 'not_announcement')
// allow everyone to modify the group's settings -- like display picture etc.
await suki.groupSettingUpdate(jid, 'unlocked')
// only allow admins to modify the group's settings
await suki.groupSettingUpdate(jid, 'locked')

Leave a Group

// will throw error if it fails
await suki.groupLeave(jid)

Get Invite Code

  • To create link with code use 'https://chat.whatsapp.com/' + code
const code = await suki.groupInviteCode(jid)
console.log('group code: ' + code)

Revoke Invite Code

const code = await suki.groupRevokeInvite(jid)
console.log('New group code: ' + code)

Join Using Invitation Code

  • Code can't have https://chat.whatsapp.com/, only code
const response = await suki.groupAcceptInvite(code)
console.log('joined to: ' + response)

Get Group Info by Invite Code

const response = await suki.groupGetInviteInfo(code)
console.log('group information: ' + response)

Query Metadata (participants, name, description...)

const metadata = await suki.groupMetadata(jid) 
console.log(metadata.id + ', title: ' + metadata.subject + ', description: ' + metadata.desc)

Join using groupInviteMessage

const response = await suki.groupAcceptInviteV4(jid, groupInviteMessage)
console.log('joined to: ' + response)

Get Request Join List

const response = await suki.groupRequestParticipantsList(jid)
console.log(response)

Approve/Reject Request Join

const response = await suki.groupRequestParticipantsUpdate(
    jid, // group id
    ['abcd@s.whatsapp.net', 'efgh@s.whatsapp.net'],
    'approve' // or 'reject' 
)
console.log(response)

Get All Participating Groups Metadata

const response = await suki.groupFetchAllParticipating()
console.log(response)

Toggle Ephemeral

  • Ephemeral can be:
TimeSeconds
Remove0
24h86.400
7d604.800
90d7.776.000
await suki.groupToggleEphemeral(jid, 86400)

Change Add Mode

await suki.groupMemberAddMode(
    jid,
    'all_member_add' // or 'admin_add'
)

Privacy

Block/Unblock User

await suki.updateBlockStatus(jid, 'block') // Block user
await suki.updateBlockStatus(jid, 'unblock') // Unblock user

Get Privacy Settings

const privacySettings = await suki.fetchPrivacySettings(true)
console.log('privacy settings: ' + privacySettings)

Get BlockList

const response = await suki.fetchBlocklist()
console.log(response)

Update LastSeen Privacy

const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await suki.updateLastSeenPrivacy(value)

Update Online Privacy

const value = 'all' // 'match_last_seen'
await suki.updateOnlinePrivacy(value)

Update Profile Picture Privacy

const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await suki.updateProfilePicturePrivacy(value)

Update Status Privacy

const value = 'all' // 'contacts' | 'contact_blacklist' | 'none'
await suki.updateStatusPrivacy(value)

Update Read Receipts Privacy

const value = 'all' // 'none'
await suki.updateReadReceiptsPrivacy(value)

Update Groups Add Privacy

const value = 'all' // 'contacts' | 'contact_blacklist'
await suki.updateGroupsAddPrivacy(value)

Update Default Disappearing Mode

  • Like this, ephemeral can be:
TimeSeconds
Remove0
24h86.400
7d604.800
90d7.776.000
const ephemeral = 86400 
await suki.updateDefaultDisappearingMode(ephemeral)

Broadcast Lists & Stories

Send Broadcast & Stories

  • Messages can be sent to broadcasts & stories. You need to add the following message options in sendMessage, like this:
await suki.sendMessage(
    jid,
    {
        image: {
            url: url
        },
        caption: caption
    },
    {
        backgroundColor: backgroundColor,
        font: font,
        statusJidList: statusJidList,
        broadcast: true
    }
)
  • Message body can be a extendedTextMessage or imageMessage or videoMessage or voiceMessage, see here
  • You can add backgroundColor and other options in the message options, see here
  • broadcast: true enables broadcast mode

  • statusJidList: a list of people that you can get which you need to provide, which are the people who will get this status message.

  • You can send messages to broadcast lists the same way you send messages to groups & individual chats.

  • Right now, WA Web does not support creating broadcast lists, but you can still delete them.
  • Broadcast IDs are in the format 12345678@broadcast

Query a Broadcast List's Recipients & Name

const bList = await suki.getBroadcastListInfo('1234@broadcast')
console.log (`list name: ${bList.name}, recps: ${bList.recipients}`)

Writing Custom Functionality

Baileys is written with custom functionality in mind. Instead of forking the project & re-writing the internals, you can simply write your own extensions.

Enabling Debug Level in Baileys Logs

First, enable the logging of unhandled messages from WhatsApp by setting:

const suki = makeWASocket({
    logger: P({ level: 'debug' }),
})

This will enable you to see all sorts of messages WhatsApp sends in the console.

How Whatsapp Communicate With Us

!TIP If you want to learn whatsapp protocol, we recommend to study about Libsignal Protocol and Noise Protocol

  • Example: Functionality to track the battery percentage of your phone. You enable logging and you'll see a message about your battery pop up in the console: 
    {
    "level": 10,
    "fromMe": false,
    "frame": {
        "tag": "ib",
        "attrs": {
            "from": "@s.whatsapp.net"
        },
        "content": [
            {
                "tag": "edge_routing",
                "attrs": {},
                "content": [
                    {
                        "tag": "routing_info",
                        "attrs": {},
                        "content": {
                            "type": "Buffer",
                            "data": [8,2,8,5]
                        }
                    }
                ]
            }
        ]
    },
    "msg":"communication"
}

The 'frame' is what the message received is, it has three components:

  • tag -- what this frame is about (eg. message will have 'message')
  • attrs -- a string key-value pair with some metadata (contains ID of the message usually)
  • content -- the actual data (eg. a message node will have the actual message content in it)
  • read more about this format here

Register a Callback for Websocket Events

!TIP Recommended to see onMessageReceived function in socket.ts file to understand how websockets events are fired

// for any message with tag 'edge_routing'
suki.ws.on('CB:edge_routing', (node: BinaryNode) => { })

// for any message with tag 'edge_routing' and id attribute = abcd
suki.ws.on('CB:edge_routing,id:abcd', (node: BinaryNode) => { })

// for any message with tag 'edge_routing', id attribute = abcd & first content node routing_info
suki.ws.on('CB:edge_routing,id:abcd,routing_info', (node: BinaryNode) => { })

!NOTE Also, this repo is now licenced under GPL 3 since it uses libsignal-node

whatsappjs-whatsappwhatsapp-apiwhatsapp-webwhatsapp-chatwhatsapp-groupautomationmulti-device
@adiwajshing/keyed-db@hapi/boom@adiwajshing/eslint-configasync-lockaudio-decodeaxioscache-managerfutoin-hkdflibphonenumber-jslibsignallodashmusic-metadatanode-cachepinoprotobufjsuuidws
7.0.6

5 months ago

6.7.6

6 months ago

6.6.4

6 months ago