• Whatsva - WhatsApp Web API

Whatsva fully uses nodejs without Selenium or any other browser to connect to WhatsApp Web. how to work whatsva via WebSocket and connect to Whatsapp Web. that way it can save ram usage on the server.

• Install Create and cd to your NPM project directory and then in terminal, write: npm install whatsva Then import in your code using:

    const WAWeb = require('whatsva') 

• Connecting

    const client = new WAWeb() 
    client.connect() 
    .then (([user, chats, contacts, unread]) => {
        console.log ("oh hello " + user.name + " (" + user.id + ")")
        console.log ("you have " + unread.length + " unread messages")
        console.log ("you have " + chats.length + " chats")
    })
    .catch (err => console.log("unexpected error: " + err) )

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!

If you don't want to wait for WhatsApp to send all your chats while connecting, you can use the following function:

    const client = new WAWeb() 
    client.connectSlim() // does not wait for chats & contacts
    .then (user => {
        console.log ("oh hello " + user.name + " (" + user.id + ")")
        
        client.receiveChatsAndContacts () // wait for chats & contacts in the background
        .then (([chats, contacts, unread]) => {
            console.log ("you have " + unread.length + " unread messages")
            console.log ("you have " + chats.length + " chats")
        })
    })
    .catch (err => console.log("unexpected error: " + err))

• Handling Events Implement the following callbacks in your code:

• Called when you have a pending unread message or recieve a new message

  client.setOnUnreadMessage (m => {
      const [notificationType, messageType] = client.getNotificationType(m) // get what type of notification it is -- message, group add notification etc.
      console.log("got notification of type: " + notificationType) // message, groupAdd, groupLeave
      console.log("message type: " + messageType) // conversation, imageMessage, videoMessage, contactMessage etc.
  }, false) // set to `true` if you want to receive outgoing messages that may be sent from your phone

• Called when you recieve an update on someone's presence, they went offline or online

  client.setOnPresenceUpdate (json => console.log(json.id + " presence is " + json.type))

• Called when your message gets delivered or read

  client.setOnMessageStatusChange (json => {
      let sent = json.to
      if (json.participant) // participant exists when the message is from a group
          sent += " ("+json.participant+")" // mention as the one sent to
      // log that they acknowledged the message
      console.log(sent + " acknowledged message(s) " + json.ids + " as " + json.type + " at " + json.timestamp)
  })

• Called when the connection gets disconnected (either the server loses internet or the phone gets unpaired)

  client.setOnUnexpectedDisconnect (err => console.log ("disconnected unexpectedly: " + err) )

• Sending Messages It's super simple

• Send text messages using

  client.sendTextMessage(id, "oh hello there!") 

• Send text messages & quote another message using

      const options = {quoted: quotedMessage}
      client.sendTextMessage(id, "oh hello there", options) 

  quotedMessage is a message object

• Send a location using

      client.sendLocationMessage(id, 24.121231, 55.1121221) // the latitude, longitude of the location

• Send a contact using

      // format the contact as a VCARD
      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'
      client.sendContactMessage(id, "Jeff", vcard) 

• Send a media (image, video, sticker, pdf) message using

      const buffer = fs.readFileSync("example/ma_gif.mp4") // load some gif
      const options = {gif: true, caption: "hello!"} // some metadata & caption
      client.sendMediaMessage(id, buffer, WAWeb.MessageType.video, options)

  • The thumbnail can be generated automatically for images & stickers. Though, to automatically generate thumbnails for videos, you need to have ffmpeg installed on your system
  • mediaBuffer is just a Buffer containing the contents of the media you want to send
  • mediaType represents the type of message you are sending. This can be one of the following:

        [
            WAWeb.MessageType.image, // an image message
            WAWeb.MessageType.video, // a video message
            WAWeb.MessageType.audio, // an audio message
            WAWeb.MessageType.sticker // a sticker message
        ]

  • Tested formats: png, jpeg, webp (sticker), mp4, ogg

The last parameter when sending messages is info, a JSON object, providing some information about the message. It can have the following optional values:

info = {
    caption: "hello there!", // (for media messages) the caption to send with the media (cannot be sent with stickers though)
    thumbnail: "23GD#4/==", /*  (for location & media messages) has to be a base 64 encoded JPEG if you want to send a custom thumb, 
                                or set to null if you don't want to send a thumbnail.
                                Do not enter this field if you want to automatically generate a thumb
                            */
    mimetype: "application/pdf", /* (for media messages) specify the type of media (optional for all media types except documents),
                                    for pdf files => set to "application/pdf",
                                    for txt files => set to "application/txt"
                                    etc.
                                */
    gif: true, // (for video messages) if the video should be treated as a GIF
    quoted: quotedMessage, // the message you want to quote (can be used with sending all kinds of messages)
    timestamp: Date() // optional, if you want to manually set the timestamp of the message
}

