altairwei/tdbot

telegram-bot

A userbot interface for Telegram. Uses TDLib.

API, Protocol documentation

Build Instruction

Linux and BSDs

Install utils and libs: git, cmake, libssl, liblua, gperf, libconfig.

On Ubuntu/Debian use:

sudo apt install git build-essential cmake libssl-dev liblua5.2-dev gperf libconfig++-dev

Note: On Ubuntu, gperf is in its universe repository. So, make sure to enable this repository.

Clone GitHub Repository

git clone --recursive https://github.com/rizaumami/tdbot.git

Optional, but highly recommended. Update td submodule.

cd tdbot
git submodule update --remote --merge
cd ..

Create build folder
```
mkdir tdbot-build
```
Enter build folder
```
cd tdbot-build
```

Configure

cmake -DCMAKE_BUILD_TYPE=Release ../tdbot

Start build process
```
make telegram-bot
```
The compiled telegram-bot binary can be found inside tdbot-build folder.

Usage

First of all you need to create config. Default config name is config which is located in ${HOME}/.telegram-bot/ or ${HOME}/.config/telegram-bot/.
Then you need to login. You can login as:
1. Bot.
```
telegram-bot -p profile-name --login --bot=BOT-TOKEN
```
2. User.
```
telegram-bot -p profile-name --login --phone=PHONE-NUMBER
```
  Use country code in the PHONE-NUMBER. Example: 621234567890, where +62 is code for Indonesia.
Now you can run commands. There are two ways to do it:
1. Use JSON interface (via stdin or tcp connections)
  1. Run telegram-bot as a daemon.
    Example, to run telegram-bot as a daemon and listening to port 1337:
```
telegram-bot -dP 1337
```
  2. Enter a JSON formatted message:
```
echo -e '{"@type":"sendMessage","chat_id":-1001234567890,"input_message_content":{"@type":"inputMessageText","text":{"text":"PING!"}}}\n' | nc.traditional -w 1 127.0.0.1 1337
```
2. Use Lua script.
```
telegram-bot -s script.lua
```
To understand how to serialize commands you need to read examples and tl scheme.

examples

JSON response (prettyfied)

{
  ["@type"] = "updateNewMessage",
  contains_mention = false,
  disable_notification = true,
  message = {
    ["@type"] = "message",
    author_signature = "",
    can_be_deleted_for_all_users = true,
    can_be_deleted_only_for_self = false,
    can_be_edited = true,
    can_be_forwarded = true,
    chat_id = "-1001234567890",
    contains_unread_mention = false,
    content = {
      ["@type"] = "messageText",
      text = {
        ["@type"] = "formattedText",
        entities = {},
        text = "test"
      }
    },
    date = 1527571645,
    edit_date = 0,
    id = 583008256,
    is_channel_post = false,
    is_outgoing = true,
    media_album_id = "0",
    reply_to_message_id = 0,
    sender_user_id = 123456789,
    ttl = 0,
    ttl_expires_in = 0,
    via_bot_user_id = 0,
    views = 0
  }
}

Configuration file

# This is an empty config file
# Feel free to put something here

default_profile = "main";

main =  {
  # connect to totally separate telegram environment
  # it is used only for tests
  # false is default value
  test = false;

  # folder containing data for this profile
  # default value is profile name
  config_directory = "main";

  # language code. Some telegram notifications
  # may use it. Default is "en"
  language_code = "en";

  # use file db. Allows files reuse after restart
  # default value is true
  use_file_db = true;

  # use file garbage collector. Deletes files unused for 30 days
  # default value is true
  use_file_gc = true;

  # use file names as specified in document description
  # instead telegram-bot can use random names
  # default value is true
  file_readable_names = true;

  # allow accepting and creating secret chats
  # default value is true
  use_secret_chats = true;

  # use chat info db. Allow to send messages to chats instantly after restart
  # default value is true
  use_chat_info_db = true;

  # use message db
  # default value is true
  use_message_db = true;

  # logname. if not starts with '/' is relative to config_directory
  # if empty log to stderr
  # default value is empty
  logname = "log.txt";

  # log verbosity. Default value is 0
  verbosity = 2;

  # LUA script to use. If empty do not use lua. Relative to config_directory
  # default value is empty
  lua_script = "script.lua";
};

test_dc1 = {
  test = true;
  verbosity = 100;
  logname = "log.txt";
};

# in many cases default values are OK, so config is empty
second = {
};

Lua script

function vardump(value, depth, key)
  local linePrefix = ""
  local spaces = ""

  if key ~= nil then
    linePrefix = "["..key.."] = "
  end

  if depth == nil then
    depth = 0
  else
    depth = depth + 1
    for i=1, depth do spaces = spaces .. "  " end
  end

  if type(value) == 'table' then
    mTable = getmetatable(value)
  if mTable == nil then
    print(spaces ..linePrefix.."(table) ")
  else
    print(spaces .."(metatable) ")
    value = mTable
  end
  for tableKey, tableValue in pairs(value) do
    vardump(tableValue, depth, tableKey)
  end
  elseif type(value)  == 'function' or
    type(value) == 'thread' or
    type(value) == 'userdata' or
    value   == nil
  then
    print(spaces..tostring(value))
  else
    print(spaces..linePrefix.."("..type(value)..") "..tostring(value))
  end
end


function dl_cb (arg, data)
  vardump (data)
end

function tdbot_update_callback (data)
  if (data["@type"] == "updateNewMessage") then
    local msg = data.message

    if msg.content["@type"] == "messageText" then
      if msg.content.text.text == "ping" then
        assert (tdbot_function ({
          ["@type"] = "sendMessage",
          chat_id = msg.chat_id,
          reply_to_message_id = msg.id,
          disable_notification = 0,
          from_background = 1,
          reply_markup = nil,
          input_message_content = {
            ["@type"] = "inputMessageText",
            text = "pong",
            disable_web_page_preview = 1,
            clear_draft = 0,
            entities = {},
            parse_mode = nil
          }
        }
      end
    end
  end
end

See https://github.com/rizaumami/tdbot.lua, a wrapper to simplify tdbot based bot development.

altairwei / tdbot