{"id":19458897,"url":"https://github.com/realpeha/telegraf-broadcast","last_synced_at":"2025-04-25T06:30:38.684Z","repository":{"id":45039188,"uuid":"308359582","full_name":"RealPeha/telegraf-broadcast","owner":"RealPeha","description":"Send broadcast messages to all of your bot users/groups/channels for Telegraf.js v3.38 based on Bull Queue","archived":false,"fork":false,"pushed_at":"2021-02-22T15:05:57.000Z","size":54,"stargazers_count":15,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-20T10:55:29.141Z","etag":null,"topics":["broadcast","message-broadcasting","telegraf"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/telegraf-broadcast","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RealPeha.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-29T14:49:17.000Z","updated_at":"2025-01-30T16:17:25.000Z","dependencies_parsed_at":"2022-09-26T21:01:43.785Z","dependency_job_id":null,"html_url":"https://github.com/RealPeha/telegraf-broadcast","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RealPeha%2Ftelegraf-broadcast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RealPeha%2Ftelegraf-broadcast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RealPeha%2Ftelegraf-broadcast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RealPeha%2Ftelegraf-broadcast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RealPeha","download_url":"https://codeload.github.com/RealPeha/telegraf-broadcast/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250766990,"owners_count":21483902,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["broadcast","message-broadcasting","telegraf"],"created_at":"2024-11-10T17:29:08.050Z","updated_at":"2025-04-25T06:30:38.340Z","avatar_url":"https://github.com/RealPeha.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Telegraf Message Broadcast\nSend broadcast messages to all of your bot users/groups/channels for [Telegraf.js](https://github.com/telegraf/telegraf/) based on [Bull Queue](https://github.com/OptimalBits/bull)\n\n## Installation\nJust use npm\n\n    npm i telegraf-broadcast --save\n    \nor yarn\n\n    yarn add telegraf-broadcast\n\n## Usage\nIf you want to make message broadcast in your bot you must have a user database to get their telegram ids.\n\nFor example\n\n```js\nconst users = await SomeDB.getAllMyBotUsers()\n\nconsole.log(users)\n/*\n    [\n        ...\n        {\n            id: 1234,\n            username: 'RealPeha'\n            ...\n        }\n        ...\n    ]\n*/\n\nconst userIds = users.map(user =\u003e user.id)\n\nconsole.log(userIds)\n/*\n    [..., 1234, ...]\n*/\n\nbroadcaster.sendText(userIds, '42')\n```\n\n## Examples\n\n### Send plain text\n\n```javascript\nconst { Telegraf } = require('telegraf')\nconst Broadcaster = require('telegraf-broadcast')\n\nconst bot = new Telegraf(process.env.BOT_TOKEN)\nconst broadcaster = new Broadcaster(bot)\n\nconst userIds = [154674234, 154674235, 154674236, 154674237, 154674239]\n\nbot.start((ctx) =\u003e {\n    broadcaster.sendText(userIds, 'Hello everyone')\n})\n\nbot.launch()\n```\n\n### Send copy of the message\n\n```javascript\nconst userIds = [154674234, 154674235, 154674236, 154674237, 154674239]\n\nbot.command('/broadcast', ctx =\u003e {\n    const replyMessage = ctx.message.reply_to_message\n\n    if (replyMessage) {\n        broadcaster.sendMessage(userIds, ctx.chat.id, replyMessage.message_id)\n    }\n})\n```\n\n### Inject broadcaster to the context\n```javascript\nconst broadcaster = new Broadcaster(bot)\n\nbot.use(broadcaster)\n\n// in another file, for example\nbot.start((ctx) =\u003e {\n    ctx.broadcaster.sendText([154674234], 'Hello everyone')\n})\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frealpeha%2Ftelegraf-broadcast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frealpeha%2Ftelegraf-broadcast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frealpeha%2Ftelegraf-broadcast/lists"}