telegram-api: Telegram Bot API bindings

[ bsd3, library, web ] [ Propose Tags ]

High-level bindings to the Telegram Bot API


[Skip to Readme]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1.0.0, 0.1.0.1, 0.2.0.0, 0.2.1.0, 0.2.1.1, 0.3.0.0, 0.3.1.0, 0.4.0.0, 0.4.0.1, 0.4.1.0, 0.4.2.0, 0.4.3.0, 0.4.3.1, 0.5.0.0, 0.5.0.1, 0.5.1.1, 0.5.1.2, 0.5.2.0, 0.6.0.0, 0.6.0.1, 0.6.0.2, 0.6.1.0, 0.6.1.1, 0.6.2.0, 0.6.3.0, 0.7.0.0, 0.7.1.0, 0.7.2.0 (info)
Dependencies aeson, base (>=4.7 && <5), bytestring, either, http-client, http-media, http-types, mime-types, servant (>=0.4 && <0.5), servant-client (>=0.4 && <0.5), string-conversions, text, transformers [details]
License BSD-3-Clause
Copyright Alexey Rodiontsev (c) 2016
Author Alexey Rodiontsev
Maintainer alex.rodiontsev@gmail.com
Revised Revision 1 made by Bodigrim at 2021-10-14T21:48:26Z
Category Web
Home page http://github.com/klappvisor/haskell-telegram-api#readme
Source repo head: git clone https://github.com/klappvisor/haskell-telegram-api
Uploaded by klappvisor at 2016-05-13T20:30:31Z
Distributions
Reverse Dependencies 2 direct, 0 indirect [details]
Downloads 17813 total (36 in the last 30 days)
Rating 2.0 (votes: 3) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2016-05-13 [all 1 reports]

Readme for telegram-api-0.3.1.0

[back to package description]

telegram-api

Join the chat at https://gitter.im/klappvisor/haskell-telegram-api

Build Status Hackage Hackage Dependencies Haskell Programming Language BSD3 License

High-level bindings to the Telegram Bot API based on servant library. Both getUpdates request or webhook can be used to receive updates for your bot. Inline mode is supported. Uploading stickers, documents, video, etc is not supported yet, but you can send items which are already uploaded on the Telegram servers.

See list of supported methods below in TODO section.

Usage

getMe example

import Control.Monad
import qualified Data.Text.IO as T
import Data.Maybe
import Web.Telegram.API.Bot

main :: IO ()
main = do
  Right GetMeResponse { user_result = u } <-
    getMe token
  T.putStrLn (user_first_name u)
  where token = Token "bot<token>" -- entire Token should be bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11

sendMessage example

import Control.Monad
import qualified Data.Text.IO as T
import Data.Maybe
import Web.Telegram.API.Bot

main :: IO ()
main = do
  Right MessageResponse { message_result = m } <-
    sendMessage token (SendMessageRequest chatId message (Just Markdown) Nothing Nothing Nothing)
  T.putStrLn (message_id m)
  T.putStrLn (text m)
  where token = Token "bot<token>" -- entire Token should be bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
        chatId = "<chat_id> or <@channelusername>" 
        message = "text *bold* _italic_ [github](github.com/klappvisor/haskell-telegram-api)"

Contribution

Contributions are welcome!

  1. Fork repository
  2. Do some changes
  3. Create pull request
  4. Wait for CI build and review
  5. ??????
  6. PROFIT

You can use stack to build project

stack build

To run test you have to create your own bot. Go to BotFather and create the bot. As the result you will have private bot's access token. Keep it safe!

stack test --test-arguments "$BOT_TOKEN $CHAT_ID $BOT_NAME"

where

  • $BOT_TOKEN is token obtained from BotFather with prefix <token from BotFather>
  • $CHAT_ID can be id of your chat with your bot. Send some message to this chat in Telegram and do curl "https://api.telegram.org/bot<replace_with_token>/getUpdates", you have to parse some JSON with your brain ;-) or any other suitable tool and you will find chat id there.
  • $BOT_NAME name of your bot

Note: Inline Spec is disabled for now...

If everything is fine after test you will see receive a few new messages from your bot.

TODO

  • Uploading of Files, Documents, Stickers, etc

Methods

Currently supported:
  • getMe
  • sendMessage
  • forwardMessage
  • sendPhoto - without upload
  • sendAudio - without upload
  • sendDocument - without upload
  • sendSticker - without upload
  • sendVideo - without upload
  • sendVoice - without upload
  • sendLocation
  • getUpdates
  • getFile
  • sendChatAction
  • getUserProfilePhotos
  • setWebhook - without uploading certificate
  • answerInlineQuery
To be done:
  • sendPhoto - upload photo
  • sendAudio - upload audio
  • sendDocument - upload documents
  • sendSticker - upload stickers
  • sendVideo - upload video
  • sendVoice - upload voice
  • setWebhook - upload certificate