https://github.com/yangm97/lua-telegram-bot-api

Telegram Bot API bindings and utilities
https://github.com/yangm97/lua-telegram-bot-api

lua openresty telegram telegram-api telegram-bot telegram-bot-api

Last synced: 3 months ago
JSON representation

Telegram Bot API bindings and utilities

• Host: GitHub
• URL: https://github.com/yangm97/lua-telegram-bot-api
• Owner: yangm97
• License: mit
• Created: 2017-06-26T08:25:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-06-09T10:42:50.000Z (over 5 years ago)
• Last Synced: 2024-05-22T17:33:50.246Z (6 months ago)
• Topics: lua, openresty, telegram, telegram-api, telegram-bot, telegram-bot-api
• Language: Lua
• Homepage:
• Size: 49.8 KB
• Stars: 17
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lua Telegram Bot API

This package provides API bindings and utilities for developing Telegram Bots. Contains bindings for all Bot API 3.5 methods. Supports both OpenResty and plain lua.

## Usage

You can call methods using either positional arguments or by sending a single body table, either way the table is serialized as JSON and the request is sent. On return, the json response is deserialized for you, if the request was successful, you will receive the `.result` as a lua table, if something goes wrong, you will receive `nil` and the whole error table.

## Example

Using positional arguments:

```

local Methods = require("telegram-bot-api.methods")

local api = Methods:new("123456789:ABCDefGhw3gUmZOq36-D_46_AMwGBsfefbcQ")

local ok, err = api.sendMessage(12345678, "Hello World", "html")

if not ok then

  print("Error while sending message: "..err.description)

end

```

Using body table (snake_case is supported too!):

```

local api = require("telegram-bot-api.methods"):new("123456789:ABCDefGhw3gUmZOq36-D_46_AMwGBsfefbcQ")

local ok, err = api.send_message{

  chat_id = 12345678,

  text = "Hello World",

  parse_mode = "html"

  }

if not ok then

  print("Error while sending message: "..err.description)

end

```

## Customizing

You can also set a custom set a custom server as the second init argument, and call custom methods, like this:

```

local Methods = require("telegram-bot-api.methods")

local api = Methods:new({

  token = "123456789:ABCDefGhw3gUmZOq36-D_46_AMwGBsfefbcQ",

  server="api.pwrtelegram.xyz"

})

local ok, err = api.phoneLogin{phone="+3984748839"}

if not ok then

  print("Error while using phoneLogin: "..err.description)

end

```

## Finishing lines

Both argument names and variable positioning try to mirror Telegram documentation as closely as possible, but you may prefer using `lib/telegram-bot-api/methods.lua` as a reference. The library will also try to warn you regarding missing required arguments before making a request.