Skip to content

zayniddindev/notlify

Repository files navigation

Notlify - Telegram notifier service for sending website contact forms to Telegram with ease!

API that sends requests from the site to the appropriate channel or group via Telegram Bot (without exposing Bot token)

How to run:

Important

You need a server and a MySQL database to run Notlify.

git clone git@github.com:zayniddindev/notlify.git
cd ./notlify
yarn & yarn build
cp .env.example .env
# populate .env with database credentials
yarn start:prod

Usage:

Important

First ask the backend developer to add the project to the database. The following information must be provided:

tg_bot_token - Telegram bot token of the project (obtained via BotFather)

* The bot must be added to a group and must be an admin

Sending request:

[POST] -> /notification

Body :

{
  "uid": "test",
  "message": "<b>test</b>"
}

Response:

{
  "success": true,
  "data": "Message sent successfully!",
  "error": null
}
{
  "success": false,
  "error": "Failure message sending",
  "data": null
}

Getting group ID

If the group is open (public), you enter the username, if it is closed (private), you enter the group ID. To get a private ID, you take the link of any message in the group and get the group ID from inside it, for example, in the link https://t.me/c/1652046431/184, 1652046431 is the group ID

About

API for sending website contact forms to Telegram with ease! 📥

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors