telegram

README

go-telegram

Introduction

Send and receive messages using the Telegram Bot API with ease. Supports plain text messages, media attachments and location data, written in Go.

Features

• Send and receive text messages
• Send and receive media files
• Update webhook URL

Example

package main

import (
	"fmt"
	"os"

	"github.com/pravinba9495/go-telegram"
)

func main() {
	// Bot token generated from BotFather
	botToken := os.Getenv("TELEGRAM_BOT_TOKEN")

	text := "Hi, I am a message from the telegram bot."
	chatId := os.Getenv("TELEGRAM_CHAT_ID")
	path := os.Getenv("TELEGRAM_FILE_PATH")

	// Retrieving all updates until the server returns empty response
	var allUpdates Updates
	offset := 0
	for {
		fmt.Println("Using offset: " + fmt.Sprint(offset))
		updates, err := GetUpdates(botToken, fmt.Sprint(offset))
		if err != nil {
			panic(err)
		}
		if len(*updates) > 0 {
			allUpdates = append(allUpdates, *updates...)
			offset = int(allUpdates[len(*updates)-1].UpdateID) + 1
			if len(*updates) < 100 {
				break
			}
		} else {
			break
		}
	}

	for _, update := range allUpdates {
		fmt.Println("[RECEIVED] " + update.Message.Text)
	}

        // Sending a text message
	result, err := telegram.SendMessage(botToken, chatId, text)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println("[SENT] " + result.Text)

        // Sending a media attachment
	message, err := telegram.SendMedia(botToken, chatId, path)
	if err != nil {
		panic(err)
	}

	fmt.Println(message.Text)

	// Setting webhook
	if err := telegram.SetWebhook(botToken, "https://example.com/webhook"); err != nil {
		panic(err)
	}
}

Documentation

The complete documentation is available at https://pkg.go.dev/github.com/pravinba9495/go-telegram

License

MIT

Documentation

Index

• func GetFile(botToken string, filePath string) (io.ReadCloser, error)
• func GetFileContentType(path string) (string, error)
• func SetWebhook(botToken string, webhookURL string) error
• type Chat
• type File
  • func GetFileInfo(botToken string, fileId string) (*File, error)
• type GetFileResponseBody
• type GetUpdatesResponseBody
• type Location
• type Message
  • func SendMedia(botToken string, chatId string, path string) (*Message, error)
  • func SendMessage(botToken string, chatId string, text string) (*Message, error)
• type ResponseBody
• type SendLocationRequestBody
• type SendMessageRequestBody
• type Update
• type Updates
  • func GetUpdates(botToken string, offset string) (*Updates, error)

Examples

• GetUpdates
• SendMedia
• SendMessage
• SetWebhook

Functions

func GetFile

func GetFile(botToken string, filePath string) (io.ReadCloser, error)

GetFile retrieves the file by filePath from telegram API

func GetFileContentType

func GetFileContentType(path string) (string, error)

GetFileContentType returns the content type of the file

func SetWebhook

func SetWebhook(botToken string, webhookURL string) error

SetWebhook sets the webhook URL for the telegram bot. Setting an empty url will remove the webhook integration

Example

// Bot token generated from BotFather
botToken := os.Getenv("TELEGRAM_BOT_TOKEN")

// Setting webhook
if err := SetWebhook(botToken, ""); err != nil {
	panic(err)
}
fmt.Println("Done !")

Output:
Done !

Types

type Chat

type Chat struct {
	ID        uint64 `json:"id"`
	Username  string `json:"username,omitempty"`
	FirstName string `json:"firstName,omitempty"`
	LastName  string `json:"lastName,omitempty"`
}

Chat defines the structure of chat object

type File

type File struct {
	FileID   string `json:"file_id"`
	FilePath string `json:"file_path,omitempty"`
}

File defines the structure of file object

func GetFileInfo

func GetFileInfo(botToken string, fileId string) (*File, error)

GetFileInfo retrieves basic info about a file and prepares it for downloading

type GetFileResponseBody

type GetFileResponseBody struct {
	OK     bool  `json:"ok"`
	Result *File `json:"result"`
}

