{"id":16098738,"url":"https://github.com/awaitlink/vk-chat-bot","last_synced_at":"2026-01-24T05:01:23.531Z","repository":{"id":32358424,"uuid":"112863720","full_name":"awaitlink/vk-chat-bot","owner":"awaitlink","description":":package: node package for building chat bots for VK communities (uses Callback API)","archived":false,"fork":false,"pushed_at":"2023-01-07T18:54:57.000Z","size":4462,"stargazers_count":23,"open_issues_count":15,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-04T18:15:04.249Z","etag":null,"topics":["api","bot","callback-api","chat","chatbot","easy","library","nodejs","npm","quota","vk"],"latest_commit_sha":null,"homepage":"https://u32i64.github.io/vk-chat-bot/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/awaitlink.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-02T17:50:54.000Z","updated_at":"2025-04-07T20:52:49.000Z","dependencies_parsed_at":"2023-01-14T21:15:26.725Z","dependency_job_id":null,"html_url":"https://github.com/awaitlink/vk-chat-bot","commit_stats":null,"previous_names":["awaitlink/vk-chat-bot","u32i64/vk-chat-bot"],"tags_count":141,"template":false,"template_full_name":null,"purl":"pkg:github/awaitlink/vk-chat-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awaitlink%2Fvk-chat-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awaitlink%2Fvk-chat-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awaitlink%2Fvk-chat-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awaitlink%2Fvk-chat-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/awaitlink","download_url":"https://codeload.github.com/awaitlink/vk-chat-bot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/awaitlink%2Fvk-chat-bot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28712840,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T23:51:44.727Z","status":"online","status_checked_at":"2026-01-24T02:00:06.909Z","response_time":89,"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":["api","bot","callback-api","chat","chatbot","easy","library","nodejs","npm","quota","vk"],"created_at":"2024-10-09T18:24:32.858Z","updated_at":"2026-01-24T05:01:23.496Z","avatar_url":"https://github.com/awaitlink.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vk-chat-bot\n[![version][badges/npm]][npm]\n[![downloads][badges/downloads]][npm]\n[![bundle size][badges/size]][bundlephobia]\n\n\u003e Package for easy creation of chat bots for VK communities (*groups*). Uses Callback API.\u003cbr\u003e\n\u003e **[documentation »][docs]** ⋅\n\u003e **[changelog »][changelog]** ⋅\n\u003e [features](#features) ⋅\n\u003e [usage](#usage) ⋅\n\u003e [contributing](#contributing) ⋅\n\u003e [license](#license)\n\n## Features\n- **Easy to use** — setting up behavior is simple — see [2. Behavior setup](#2-behavior-setup) below\n- **Respects the quota** — the package calls VK API not more then 20 times/second, so you don't exceed the quota\n\nThe version of VK API used by this package can be found [here][api-version].\n\n## Usage\n### Installation\n```console\n$ yarn add vk-chat-bot\n```\n\n### Example\nYou can find an example bot in the [`u32i64/vk-chat-bot-example`][example] repository.\n\n- **Deploying on [Glitch](https://glitch.com/)**\n\n  Simply press the button below and follow the `SETUP.md` file there:\n\n  \u003ca href=\"https://glitch.com/edit/#!/remix/vk-chat-bot-example\"\u003e\u003cimg src=\"https://cdn.glitch.com/2bdfb3f8-05ef-4035-a06e-2043962a3a13%2Fremix%402x.png?1513093958726\" alt=\"remix this\" height=\"33\"\u003e\u003c/a\u003e\n\n- **Deploying on [Heroku](https://heroku.com)**\n\n  You can find a step-by-step guide on deploying the example to Heroku [here](https://github.com/u32i64/vk-chat-bot/blob/master/tutorials/heroku-deploy-guide.md).\n\n### Quick Start\n#### 1. Preparation\nFirst, `require()` the package:\n```js\nconst vk = require('vk-chat-bot');\n```\n\nThen, create your bot using the `vk.bot` function (see [Params object][docs/bot] for more information about `params`):\n```js\nconst params = {\n  vkToken: 'your_vk_access_token',\n  confirmationToken: 'f123456',\n  groupId: 1234567,\n  secret: 's3r10us1y_s3cr3t_phr4s3',\n  port: 12345,\n\n  cmdPrefix: '/'\n};\n\nvar { bot, core } = vk.bot(params);\n```\n\n#### 2. Behavior setup\n\nSee [`Core`][docs/Core] wiki to learn more about behavior functions.\nHere are some examples:\n```js\n// Use stuff from the package...\nconst { Color, button, Keyboard } = vk.kbd;\n\n// ...to create a keyboard like this.\n// +-----------+---------+----------+----------+\n// | Secondary | Primary | Negative | Positive |\n// +-----------+---------+----------+----------+\n// |      Maximum rows is 10, columns - 4.     |\n// +-------------------------------------------+\nvar kbd = new Keyboard([\n  [ /* Row (array of buttons) */\n    button.text('Secondary'),\n    button.text('Primary', Color.Primary),\n    button.text('Negative', Color.Negative),\n    button.text('Positive', Color.Positive)\n  ],\n  [\n    button.text('Maximum rows is 10, columns - 4.')\n  ],\n]);\n\n// When user presses the `Start` button...\n// (you have to enable the button in community settings)\ncore.on('start', $ =\u003e {\n  // ...send them our keyboard.\n  $.text('Thanks for messaging us! Choose from the options below:');\n  $.keyboard(kbd);\n\n  // Here, $.send() is added automatically.\n});\n```\n```js\n// Searches for cmd_prefix + 'help', e.g. '/help'\ncore.cmd('help', $ =\u003e {\n  // core.help() returns the help message\n  $.text('Test Bot v1.0' + core.help());\n\n  // Attach an image from\n  // https://vk.com/team?z=photo6492_45624077\n  $.attach('photo', 6492, 456240778);\n}, 'shows the help message');\n```\n```js\n// Use case-insensitive regular expression to find words 'hi', 'hello' or 'hey'\ncore.regex(/h(i|ello|ey)/i, $ =\u003e {\n  $.text('Hello, I am a test bot. You said: ' + $.msg);\n});\n```\n\n#### 3. Start it!\nStart the bot:\n\n```js\nbot.start();\n```\n\nThe bot will log some useful information, see [Logging][docs/Stats] documentation for more information.\n\n## Contributing\n- Something does not seem right or you have a feature request? **Open an [issue][issues].**\n- You know how to make `vk-chat-bot` better? **Open a [pull request][pulls]!**\n\n## License\nThis project is licensed under the terms of the **[MIT][license]** license.\n\n\u003c!-- LINKS --\u003e\n\n[badges/npm]:       https://img.shields.io/npm/v/vk-chat-bot.svg?style=for-the-badge\u0026logo=npm\n[badges/downloads]: https://img.shields.io/npm/dt/vk-chat-bot.svg?style=for-the-badge\n[badges/size]: https://img.shields.io/bundlephobia/minzip/vk-chat-bot?style=for-the-badge\n\n[bundlephobia]: https://bundlephobia.com/result?p=vk-chat-bot\n\n[api-version]: https://github.com/u32i64/vk-chat-bot/blob/master/src/api/api.ts#L9\n\n[npm]:    https://www.npmjs.com/package/vk-chat-bot\n\n[changelog]: https://github.com/u32i64/vk-chat-bot/blob/master/CHANGELOG.md\n[license]:   https://github.com/u32i64/vk-chat-bot/blob/master/LICENSE\n\n[docs]:                     https://u32i64.github.io/vk-chat-bot/\n[docs/Core]:                https://u32i64.github.io/vk-chat-bot/classes/_core_.core.html\n[docs/Stats]:               https://u32i64.github.io/vk-chat-bot/classes/_extra_stats_.stats.html\n[docs/Heroku-Deploy-Guide]: https://github.com/u32i64/vk-chat-bot/blob/master/tutorials/heroku-deploy-guide.md\n[docs/bot]:                 https://u32i64.github.io/vk-chat-bot/modules/_main_.html#bot\n\n[example]: https://github.com/u32i64/vk-chat-bot-example\n[issues]:  https://github.com/u32i64/vk-chat-bot/issues\n[pulls]:   https://github.com/u32i64/vk-chat-bot/pulls\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fawaitlink%2Fvk-chat-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fawaitlink%2Fvk-chat-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fawaitlink%2Fvk-chat-bot/lists"}