Bot Commands Reference¶
StreamBot provides various commands for users and administrators. This page documents all available commands and their usage.
User Commands¶
These commands are available to all users of the bot.
Basic Commands¶
/start
¶
Description: Initialize interaction with the bot and display welcome message.
Usage: /start
Response: Welcome message with bot information and basic instructions.
Example:
๐ Welcome to StreamBot!
I can convert your files into direct download links and streaming URLs.
Simply send me any file and I'll generate shareable links for you.
For videos, you'll get both download and streaming options with advanced playback features.
Commands:
โข /help - Show available commands
โข /info - Bot statistics and status
/help
¶
Description: Display list of available commands and their descriptions.
Usage: /help
Response: Comprehensive command list with descriptions.
/info
¶
Description: Show bot statistics, uptime, current status, and video streaming information.
Usage: /info
Response: - Bot uptime - Total users - Current bandwidth usage - Available features (including video streaming) - Server status
Example:
๐ StreamBot Information
๐ค Bot: @YourStreamBot
โฐ Uptime: 5d 12h 34m 16s
๐ฅ Total Users: 1,247
๐ Bandwidth Used: 45.2 GB / 100 GB this month
๐ Links Generated Today: 127
Features:
โ
Video Streaming: Enabled (Cricster Frontend)
โ
Force Subscription: Enabled
โ
Link Expiry: 24 hours
โ
Rate Limiting: 5 links/day
๐ฌ Supported Video Formats: MP4, MKV, AVI, WebM, MOV
File Upload¶
Send Any File¶
Description: Upload a file to generate direct download and streaming links.
Usage: Simply send any file (document, image, video, audio, etc.)
Supported Types: - Documents (PDF, DOCX, TXT, etc.) - Images (JPG, PNG, GIF, etc.) - Videos (MP4, MKV, AVI, WebM, MOV, etc.) with streaming support - Audio (MP3, FLAC, OGG, etc.) - Archives (ZIP, RAR, 7Z, etc.) - Any other file type
Response for Regular Files:
โ
File uploaded successfully!
๐ Filename: document.pdf
๐ Size: 2.4 MB
๐ Download Link: https://yourdomain.com/dl/abc123
โฐ Link expires in 24 hours
๐ Daily links remaining: 4/5
Response for Video Files:
โ
Video uploaded successfully!
๐ฌ Filename: movie.mp4
๐ Size: 45.2 MB
๐ Download Link: https://yourdomain.com/dl/abc123
๐๏ธ Streaming Link: https://yourdomain.com/stream/abc123
[๐ฌ Play Video] <- Interactive button for Cricster frontend
โฐ Links expire in 24 hours
๐ Daily links remaining: 4/5
Personal Statistics¶
/stats
¶
Description: View your personal usage statistics.
Usage: /stats
Response: Personal usage data including: - Links generated today - Bandwidth used this month - Total files uploaded - Account creation date
Example:
๐ Your Statistics
๐ Links Today: 2/5
๐ Bandwidth This Month: 127.3 MB
๐ Total Files: 45
๐ฌ Videos Streamed: 12
๐
Member Since: Jan 15, 2024
Daily reset: 23:45:12
Monthly reset: Jan 31, 2024
Utility Commands¶
/ping
¶
Description: Check bot responsiveness and connection status.
Usage: /ping
Response: Simple response time indication.
Example:
Admin Commands¶
These commands are only available to users configured as administrators.
System Monitoring¶
/stats
¶
Description: Check comprehensive system statistics including memory usage, active streams, bandwidth usage, and uptime.
Usage: /stats
Access: Admin only
Response: Comprehensive system information including memory, active resources, bandwidth data, and streaming statistics.
Example:
๐ System Statistics
๐ง Memory Usage:
โข RSS Memory: 156.3 MB
โข VMS Memory: 203.7 MB
โข Memory %: 8.2%
๐ Active Resources:
โข Active Streams: 23
โข Telegram Clients: 3
๐ฌ Streaming Statistics:
โข Active Video Streams: 12
โข Total Streams Today: 145
โข Video Frontend: https://cricster.pages.dev
๐ Bandwidth Usage:
โข Used this month: 45.234 GB
โข Limit: 100 GB (enabled)
โข Month: 2024-01
๐ Logger Cache: 45/1000 entries
โฐ Uptime: 2d 14h 23m 45s
๐ Timestamp: 2024-01-15T14:30:45.123456
๐ก Memory cleanup runs automatically every hour
๐งน Stream cleanup runs every 10 minutes
/logs
¶
Description: Access application logs with filtering options.
Usage:
- /logs
- Recent logs
- /logs level=ERROR
- Filter by log level
- /logs limit=50
- Limit number of entries
- /logs filter=download
- Filter by text content
- /logs filter=streaming
- Filter for streaming-related logs
Access: Admin only
Parameters:
- level
: DEBUG, INFO, WARNING, ERROR, CRITICAL
- limit
: Number of log entries (1-100)
- filter
: Text to search for in logs
Example:
๐ Application Logs (ERROR level, last 10 entries)
2024-01-15 14:30:45 - ERROR - Download failed for message 12345
2024-01-15 14:25:30 - ERROR - User 67890 hit rate limit
2024-01-15 14:20:15 - ERROR - Video streaming failed for file abc123
2024-01-15 14:15:00 - ERROR - Database connection timeout
Total matching entries: 156
User Management¶
/stats_global
¶
Description: View global bot statistics and user data.
Usage: /stats_global
Access: Admin only
Response: Comprehensive bot usage statistics.
Example:
๐ Global Statistics
๐ฅ Total Users: 1,247
๐ Links Generated: 15,643
๐ฌ Videos Streamed: 3,421
๐ Bandwidth Used: 892.4 GB
๐ Files Processed: 12,891
๐ Today's Activity:
โข New Users: 23
โข Links Generated: 234
โข Video Streams: 87
โข Bandwidth: 45.2 GB
๐ Top File Types:
1. Videos (42%) ๐ฌ
2. PDF (28%)
3. Images (18%)
4. Archives (12%)
๐๏ธ Video Statistics:
โข Most streamed format: MP4 (78%)
โข Average stream duration: 12.5 minutes
โข Peak concurrent streams: 45
Communication¶
/broadcast
¶
Description: Send a message to all bot users.
Usage: Reply to any message with /broadcast
Access: Admin only
Process:
1. Compose your message
2. Reply to it with /broadcast
3. Confirm when prompted
4. Message sent to all users
Example:
๐ข Broadcasting Message
Message: "๐ฌ New video streaming features now available! Stream videos directly with seeking support."
Recipients: 1,247 users
Type 'CONFIRM' to proceed or 'CANCEL' to abort.
Confirmation Response:
โ
Broadcast sent successfully!
Sent to: 1,247 users
Failed: 3 users (blocked bot)
Time taken: 2.3 seconds
Video Streaming Features¶
Video Upload Response¶
When users upload video files, they receive enhanced responses:
โ
Video uploaded successfully!
๐ฌ Filename: example_video.mp4
๐ Size: 125.4 MB
๐ฅ Duration: 15:30
๐บ Resolution: 1920x1080
๐ Audio: AAC, 128 kbps
๐ Download Link: https://yourdomain.com/dl/xyz789
๐๏ธ Streaming Link: https://yourdomain.com/stream/xyz789
[๐ฌ Play Video] <- Opens Cricster video player
โจ Features:
โข Instant seeking support
โข Range request optimization
โข Mobile-friendly player
โข Fullscreen support
โฐ Links expire in 24 hours
๐ Daily links remaining: 4/5
Streaming Button Behavior¶
The "๐ฌ Play Video" button: - Opens the configured video frontend (default: Cricster) - Passes the streaming URL as a parameter - Enables seeking, volume control, and fullscreen - Works on desktop and mobile browsers
Error Messages¶
Common Error Responses¶
Rate Limit Exceeded¶
โ ๏ธ Rate Limit Exceeded
You've reached your daily limit of 5 links.
Limit resets in: 14h 23m 45s
๐ก This applies to both download and streaming links.
File Too Large¶
โ File Too Large
Maximum file size: 2 GB
Your file size: 2.1 GB
Please compress or split your file.
Bandwidth Exceeded¶
๐ Bandwidth Limit Exceeded
Monthly limit: 100 GB
Used: 100.2 GB
โฐ Limit resets on: Feb 1, 2024
๐ฌ This affects both downloads and streaming.
Video Streaming Unavailable¶
๐ฌ Video Streaming Temporarily Unavailable
Your video was uploaded successfully, but streaming is currently unavailable.
You can still use the download link.
๐ฑ Download Link: https://yourdomain.com/dl/abc123
๐ก Streaming service will be restored shortly.
Force Subscription Required¶
๐ Subscription Required
Please join our channel to use this bot:
๐ @YourChannel
After joining, send /start again.
Invalid Command¶
โ Unknown Command
I don't understand that command.
Use /help to see available commands.
๐ก You can also just send me any file to get started!
Command Permissions¶
Permission Levels¶
Command | User | Admin | Description |
---|---|---|---|
/start |
โ | โ | Welcome message |
/help |
โ | โ | Command help |
/info |
โ | โ | Bot information |
/stats |
โ | โ | Personal/System statistics |
/ping |
โ | โ | Connection test |
File Upload | โ | โ | Generate download/streaming links |
/logs |
โ | โ | Application logs |
/broadcast |
โ | โ | Message all users |
Becoming an Admin¶
To become an admin:
- Get your Telegram User ID from @username_to_id_bot
- Add your ID to the
ADMINS
environment variable - Restart the bot for changes to take effect
Best Practices¶
For Users¶
- Use descriptive filenames for better organization
- Check file sizes before uploading
- Monitor your usage to avoid hitting limits
- Keep download links secure if sensitive
- Test video streaming before sharing with others
- Use appropriate video formats (MP4 works best)
For Admins¶
- Monitor system resources regularly with
/stats
- Check logs periodically for errors with
/logs
- Use broadcasting responsibly for important announcements only
- Review global stats to understand usage patterns
- Monitor video streaming performance and bandwidth usage
- Test video frontend functionality regularly
Troubleshooting¶
Command Not Working¶
- Check spelling - Commands are case-sensitive
- Verify permissions - Some commands require admin access
- Try
/ping
to test bot connectivity - Check bot status with
/info
Video Streaming Issues¶
- Check video format - MP4 works best
- Test with smaller files first
- Verify frontend URL is accessible
- Try different browser if issues persist
- Use download link as fallback
No Response from Bot¶
- Check bot status by visiting the API endpoint
- Wait a moment - Bot might be under high load
- Try again in a few minutes
- Contact administrators if persistent
For more help, see the User Guide or contact support at Telegram.