Telethon Plus

docker-telethon-plus

[CI] [version] [license] [Docker Pulls]

Your Telegram account, but it takes HTTP requests. Wraps Telethon — the real MTProto userbot client, not that neutered Bot API garbage — behind a JSON HTTP API and a Model Context Protocol endpoint.

Same tools, two doors. POST some JSON, or point your AI agent at /mcp and let it go nuts. Either way it's talking to Telegram as you, with full account access.

One login. One session string. Never type a code again.

Table of Contents

• How it works
• Quick start
• First-time login
• Configuration
• Tools
• HTTP API
• MCP
• Agent integrations
• Development
• Tests
• License

How it works

+-------------------+        +-----------------------+|  Any HTTP client  | -----> |  REST  /api/...       | --++-------------------+        +-----------------------+   |                                                         |   +-----------+        Telegram+-------------------+        +-----------------------+   +-> |  Telethon | <----> Servers|  MCP-aware agent  | -----> |  /mcp  (Streamable    | --+   +-----------+       (MTProto)|  (Claude, etc.)   |        |   HTTP transport)     |+-------------------+        +-----------------------+

One Telethon client. One async lock. Both surfaces share the same tool registry — no duplication, no weird state, no bullshit.

Quick start

services:  telethon-plus:    image: psyb0t/telethon-plus    ports:      - "8080:8080"    environment:      TELETHON_API_ID: "123456"      TELETHON_API_HASH: "your-api-hash"      TELETHON_SESSION: "1Aa...long-string-from-login-helper..."    restart: unless-stopped

Get API_ID / API_HASH from https://my.telegram.org/apps. Get the session string from the login helper below.

First-time login

Telegram makes you prove you're a human once — phone number, SMS code, optionally 2FA. Do it once, never again.

cp .env.example .env$EDITOR .env  # put in TELETHON_API_ID and TELETHON_API_HASH
make login

make login builds the image, runs the interactive flow, and shoves TELETHON_SESSION straight into your .env. That's it. Run make run and you're live.

No repo? No problem:

docker run --rm -it \  -e TELETHON_API_ID=123456 \  -e TELETHON_API_HASH=your-api-hash \  psyb0t/telethon-plus login

Copy the session string it spits out, set it as TELETHON_SESSION, done.

The session string is full account access. Whoever has it is you. Don't commit it, don't paste it in Slack, don't tattoo it anywhere.

Configuration

All config via environment variables. Copy .env.example to get the full list with comments.

Throttling & cache (anti-flood)

Telegram bans accounts that hammer it. Defaults here are conservative — meant to keep you under the server-side limits without you having to think about it. Tune only if you know what you're doing.

How the layers stack:

1. Entity cache short-circuits resolveUsername — first lookup of @somechannel calls Telegram; every subsequent lookup is free. Survives container restarts via the /cache volume.
2. Per-method token buckets cap the dangerous methods. If you try to resolve 6 new usernames in one minute, the 6th sleeps until the oldest expires.
3. Per-chat send interval throttles sends to each chat to ≤1/sec (with margin).
4. Global gap + jitter humanizes the overall traffic shape.
5. Adaptive backoff: a single FLOOD_WAIT halves your effective rate for an hour. Three in a row → ÷8. Auto-recovers after an idle hour.

For bulk scraping work (the scenario that caused 22-hour bans before): the cache + bucket_resolve_per_min=5 combination is what saves you. Resolving 200 new channels takes ~40 minutes instead of getting you banned in 5.

Tools

JSON in, JSON out. All inputs are pydantic-validated — send garbage, get a 400 back with exactly what's wrong.

Chat references (chat, from_chat, to_chat) accept whatever Telethon accepts:

Numeric IDs only resolve for entities Telethon has already seen — i.e. cached in your session via a prior @username / t.me lookup, dialog list, or incoming message. MTProto needs an access_hash, not just an ID, and bare numbers don't carry one. Especially relevant for bots: pass @botusername first (or call GET /api/dialogs / GET /api/entities?chat=@bot once) before referring to it by numeric ID. If you only have the bot's token and no username, hit Telegram's Bot API getMe to fetch the username, then use that.

Response shape

Every 2xx returns the resource directly. No {"result": ...} wrapper, no envelope. Lists are JSON arrays, singles are JSON objects.

Errors return {"detail": "..."} (FastAPI standard). Telegram RPC errors arrive as 502 with detail = {"telegram_error": "...", "message": "..."}.

Quick reference

{chat} in path accepts the same formats as elsewhere: @username, numeric ID, me. Phone (+...) and t.me/... links need URL-encoding (%2B etc.) — usernames and IDs work inline.

HTTP API

Standard REST API. JSON in, JSON out. 2xx returns the resource directly; errors return {"detail": ...}.

If TELETHON_AUTH_KEY is set, every request (except /healthz) needs:

Authorization: Bearer your-secret-key

GET /api/me

Who am I right now.

GET /api/me

{    "id": 123456789,    "type": "User",    "username": "psyb0t",    "first_name": "Ciprian",    "phone": "+40..."  }

GET /api/entities

Resolve any chat reference to a full profile.

GET /api/entities?chat=@telegram

{    "id": 1234567,    "type": "Channel",    "username": "telegram",    "title": "Telegram"  }

GET /api/dialogs

GET /api/dialogs?limit=10&archived=false

[  {    "id": 123456789,    "type": "User",    "username": "someone",    "first_name": "Some",    "last_name": "One",    "unread_count": 3,    "pinned": true,    "last_message": {      "id": 999,      "date": "2026-04-29T11:00:00+00:00",      "chat_id": 123456789,      "sender_id": 123456789,      "text": "hey",      "out": false,      "reply_to_msg_id": null,      "media": false,      "media_type": null    }  }]

GET /api/messages

GET /api/messages?chat=me&limit=5&search=hello

[  {    "id": 4242,    "date": "2026-04-29T12:00:00+00:00",    "chat_id": 12345,    "sender_id": 67890,    "text": "hello",    "out": false,    "reply_to_msg_id": null,    "media": false,    "media_type": null  }]

Newest first. Returns [] if nothing matches.

POST /api/messages

Send a message. The same endpoint handles text and files — if the body contains file_url, the URL is fetched and sent as media (with text becoming the caption); otherwise text is sent as a plain message.

POST /api/messagesContent-Type: application/json
{  "chat": "@psyb0t",  "text": "**hello** from a container",  "parse_mode": "md",  "silent": true,  "reply_to": 4241}

POST /api/messagesContent-Type: application/json
{  "chat": "@psyb0t",  "file_url": "https://example.com/photo.jpg",  "text": "look at this shit",  "silent": true}

{    "id": 4242,    "date": "2026-04-29T12:00:00+00:00",    "chat_id": 12345,    "sender_id": 67890,    "text": "hello from a container",    "out": true,    "reply_to_msg_id": 4241,    "media": false,    "media_type": null  }

PATCH /api/messages/{id}

Edit a message. Message ID goes in the URL, everything else in the body.

PATCH /api/messages/4242Content-Type: application/json
{  "chat": "me",  "text": "fixed version",  "parse_mode": "md"}

{    "id": 4242,    "date": "2026-04-29T12:00:00+00:00",    "chat_id": 99999,    "sender_id": 123456789,    "text": "fixed version",    "out": true,    "reply_to_msg_id": null,    "media": false,    "media_type": null  }

DELETE /api/messages

Delete messages by ID.

DELETE /api/messagesContent-Type: application/json
{  "chat": "@psyb0t",  "message_ids": [4242, 4243],  "revoke": true}

{ "deleted": 2, "requested": 2 }

POST /api/messages/forward

POST /api/messages/forwardContent-Type: application/json
{  "from_chat": "@sourcechannel",  "to_chat": "me",  "message_ids": [101, 102, 103],  "silent": true}

[  {    "id": 5001,    "date": "2026-04-29T12:01:00+00:00",    "chat_id": 99999,    "sender_id": 123456789,    "text": "forwarded content here",    "out": true,    "reply_to_msg_id": null,    "media": false,    "media_type": null  }]

POST /api/messages/read

Mark messages as read.

POST /api/messages/readContent-Type: application/json
{ "chat": "@psyb0t", "max_id": 0 }

{ "ok": true }

GET /api/participants

List members of a group or channel.

GET /api/participants?chat=-1001234567890&limit=50&search=john

[  { "id": 123456789, "type": "User", "username": "johndoe", "first_name": "John" }]

Large public channels may return a limited set or require admin rights.

POST /api/chats

Create a supergroup or broadcast channel.

POST /api/chatsContent-Type: application/json
{ "title": "my-group", "megagroup": true }

{ "id": 1234567890, "type": "Channel", "title": "my-group" }

DELETE /api/chats

Delete a supergroup or channel you own. Irreversible.

DELETE /api/chatsContent-Type: application/json
{ "chat": "-1001234567890" }

{ "ok": true }

POST /api/chats/join

Join a public channel or supergroup.

POST /api/chats/joinContent-Type: application/json
{ "chat": "@somegroup" }

{ "ok": true }

POST /api/chats/leave

Leave a channel or supergroup.

POST /api/chats/leaveContent-Type: application/json
{ "chat": "@somegroup" }

{ "ok": true }

Errors

Health

GET /healthz

{ "status": "ok", "authorized": true }

authorized: false means the container started but the session is fucked — bad string, revoked, or Telegram unreachable. Always public, no auth required.

Observability

GET /metrics

Prometheus exposition. Scrape it. No auth (publicly readable inside your cluster — if you need it locked down, put it behind your usual scrape-network policy).

Series exported:

• telethon_plus_tool_calls_total{tool=...}
• telethon_plus_tool_errors_total{tool=...}
• telethon_plus_flood_events_total{bucket=...}
• telethon_plus_cache_hits_total / _misses_total / _entries
• telethon_plus_throttle_multiplier
• telethon_plus_bucket_used{bucket=...} / _bucket_limit{bucket=...}
• telethon_plus_uptime_seconds

GET /api/throttle/status

Live state of every bucket, multiplier, recent flood events, cache stats:

{  "throttle": {    "enabled": true,    "adaptive": true,    "multiplier": 1.0,    "flood_events_1h": 0,    "buckets": {      "resolve_username": {"used": 0, "limit": 5, "window_seconds": 60},      "send": {"used": 0, "limit": 20, "window_seconds": 60}    },    "tracked_chats_send": 12,    "tracked_chats_read": 30,    "global_interval_ms": 50,    "per_chat_interval_ms": 1100,    "per_chat_read_interval_ms": 250,    "jitter_ms": 200  },  "cache": {"entries": 247},  "read_only": false,  "dry_run": false}

GET /api/account/health

{  "authorized": true,  "risk": "ok",  "multiplier": 1.0,  "flood_events_1h": 0,  "read_only": false,  "dry_run": false}

risk is ok (multiplier 1×), warning (≥2×), or high (≥8×).

Throttle response headers

Every /api/... response carries:

• X-Throttle-Multiplier
• X-Throttle-Flood-Events-1h
• X-RateLimit-Remaining-<bucket> for each bucket

Lets clients self-throttle without polling /api/throttle/status.

Updates / webhooks

Two ways to receive incoming Telegram events (new messages, edits, deletes, chat actions):

WebSocket — /ws/updates

const ws = new WebSocket('ws://your-host:8080/ws/updates?token=YOUR_AUTH_KEY');ws.onmessage = (e) => console.log(JSON.parse(e.data));

If TELETHON_AUTH_KEY is set, pass it as ?token=. Browser WS clients can't set Authorization headers, hence query-string.

Multiple subscribers are supported — each gets its own queue. Slow consumers drop events at TELETHON_UPDATES_BUFFER_SIZE.

Outbound webhook — TELETHON_POST_TO_URL

Set the env var to your endpoint and every event gets POSTed there as JSON. Fire-and-forget — a slow or failing webhook never blocks Telethon's loop. Use for distributed workers, separate processes, anything that can't hold a WS open.

Event payload shape

{  "type": "NewMessage",  "message": {    "id": 4242,    "date": "2026-04-29T12:00:00+00:00",    "text": "hi",    "out": false,    "sender_id": 12345,    "chat_id": -1001234567890,    "reply_to_msg_id": null,    "media": false,    "media_type": null  },  "chat_id": -1001234567890}

For MessageEdited, MessageDeleted, ChatAction — same shape, fewer fields.

Safety switches

TELETHON_READ_ONLY=true

Every write endpoint returns 403. Reads, status, metrics still work. Killswitch for panic mode or for keeping a test deployment harmless.

TELETHON_DRY_RUN=true

Write endpoints accept the request, validate it, don't call Telegram, return {"dry_run": true, "would_...": {...}}. Useful for verifying scripts before pointing them at production.

MCP

Mounted at /mcp/ using the streamable HTTP transport. Every tool from the table above shows up automatically as an MCP tool with the same name and schema.

Point your agent at:

http://your-host:8080/mcp/

Stateless — every request is independent, no session juggling. Drop it into Claude Desktop, a custom agent, anything that speaks MCP over HTTP. Works out of the box.

Agent integrations

The skill works in any agent that reads .agents/skills/ (such as peen), and installs natively in the clients below.

Claude Code

claude plugin marketplace add psyb0t/agentsclaude plugin install telethon-plus@psyb0t

Claude Code prompts for the telethon-plus server URL and, if auth is enabled, the bearer token — the token is stored in your OS keychain.

Codex

codex plugin marketplace add psyb0t/agentscodex plugin add telethon-plus@psyb0t

Installed via the marketplace, the skill invokes as $telethon-plus:telethon-plus. Codex also picks the skill up automatically with no install in any repo containing .agents/skills/, where it invokes as plain $telethon-plus.

OpenClaw

The skill is published to ClawHub on every release:

openclaw skills install @psyb0t/telethon-plus

For MCP clients that speak local stdio, the @psyb0t/telethon-plus plugin bridges to the service's /mcp/ endpoint:

openclaw plugins install clawhub:@psyb0t/telethon-plus

Then set TELETHON_PLUS_URL (and TELETHON_AUTH_KEY if the server requires auth).

Development

make build        # build psyb0t/telethon-plus:latestmake build-test   # build psyb0t/telethon-plus:latest-testmake run          # run locally on :8080 (reads .env)make login        # interactive login — writes TELETHON_SESSION to .env automaticallymake lint         # flake8 + pyrightmake format       # isort + blackmake test         # run integration tests in Dockermake clean        # remove built images

Tests

Real tests. Real Telegram. No mocking bullshit.

tests/ spins up the container and hammers both REST and MCP with your actual account. Messages get sent and deleted. If anything breaks, you'll know.

Setup:

cp .env.example .env$EDITOR .env  # needs TELETHON_API_ID, TELETHON_API_HASH, TELETHON_SESSION, TEST_CHAT
make test

TEST_CHAT is where test messages land. Use me for Saved Messages — private, yours, no one else sees it. All chat reference formats from the Tools section work here.

make test builds both images and runs pytest inside Docker with the socket mounted. No setup beyond .env. If credentials are missing, the suite skips cleanly.

License

WTFPL — do whatever the fuck you want.