{"_id":"@acampagnaro/whatsapp-web.js","_rev":"2-cb4fdf0d1461f5e008ea7fb34b5638ba","name":"@acampagnaro/whatsapp-web.js","dist-tags":{"latest":"1.14.1"},"versions":{"1.14.1":{"name":"@acampagnaro/whatsapp-web.js","version":"1.14.1","description":"Library for interacting with the WhatsApp Web API ","main":"./index.js","typings":"./index.d.ts","scripts":{"example":"node ./example.js","test":"mocha tests","shell":"node --experimental-repl-await ./shell.js","generate-docs":"jsdoc --configure .jsdoc.json --verbose"},"repository":{"type":"git","url":"git+https://github.com/pedroslopez/whatsapp-web.js.git"},"keywords":["whatsapp","whatsapp-web","api","bot","client","node"],"author":{"name":"acampagnaro"},"license":"Apache-2.0","bugs":{"url":"https://github.com/pedroslopez/whatsapp-web.js/issues"},"homepage":"https://guide.wwebjs.dev/","dependencies":{"@pedroslopez/moduleraid":"^5.0.2","fluent-ffmpeg":"^2.1.2","jsqr":"^1.3.1","mime":"^2.4.5","node-webpmux":"^3.1.0","puppeteer":"^10.1.0","sharp":"^0.28.3"},"devDependencies":{"@types/node-fetch":"^2.5.11","chai":"^4.3.4","dotenv":"^10.0.0","eslint":"^7.27.0","eslint-plugin-mocha":"^9.0.0","jsdoc":"^3.6.4","jsdoc-baseline":"^0.1.5","mocha":"^9.0.2","sinon":"^11.1.1"},"engines":{"node":">=12.0.0"},"gitHead":"51a4ad9796e01fe3550fe68a9cb12476faf82b2b","_id":"@acampagnaro/whatsapp-web.js@1.14.1","_nodeVersion":"14.6.0","_npmVersion":"6.14.6","dist":{"integrity":"sha512-JVgD7AkftAJV5ndjYvf2jQZlmfjVzhYZsvuYdnLGxoOM+rNOhF6I9VnBPFG3hbwfTboiOZQrgjmgoqzoTofqbA==","shasum":"eee3cd03fe9ba12affbcf0078b47dbcad9f0e959","tarball":"https://registry.npmjs.org/@acampagnaro/whatsapp-web.js/-/whatsapp-web.js-1.14.1.tgz","fileCount":117,"unpackedSize":15468053,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhuyV4CRA9TVsSAnZWagAAJOUQAIrLKunb+FdSk56SdqlN\nDSALggCBKVIZ9UyIoMxOBqzua63V3V2ewwR8gljx8kbESfMm8gOQq4zIfXNs\ne/CjvI2h7PVD04ePyBPM/X6Gt5Efl8t/jl7ADZi32zYA9ni/q1CI+pLO0vFQ\nSXAOffg2JmGwBOPAiEQ1PFK6U1ch/2GMlI9EP5nr9A7vRAHIZ5/f7C9aqdsn\nquWg1/lbBESgVff2fddJtUmDoC5Kh6KojmZR6kvn/qTS1bPSPA3LHGx3oCjz\niKB0ViRoET91Os03PiS3Y4WU1AFTHdboN1vhSSYLW3Exqlq0hmi14vuIQLq7\nCPw2DMySqeXGVS1F2gV91wlEV9mLil54V9qKdNrmchg5+SgIWi/GgmLBWpx4\n5gpV4PMwBw8+hsFCFQC9X1ESEVI07ob4dwIk5UwP7gQdLsmKiu1Je6dC7Xa4\nD09yfiurABrvCTrFKmRmzTLZO8qt5hz3Jl+3SlfZB6mbDFTycG3crcBMiWrs\nHhx+gpryo+GwJNRuQGJ3VjV299/lJzwVj/kyBYmg5ZrpccF1lVHMBXROu5CG\ncqK3uGLgCwqikSvxFZfKrGyHP1VeeBk2MB/fhkre86ixmrEHi8EDkyI10T3w\n+VuYWkA3bbU8XWAMQ+8JrKBlMvs59weVQY8MFu6cB1Cmfw5bBqAUIpMdN3O3\ngPN7\r\n=EzQd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCq5ccBcjp/zHhaRlvF6iBs8MU45ydgeANMOeVVp6JIdQIhAL6t8btfMgmE1pz/LAyYg+10Qv27mLl0OdK1qfT2OoWx"}]},"_npmUser":{"name":"acampagnaro","email":"alexandre.campagnaro@gmail.com"},"directories":{},"maintainers":[{"name":"acampagnaro","email":"alexandre.campagnaro@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/whatsapp-web.js_1.14.1_1634057037986_0.23919197701157513"},"_hasShrinkwrap":false}},"time":{"created":"2021-10-12T16:43:57.931Z","1.14.1":"2021-10-12T16:43:58.216Z","modified":"2022-04-04T11:05:40.944Z"},"maintainers":[{"name":"acampagnaro","email":"alexandre.campagnaro@gmail.com"}],"description":"Library for interacting with the WhatsApp Web API ","homepage":"https://guide.wwebjs.dev/","keywords":["whatsapp","whatsapp-web","api","bot","client","node"],"repository":{"type":"git","url":"git+https://github.com/pedroslopez/whatsapp-web.js.git"},"author":{"name":"acampagnaro"},"bugs":{"url":"https://github.com/pedroslopez/whatsapp-web.js/issues"},"license":"Apache-2.0","readme":"[![npm](https://img.shields.io/npm/v/whatsapp-web.js.svg)](https://www.npmjs.com/package/whatsapp-web.js) [![Depfu](https://badges.depfu.com/badges/4a65a0de96ece65fdf39e294e0c8dcba/overview.svg)](https://depfu.com/github/pedroslopez/whatsapp-web.js?project_id=9765) ![WhatsApp_Web 2.2126.14](https://img.shields.io/badge/WhatsApp_Web-2.2126.14-brightgreen.svg) [![Discord Chat](https://img.shields.io/discord/698610475432411196.svg?logo=discord)](https://discord.gg/H7DqQs4)  \n\n# whatsapp-web.js\nA WhatsApp API client that connects through the WhatsApp Web browser app\n\nIt uses Puppeteer to run a real instance of Whatsapp Web to avoid getting blocked.\n\n**NOTE:** I can't guarantee you will not be blocked by using this method, although it has worked for me. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe.\n\n## Installation\n\nThe module is now available on npm! `npm i whatsapp-web.js`\n\nPlease note that Node v12+ is required.\n\n## Example usage\n\n```js\nconst { Client } = require('whatsapp-web.js');\n\nconst client = new Client();\n\nclient.on('qr', (qr) => {\n    // Generate and scan this code with your phone\n    console.log('QR RECEIVED', qr);\n});\n\nclient.on('ready', () => {\n    console.log('Client is ready!');\n});\n\nclient.on('message', msg => {\n    if (msg.body == '!ping') {\n        msg.reply('pong');\n    }\n});\n\nclient.initialize();\n```\n\nTake a look at [example.js](https://github.com/pedroslopez/whatsapp-web.js/blob/master/example.js) for another example with more use cases.\n\n## Remote Access\n\nYou could also connect to any previously existing browser instance:\n\n```js\nconst client = new Client({ \n    puppeteer: {\n        browserWSEndpoint: `ws://localhost:3000`\n    }\n});\n```\n\n### Docker\n\n1) Installing a browser using browserless:\n\n```\ndocker run \\\n  --rm \\\n  -p 3000:3000 \\\n  -e \"MAX_CONCURRENT_SESSIONS=1\" \\\n  browserless/chrome:latest\n```\n\nReference: https://docs.browserless.io/docs/docker-quickstart.html\n\n### Remote Debugging\n\n2) Running a browser with websocket remote debugging enabled:\n> chrome.exe --remote-debugging-port=9222\n\nAfter that check the following webpage and check http://127.0.0.1:9220/json and get the **webSocketDebuggerUrl**\n\n## Supported features\n\n| Feature  | Status |\n| ------------- | ------------- |\n| Send messages  | ✅  |\n| Receive messages  | ✅  |\n| Send media (images/audio/documents)  | ✅  |\n| Send media (video)  | ✅ [(requires google chrome)](https://guide.wwebjs.dev/features/handling-attachments#caveat-for-sending-videos-and-gifs)  |\n| Send stickers | ✅ |\n| Receive media (images/audio/video/documents)  | ✅  |\n| Send contact cards | ✅ |\n| Send location | ✅ |\n| Receive location | ✅ | \n| Message replies | ✅ |\n| Join groups by invite  | ✅ |\n| Get invite for group  | ✅ |\n| Modify group info (subject, description)  | ✅  |\n| Modify group settings (send messages, edit info)  | ✅  |\n| Add group participants  | ✅  |\n| Kick group participants  | ✅  |\n| Promote/demote group participants | ✅ |\n| Mention users | ✅ |\n| Mute/unmute chats | ✅ |\n| Block/unblock contacts | ✅ |\n| Get contact info | ✅ |\n| Get profile pictures | ✅ |\n| Set user status message | ✅ |\n\nSomething missing? Make an issue and let us know!\n\n## Links\n\n* [Reference](https://docs.wwebjs.dev/)\n* [Guide](https://guide.wwebjs.dev/) _(work in progress)_\n* [GitHub](https://github.com/pedroslopez/whatsapp-web.js)\n* [npm](https://npmjs.org/package/whatsapp-web.js)\n\n## Contributing\n\nPull requests are welcome! If you see something you'd like to add, please do. For drastic changes, please open an issue first.\n\n## Donating\n\nYou can support the maintainer of this project through the link below\n\n[![Support via PayPal](https://cdn.rawgit.com/twolfson/paypal-github-button/1.0.0/dist/button.svg)](https://www.paypal.me/psla/)\n\n## Disclaimer\n\nThis project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with WhatsApp or any of its subsidiaries or its affiliates. The official WhatsApp website can be found at https://whatsapp.com. \"WhatsApp\" as well as related names, marks, emblems and images are registered trademarks of their respective owners.\n\n## License\n\nCopyright 2019 Pedro S Lopez\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this project except in compliance with the License.\nYou may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","readmeFilename":"README.md"}