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/password or Google/GitHub. Your account opens the customer dashboard immediately.

  • Sign in and dashboard

    Sign in at /login and you land on the customer dashboard. This is where you connect bots, view stats, and see approval state.

  • Connect your bot

    In the dashboard, paste your Telegram bot token from @BotFather. The bot is registered in pending state until an admin approves it, after which it goes live with the active AI provider/model.

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, plus Google/GitHub OAuth start/callback routes. Tenant endpoints require a valid session.

  • 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 and active model in Admin → Provider Studio. Approved bots and the web chat both use that active runtime.

  • Webhook

    When you connect a bot, the backend stores it in pending state. After admin approval, BotLink sets the Telegram webhook and the bot starts receiving messages through your tenant.

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 from the customer dashboard

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

Why is my bot pending?

New bots stay in pending status until an admin approves them. Approval is what makes the bot go live.

Can I use BotLink without coding?

Yes. Customers use the dashboard to connect and track bots, while admins use Provider Studio to manage AI providers and approvals.

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.