id is the WhatsApp id of the person or group you're sending the message to.

It must be in the format [country code][phone number]@s.whatsapp.net, for example [email protected] for people. For groups, it must be in the format [email protected]. Do not attach @c.us for individual people IDs, It won't work

• Sending Read Receipts

    client.sendReadReceipt(id, messageID) 

The id is in the same format as mentioned earlier. The message ID is the unique identifier of the message that you are marking as read. On a message object, it can be accessed using messageID = message.key.id.

• Update Presence

    client.updatePresence(id, WAWeb.Presence.available) 

This lets the person/group with id know whether you're online, offline, typing etc. where presence can be one of the following:

    [
        WAWeb.Presence.available, // online
        WAWeb.Presence.unavailable, // offline
        WAWeb.Presence.composing, // typing...
        WAWeb.Presence.recording // recording...
    ]

• Decoding Media If you want to save & process some images, videos, documents or stickers you received

    client.setOnUnreadMessage (m => {
        const messageType = client.getMessageType(m.message) // get what type of message it is -- text, image, video
        // if the message is not a text message
        if (messageType !== WAWeb.MessageType.text && messageType !== WAWeb.MessageType.extendedText) {
            client.decodeMediaMessage(m.message, "filename") // extension applied automatically
            .then (meta => console.log(m.key.remoteJid + " sent media, saved at: " + meta.filename))
            .catch (err => console.log("error in decoding message: " + err))
        }
    }

• Restoring Sessions Once you connect successfully, you can get your authentication credentials using

    const authJSON = client.base64EncodedAuthInfo() 

Then you can use this JSON to log back in without needing to scan a QR code using

    const authJSON = JSON.parse( fs.readFileSync("auth_info.json") )
    client.connect (authJSON)
    .then (([user, chats, contacts, unread]) => console.log ("yay connected"))

• Querying
• To check if a given ID is on WhatsApp

      client.isOnWhatsApp ("[email protected]")
      .then (([exists, id]) => console.log(id + (exists ? " exists " : " does not exist") + "on WhatsApp"))

• To query chat history on a group or with someone

  client.loadConversation ("[email protected]", 25) // query the last 25 messages (replace 25 with the number of messages you want to query)
  .then (messages => console.log("got back " + messages.length + " messages"))

  You can also load the entire conversation history if you want

  client.loadEntireConversation ("[email protected]", (message) => console.log("Loaded message with ID: " + message.key.id))
  .then (() => console.log("queried all messages")) // promise resolves once all messages are retreived

• To get the status of some person

  client.getStatus ("[email protected]") // leave empty to get your own
  .then ((json, q) => console.log("status: " + json.status))

• To get the display picture of some person/group

  client.getProfilePicture ("[email protected]") // leave empty to get your own
  .then (([json, q]) => console.log("download profile picture from: " + json.eurl))

• To get someone's presence (if they're typing, online)

  client.requestPresenceUpdate ("[email protected]")
  // the presence update is fetched and called here
  client.setOnPresenceUpdate (json => console.log(json.id + " presence is " + json.type))

Of course, replace xyz with an actual ID. Also, append @c.us for individuals & @g.us for groups.

• Groups
• To query the metadata of a group

  client.groupMetadata ("[email protected]")
  .then (([json, _]) => console.log(json.id + ", title: " + json.subject + ", description: " + json.desc))

• To create a group

  client.groupCreate ("My Fab Group", ["[email protected]", "[email protected]"]) // title & participants
  .then (([json, _]) => {
      console.log ("created group with id: " + json.gid)
      client.sendTextMessage(json.gid, "hello everyone") // say hello to everyone on the group
  })

• To add people to a group

  client.groupAdd ("[email protected]", ["[email protected]", "[email protected]"]) // id & people to add to the group
  .then (([json, _]) => console.log("added successfully: " + (json.status===200)))

• To make someone admin on a group

  client.groupMakeAdmin ("[email protected]", ["[email protected]", "[email protected]"]) // id & people to make admin
  .then (([json, _]) => console.log("made admin successfully: " + (json.status===200)))

• To leave a group

  client.groupLeave ("[email protected]")
  .then (([json, _]) => console.log("left group successfully: " + (json.status===200)))

• To get the invite code for a group

  client.groupInviteCode ("[email protected]")
  .then (code => console.log(code))
  

#- Note we are not affiliated with WhatsApp. It is written for educational purposes only. Use at your own discretion.