GetFileResponseBody defines the structure of the body returned by the getFile method of the telegram API

type GetUpdatesResponseBody

type GetUpdatesResponseBody struct {
	OK     bool     `json:"ok"`
	Result *Updates `json:"result"`
}

GetUpdatesResponseBody defines the structure of the body returned by the getUpdates method of the telegram API

type Location

type Location struct {
	Longitude float64 `json:"longitude,omitempty"`
	Latitude  float64 `json:"latitude,omitempty"`
}

Location defines the structure of location object

type Message

type Message struct {
	MessageID uint64    `json:"message_id"`
	Chat      *Chat     `json:"chat"`
	Text      string    `json:"text,omitempty"`
	Audio     *File     `json:"audio,omitempty"`
	Document  *File     `json:"document,omitempty"`
	Photo     *[]File   `json:"photo,omitempty"`
	Video     *File     `json:"video,omitempty"`
	Voice     *File     `json:"voice,omitempty"`
	VideoNote *File     `json:"video_note,omitempty"`
	Caption   string    `json:"caption,omitempty"`
	Animation *File     `json:"animation,omitempty"`
	Location  *Location `json:"location,omitempty"`
}

Message defines the structure of message object

func SendMedia

func SendMedia(botToken string, chatId string, path string) (*Message, error)

SendMedia sends a media file to a recipient

Example

// Bot token generated from BotFather
botToken := os.Getenv("TELEGRAM_BOT_TOKEN")

chatId := os.Getenv("TELEGRAM_CHAT_ID")
path := os.Getenv("TELEGRAM_FILE_PATH")

_, err := SendMedia(botToken, chatId, path)
if err != nil {
	panic(err)
}
fmt.Println("Done !")

Output:
Done !

func SendMessage

func SendMessage(botToken string, chatId string, text string) (*Message, error)

SendMessage sends a text message to a recipient

Example

// Bot token generated from BotFather
botToken := os.Getenv("TELEGRAM_BOT_TOKEN")
message := "Hi, I am a message from the telegram bot."
chatId := os.Getenv("TELEGRAM_CHAT_ID")

if chatId != "" {
	// Sending a text message
	result, err := SendMessage(botToken, chatId, message)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println("[SENT] " + result.Text)
}

Output:
[SENT] Hi, I am a message from the telegram bot.

type ResponseBody

type ResponseBody struct {
	OK     bool     `json:"ok"`
	Result *Message `json:"result"`
}

ResponseBody defines the structure of the body returned by the `sendMessage` method of the telegram API

type SendLocationRequestBody

type SendLocationRequestBody struct {
	ChatID    string  `json:"chat_id"`
	Longitude float64 `json:"longitude"`
	Latitude  float64 `json:"latitude"`
}

SendLocationRequestBody defines the request body structure required for the `sendLocation` method for the telegram API

type SendMessageRequestBody

type SendMessageRequestBody struct {
	ChatID string `json:"chat_id"`
	Text   string `json:"text"`
}

SendMessageRequestBody defines the request body structure required for the `sendMessage` method for the telegram API

type Update

type Update struct {
	UpdateID uint64   `json:"update_id"`
	Message  *Message `json:"message"`
}

Update defines the structure of update object

type Updates

type Updates []Update

Updates defines an array of updates

func GetUpdates

func GetUpdates(botToken string, offset string) (*Updates, error)

GetUpdates retrieves incoming updates using long polling

Example

// Bot token generated from BotFather
botToken := os.Getenv("TELEGRAM_BOT_TOKEN")

// Retrieving all updates until the server returns empty response
var allUpdates Updates
offset := 0
for {
	fmt.Println("Using offset: " + fmt.Sprint(offset))
	updates, err := GetUpdates(botToken, fmt.Sprint(offset))
	if err != nil {
		panic(err)
	}
	if len(*updates) > 0 {
		allUpdates = append(allUpdates, *updates...)
		offset = int(allUpdates[len(*updates)-1].UpdateID) + 1
		if len(*updates) < 100 {
			break
		}
	} else {
		break
	}
}
fmt.Println("Done !")

Output:
Using offset: 0
Done !