GithubHelp home page GithubHelp logo

samarets / support-bot Goto Github PK

View Code? Open in Web Editor NEW
5.0 1.0 1.0 1.07 MB

The Telegram support bot is written in Golang

License: MIT License

Go 99.29% Makefile 0.21% Dockerfile 0.50%
bot golang support telegram telegram-bot docker dockerized support-bot

support-bot's Introduction

support-bot

Fast and simple Telegram Support Bot ๐Ÿค–. It will help to connect the user and the support agent quickly and conveniently

Features:

  • All message types are forwarded
  • Message replies work
  • Editing text/caption work
  • Full message editing in queue work
  • Adding/Removing support agents by a special command
  • List of all support agents
  • Post a support request in a separate chat
  • Multilingualism and the ability to easily add your own language
  • Error logging

Admin Commands:

Command Description
set_group Set a group to receive notifications there
add_support Gives the user agent rights
del_support Removes agent rights from the user
get_supports Gets the current list of agents

Agent Commands:

Command Description
break Stop current conversation with user

User Commands:

Command Description
start Get start message
get_id Corresponds to your user ID

How Bot Works:

  1. Your client send question to your bot
  2. The bot sends a notification request to your group or admin PM
  3. Admin or Agents can confirm or decline appeal
  4. If the appeal is declined, the user will receive a special message
  5. If the request is confirmed, the user and the agent are connected to the joint chat

Support Languages:

  • Ukrainian
  • English

If you want to add another language, copy any relevant language, translate it and name the directory with your language and country code. For example: uk-UA

Requirements:

  • Docker (or golang)
  • Docker-Compose (or golang)
  • Makefile

Installation:

  1. Clone this repository git clone https://github.com/samarets/support-bot.git
  2. Create .env file cp .env.example .env
  3. Paste your Bot Token and User ID to .env. Set default language
  4. Run Bot:
    • With Docker: make build
    • Local with Go:
      • go mod download
      • go run cmd/bot/main.go

Images:

Example Bot Image

Contributions:

Any contributions are welcome, also if there are problems in the process, then create an issue

support-bot's People

Contributors

samarets avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

ntustud

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.