mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-20 23:16:49 +00:00
ba92ba3254
* docs: Create new CODING_GUIDELINES doc Rids excess contribution instructions from other packages Adds AGENTS.md file for the AI overlords Rids unused templates Updates ADD_NEW_EXCHANGE.md with minor fixes * docs: Fix linter issues and minor adjustments based on Copilot feedback * docs: Update coding guidelines for API parameters and testing practices * docs: Remove redundant GoDoc references Adds copilot-instructions.md * docs: Update CODING_GUIDELINES with export recommendations and test commentary * docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links * docs: Update struct naming conventions for request and response types * docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md * refactor: Simplify error handling in QueryOrder method
59 lines
1.8 KiB
Cheetah
59 lines
1.8 KiB
Cheetah
{{define "communications telegram" -}}
|
|
{{template "header" .}}
|
|
## Telegram Communications package
|
|
|
|
### What is telegram?
|
|
|
|
+ Telegram is a cloud-based instant messaging and voice over IP service
|
|
developed by Telegram Messenger LLP
|
|
+ Please visit: [Telegram](https://telegram.org/) for more information
|
|
|
|
### Current Features
|
|
|
|
+ Creation of bot that can retrieve
|
|
- Bot status
|
|
|
|
### How to enable
|
|
|
|
+ [Enable via configuration](https://github.com/thrasher-corp/gocryptotrader/tree/master/config#enable-communications-via-config-example)
|
|
|
|
+ See the individual package example below. NOTE: For privacy considerations, it's not possible to directly request a user's ID through the
|
|
Telegram Bot API unless the user interacts first. The user must message the bot directly. This allows the bot to identify and save the user's ID.
|
|
If this wasn't set initially, the user's ID will be stored by this package following a successful authentication when any supported command is issued.
|
|
|
|
```go
|
|
import (
|
|
"github.com/thrasher-corp/gocryptotrader/communications/base"
|
|
"github.com/thrasher-corp/gocryptotrader/communications/telegram"
|
|
)
|
|
|
|
t := new(telegram.Telegram)
|
|
|
|
// Define Telegram configuration
|
|
commsConfig := &base.CommunicationsConfig{
|
|
TelegramConfig: base.TelegramConfig{
|
|
Name: "Telegram",
|
|
Enabled: true,
|
|
Verbose: false,
|
|
VerificationToken: "token",
|
|
AuthorisedClients: map[string]int64{"pepe": 0}, // 0 represents a placeholder for the user's ID, see note above for more info.
|
|
},
|
|
}
|
|
|
|
t.Setup(commsConfig)
|
|
err := t.Connect
|
|
// Handle error
|
|
```
|
|
|
|
+ Once the bot has started you can interact with the bot using these commands
|
|
via Telegram:
|
|
|
|
```
|
|
/start - Will authenticate your ID
|
|
/status - Displays the status of the bot
|
|
/help - Displays current command list
|
|
```
|
|
|
|
{{template "donations" .}}
|
|
{{end}}
|