{"id":13406173,"url":"https://github.com/wppconnect-team/wppconnect","last_synced_at":"2026-07-15T06:01:00.261Z","repository":{"id":36990665,"uuid":"332585863","full_name":"wppconnect-team/wppconnect","owner":"wppconnect-team","description":"WPPConnect is an open source project developed by the JavaScript community with the aim of exporting functions from WhatsApp Web to the node, which can be used to support the creation of any interaction, such as customer service, media sending, intelligence recognition based on phrases artificial and many other things, use your imagination","archived":false,"fork":false,"pushed_at":"2026-07-05T20:53:27.000Z","size":84301,"stargazers_count":3357,"open_issues_count":36,"forks_count":550,"subscribers_count":69,"default_branch":"master","last_synced_at":"2026-07-05T22:13:22.570Z","etag":null,"topics":["ai","api","automate","bot","chat","chatbot","framework","message","nodejs","open-source","puppeteer","sulla","typescript","wa","whatsapp","whatsapp-api","whatsapp-bot","wpp","wppconnect","zap-api"],"latest_commit_sha":null,"homepage":"https://wppconnect.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wppconnect-team.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["icleitoncosta","joaosouz4dev"],"open_collective":"wppconnect"}},"created_at":"2021-01-25T00:10:32.000Z","updated_at":"2026-07-05T20:52:40.000Z","dependencies_parsed_at":"2026-02-28T16:05:55.336Z","dependency_job_id":null,"html_url":"https://github.com/wppconnect-team/wppconnect","commit_stats":{"total_commits":2228,"total_committers":35,"mean_commits":63.65714285714286,"dds":0.6404847396768403,"last_synced_commit":"1ea86b84dca92e80e0b2dc10349919cd6fb44159"},"previous_names":[],"tags_count":161,"template":false,"template_full_name":null,"purl":"pkg:github/wppconnect-team/wppconnect","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wppconnect-team%2Fwppconnect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wppconnect-team%2Fwppconnect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wppconnect-team%2Fwppconnect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wppconnect-team%2Fwppconnect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wppconnect-team","download_url":"https://codeload.github.com/wppconnect-team/wppconnect/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wppconnect-team%2Fwppconnect/sbom","scorecard":{"id":31659,"data":{"date":"2025-08-04","repo":{"name":"github.com/wppconnect-team/wppconnect","commit":"097980fcc62f4838797768c7cbf7b1f2d3778316"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":5.4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/25 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build.yml:1","Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1","Warn: no topLevel permission defined: .github/workflows/commitlint.yml:1","Warn: no topLevel permission defined: .github/workflows/lint.yml:1","Warn: no topLevel permission defined: .github/workflows/nightly.yml:1","Warn: no topLevel permission defined: .github/workflows/publish.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/build.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/codeql-analysis.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/commitlint.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/commitlint.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/commitlint.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/commitlint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nightly.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/nightly.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nightly.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/nightly.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nightly.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/nightly.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/nightly.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/nightly.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/nightly.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/nightly.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/publish.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/publish.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/wppconnect-team/wppconnect/release.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/build.yml:37","Warn: npmCommand not pinned by hash: .github/workflows/lint.yml:37","Warn: npmCommand not pinned by hash: .github/workflows/nightly.yml:40","Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:42","Warn: npmCommand not pinned by hash: .github/workflows/release.yml:50","Info:   0 out of  21 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   4 third-party GitHubAction dependencies pinned","Info:   5 out of  10 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact nightly not signed: https://api.github.com/repos/wppconnect-team/wppconnect/releases/36833944","Warn: release artifact nightly does not have provenance: https://api.github.com/repos/wppconnect-team/wppconnect/releases/36833944"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/publish.yml:9"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: SAST configuration detected: CodeQL","Info: all commits (28) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-14T19:15:18.245Z","repository_id":36990665,"created_at":"2025-08-14T19:15:18.245Z","updated_at":"2025-08-14T19:15:18.245Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35493172,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-15T02:00:06.706Z","response_time":131,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","api","automate","bot","chat","chatbot","framework","message","nodejs","open-source","puppeteer","sulla","typescript","wa","whatsapp","whatsapp-api","whatsapp-bot","wpp","wppconnect","zap-api"],"created_at":"2024-07-30T19:02:23.180Z","updated_at":"2026-07-15T06:01:00.212Z","avatar_url":"https://github.com/wppconnect-team.png","language":"TypeScript","funding_links":["https://github.com/sponsors/icleitoncosta","https://github.com/sponsors/joaosouz4dev","https://opencollective.com/wppconnect"],"categories":["TypeScript","Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# WPPConnect 📞\n\n![WPPConnect Banner](./img/wppconnect-banner.jpeg)\n\n[![npm version](https://img.shields.io/npm/v/@wppconnect-team/wppconnect.svg?color=green)](https://www.npmjs.com/package/@wppconnect-team/wppconnect)\n[![Downloads](https://img.shields.io/npm/dm/@wppconnect-team/wppconnect.svg)](https://www.npmjs.com/package/@wppconnect-team/wppconnect)\n[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/wppconnect-team/wppconnect.svg)](https://isitmaintained.com/project/wppconnect-team/wppconnect 'Average time to resolve an issue')\n[![Percentage of issues still open](https://isitmaintained.com/badge/open/wppconnect-team/wppconnect.svg)](https://isitmaintained.com/project/wppconnect-team/wppconnect 'Percentage of issues still open')\n[![Build Status](https://img.shields.io/github/actions/workflow/status/wppconnect-team/wppconnect/build.yml?branch=master)](https://github.com/wppconnect-team/wppconnect/actions)\n[![Lint Status](https://img.shields.io/github/actions/workflow/status/wppconnect-team/wppconnect/lint.yml?branch=master\u0026label=lint)](https://github.com/wppconnect-team/wppconnect/actions)\n[![release-it](https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9A%80-release--it-e10079.svg)](https://github.com/release-it/release-it)\n\n\u003e WPPConnect is an open source project developed by the JavaScript community with the aim of exporting functions from WhatsApp Web to the node, which can be used to support the creation of any interaction, such as customer service, media sending, intelligence recognition based on phrases artificial and many other things, use your imagination... 😀🤔💭\n\n\u003cp align=\"center\"\u003e\n  \u003ca target=\"_blank\" href=\"https://wppconnect.io/docs/tutorial/basics/installation\"\u003eGetting Started\u003c/a\u003e •\n  \u003ca target=\"_blank\" href=\"https://wppconnect.io/docs/tutorial/basics/basic-functions\"\u003eBasic Function\u003c/a\u003e •\n  \u003ca target=\"_blank\" href=\"https://wppconnect.io/wppconnect\"\u003eDocumentation\u003c/a\u003e\n\u003c/p\u003e\n\n## Our online channels\n\n[![Discord](https://img.shields.io/discord/844351092758413353?color=blueviolet\u0026label=Discord\u0026logo=discord\u0026style=flat)](https://discord.gg/JU5JGGKGNG)\n[![Telegram Group](https://img.shields.io/badge/Telegram-Group-32AFED?logo=telegram)](https://t.me/wppconnect)\n[![WhatsApp Group](https://img.shields.io/badge/WhatsApp-Group-25D366?logo=whatsapp)](https://chat.whatsapp.com/LJaQu6ZyNvnBPNAVRbX00K)\n[![YouTube](https://img.shields.io/youtube/channel/subscribers/UCD7J9LG08PmGQrF5IS7Yv9A?label=YouTube)](https://www.youtube.com/c/wppconnect)\n\n## Functions\n\n|                                                            |     |\n| ---------------------------------------------------------- | --- |\n| Automatic QR Refresh                                       | ✔   |\n| Send **text, image, video, audio and docs**                | ✔   |\n| Get **contacts, chats, groups, group members, Block List** | ✔   |\n| Send contacts                                              | ✔   |\n| Send stickers                                              | ✔   |\n| Send stickers GIF                                          | ✔   |\n| Multiple Sessions                                          | ✔   |\n| Forward Messages                                           | ✔   |\n| Receive message                                            | ✔   |\n| insert user section                                        | ✔   |\n| Send _location_                                            | ✔   |\n| **and much more**                                          | ✔   |\n\nSee more at \u003ca target=\"_blank\" href=\"https://wppconnect.io/wppconnect/classes/Whatsapp.html\"\u003eWhatsApp methods\u003c/a\u003e\n\n## Installation\n\nThe first thing that you had to do is install the `npm package` :\n\n```bash\nnpm i --save @wppconnect-team/wppconnect\n```\n\nSee more at \u003ca target=\"_blank\" href=\"https://wppconnect.io/docs/tutorial/basics/installation\"\u003eGetting Started\u003c/a\u003e\n\n## Development\n\nBuilding WPPConnect is really simple, to build the entire project just run\n\n```bash\n\u003e npm run build\n```\n\n# Update checking\n\nWhatsapp is in constant change. In order to tackle this issue, we suggest always keeping your Wppconnect package up-to-date.\n\nThe method/function names won't change, only their core algorithm. This way you won't have to makes changes in your code at every update.\nThey will remain the same forever but might experience deprecation.\n\n## Maintainers\n\nMaintainers are needed, I cannot keep with all the updates by myself. If you are\ninterested please open a Pull Request.\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to\ndiscuss what you would like to change.\n\n## Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=wppconnect-team/wppconnect,wppconnect-team/wa-js\u0026type=Date)](https://star-history.com/#wppconnect-team/wppconnect\u0026wppconnect-team/wa-js\u0026Date)\n\n## License\n\nThis file is part of WPPConnect.\n\nWPPConnect is free software: you can redistribute it and/or modify\nit under the terms of the GNU Lesser General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nWPPConnect is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Lesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License\nalong with WPPConnect. If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwppconnect-team%2Fwppconnect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwppconnect-team%2Fwppconnect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwppconnect-team%2Fwppconnect/lists"}