aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 0f709a230fe9f9b759250becb920dcc675e53d7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Telebot

... is a basic _Chicken Scheme_ module to ease the development of Bots interfacing with the [Telegram Bot API](https://core.telegram.org/bots/api).

In this context _basic_ means that the module currently consists of barely more than raw HTTP API calls hidden behind analogously named functions and JSON deserialization provided by the _http-client_ respectively _medea_ eggs.

The maintanance of these API wrappers is simplified by an appropriate _Scheme_ macro that reduces the implementation of new API methods to basically slightly rewriting the documentation.

## Documentation

All _basic_ API wrappers are named the same as their method name and require the bot's token as their first argument. Further parameters are expected as named key value pairs. Note that the library currently only verifies that all required parameters are supplied at all while type verification is left to _Telegram's_ server side logic.

	(sendMessage token
	             chat_id: chat_id
	             text:    text)

All API wrappers return the raw deserialized JSON results as to not limit the options for further parsing unnecessarily.

The only non-API wrapper provided by this library is `pollUpdates` which enables passing updates acquired via long polling of `getUpdates` to an arbitrary function as follows:

	(pollUpdates token
	             (lambda (u)
	               (begin (print-message u)
	                      (echo-message  u))))

## Example

`example/echo.scm` implements a bot that echoes all messages back to their sender.

`example/guess.scm` implements a simple number guessing game.

## Dependencies

* [openssl](http://wiki.call-cc.org/eggref/4/openssl)
* [http-client](http://wiki.call-cc.org/eggref/4/http-client)
* [medea](http://wiki.call-cc.org/eggref/4/medea)
* [loops](http://wiki.call-cc.org/eggref/4/loops)
* [vector-lib](http://wiki.call-cc.org/eggref/4/vector-lib)