Skip to content
Brain Framework

Telegram Client

The Telegram Client enables your agent to interact through Telegram, supporting both group chats and direct messages.

Installation

  1. Install required packages:

    Terminal window
    npm i github:elizaos-plugins/client-telegram @elizaos/[email protected]

  2. Configure environment variables:

    Terminal window
    TELEGRAM_BOT_TOKEN=your_bot_token

Basic Setup

import { AgentBuilder, ModelProviderName } from "@iqai/agent";
import TelegramClient from "@elizaos/client-telegram";
import SqliteAdapter from "@elizaos/adapter-sqlite";




async function main() {
  const agent = new AgentBuilder()
    .withDatabase(SqliteAdapter)
    .withClient(TelegramClient)
    .withModelProvider(
      ModelProviderName.OPENAI,
      process.env.OPENAI_API_KEY
    )
    .withCharacter({
      name: "TelegramBot",
      bio: "A helpful Telegram assistant",
      username: "brain_bot"
    })
    .build();


  await agent.start();
}


main().catch(console.error);