Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dynastymasra/telegraph
Telegram bot API Go SDK
https://github.com/dynastymasra/telegraph
backoff go golang sdk telegram
Last synced: about 1 month ago
JSON representation
Telegram bot API Go SDK
- Host: GitHub
- URL: https://github.com/dynastymasra/telegraph
- Owner: dynastymasra
- License: mit
- Created: 2017-10-24T01:46:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-23T09:40:19.000Z (almost 7 years ago)
- Last Synced: 2024-06-20T12:41:30.265Z (7 months ago)
- Topics: backoff, go, golang, sdk, telegram
- Language: Go
- Size: 175 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Telegraph
[](https://travis-ci.org/dynastymasra/telegraph)
[](https://coveralls.io/github/dynastymasra/telegraph?branch=master)
[](https://goreportcard.com/report/github.com/dynastymasra/telegraph)
[](https://godoc.org/github.com/dynastymasra/telegraph)
[](https://github.com/dynastymasra/telegraph/tree/2.0.0)
[](https://opensource.org/licenses/MIT)
Telegraph is Telegram bot API SDK for Go(Golang), Can use back off retry request to Telegram bot API
Reference to Telegram bot API [Documentation](https://core.telegram.org/bots/api)
## Installation
```bash
$ go get github.com/dynastymasra/telegraph
```
## How to use
import library `github.com/dynastymasra/telegraph`,
See Telegram API [Documentation](https://core.telegram.org/bots/api#available-methods) to know available method can used,
and what params can use in a method.
Create new client with no use back off retry, use params `access token` obtain from telegram bot father.
```go
client := telegraph.NewClient()
res, err := client.SetWebHook("https://www.cubesoft.co.id").SetCertificate("./LICENSE").SetMaxConnection(100).SetAllowedUpdates("1", "2", "3").Commit()
if err != nil {
// Do something when error
}
info, res, err := client.GetWebHookInfo().Commit()
if err != nil {
// Do something when error
}
```
Create new client with use back off retry, with params `access token` obtain from telegram bot father and `max interval` and `max elapsed time`
```go
client := telegraph.NewClientWithBackOff(, telegraph.NewBackOff(, ))
res, err := client.DeleteWebHook().Commit()
if err != nil {
// Do something when error
}
```
Parse telegram web hook request, reference to telegram [Documentation](https://core.telegram.org/bots/api#getting-updates)
```go
message, err := telegraph.WebHookParseRequest()
if err != nil {
// Do something when error
}
```
Send message to telegram use Telegraph SDK
```go
client := telegraph.NewClientWithBackOff(, telegraph.NewBackOff(, ))
// Use upload false if file from url
message, res, err := client.SendPhoto(, "http://www.images.com/images/jpg", false).SetCaption("test image").Commit()
if err != nil {
// Do something when error
}
// Use upload true if from path file
message, res, err := client.SendAudio(, "/home/audio/audio.mp3", true).SetCaption("test audio").SetDuration(1000).Commit()
if err != nil {
// Do something when error
}
```
## Contributing
If you find any issue you want to fix it, feel free to send me a pull request.
And also if you have idea for improvement this library, feel free to send me a pull request.
## Library
* [GoRequest](https://github.com/parnurzeal/gorequest) - Simplified HTTP client ( inspired by famous SuperAgent lib in Node.js )
* [Backoff](https://github.com/cenkalti/backoff) - The exponential backoff algorithm in Go (Golang)
* [Gock](https://github.com/h2non/gock) - HTTP traffic mocking and expectations made easy for Go
* [Testify](https://github.com/stretchr/testify) - A toolkit with common assertions and mocks that plays nicely with the standard library