Skip to main content
Documentation

Build smarter Telegram bots

Everything you need to know to set up, configure, and optimize your BotLink-powered Telegram business bot.

Getting Started

From signup to first bot

  • Create an account

    Sign up at /signup with email and password. Your account is created in pending state. An admin approves it; once approved you can sign in and connect your Telegram bot.

  • Sign in and dashboard

    After approval, sign in at /login. You are redirected to the dashboard where you can add bots, view stats, and manage your account.

  • Connect your bot

    In the dashboard, add your Telegram bot token (from @BotFather). BotLink sets the webhook for you. Your bot then receives messages and uses the configured AI to reply.

Account & Dashboard

Manage your business and team

  • Account management

    View and manage your tenant (business) name and see account members. Use GET /api/tenant/account and GET /api/tenant/users when logged in with your session cookie.

  • User management

    Account members are users who can log in to your tenant. Each tenant has one or more users (email/password). Activity shows Telegram users who messaged your bot (GET /api/tenant/activity).

  • Stats and tracking

    Dashboard shows total conversations and messages, weekly stats, and recent chatters. Use GET /api/tenant/stats and GET /api/tenant/activity to track everything programmatically.

API Reference

REST API for auth and tenant

  • Authentication

    POST /api/auth/signup (email, password, name), POST /api/auth/login (email, password), GET /api/auth/me (session cookie), POST /api/auth/logout. All tenant endpoints require a valid session and an approved account.

  • Tenant endpoints

    GET /api/tenant/account, GET /api/tenant/bots, POST /api/tenant/bots (body: { token }), GET /api/tenant/stats, GET /api/tenant/users, GET /api/tenant/activity?limit=50. Send credentials: include (cookies) with each request.

  • OpenAPI docs

    Full interactive API documentation is at your backend /docs (e.g. https://your-api.example.com/docs). Use it to try endpoints and see request/response schemas.

AI & Bots

How the bot works

  • AI provider

    The platform admin configures the AI provider (e.g. OpenRouter, NVIDIA) in Admin → Provider Studio. Your bot uses that provider for replies. Chat on the web uses the same AI via POST /api/ai/chat.

  • Webhook

    When you connect a bot, the backend sets the Telegram webhook so messages go to your tenant. Each tenant bot has its own webhook secret. WEBHOOK_BASE_URL must point to your deployed backend.

API Reference

Core endpoints for BotLink API

OpenAPI (full docs) →
POST/api/auth/signup
Create account (email, password, name)
POST/api/auth/login
Sign in (email, password)
GET/api/auth/me
Current user and tenant (session)
POST/api/auth/logout
Sign out
GET/api/tenant/account
Tenant profile
GET/api/tenant/bots
List connected bots
POST/api/tenant/bots
Connect a bot (body: { token })
GET/api/tenant/stats
Conversation stats (total + weekly)
GET/api/tenant/users
Account members
GET/api/tenant/activity
Recent chatters (tracking)

Example: Fetch stats (with session)

After logging in, use the same cookie to call tenant APIs.

// After login (session cookie is set)
const res = await fetch('https://your-api.example.com/api/tenant/stats', {
  credentials: 'include'
});
const { total, weekly } = await res.json();
// total: { total_users, total_messages }
// weekly: { unique_users, total_messages, user_messages, bot_messages, escalations }

Common Questions

How do I get an API key?

Sign up for a Growth or Pro plan, then navigate to Settings → API Keys to generate your key.

Can I use BotLink without coding?

Yes! The dashboard provides a no-code interface for configuring your bot. The API is optional for advanced integrations.

What languages are supported?

BotLink natively supports Amharic and English with automatic detection. More African languages are coming soon.

Need help?

Our team is ready to assist with your integration.