Commands documentation
A concise reference to the bot commands, how they behave and example usage. Use this page to learn what each command does, required parameters, and common responses. The examples are intentionally simple — adjust them for your bot's exact behaviour.
Overview
Commands are short text triggers users send to the bot. Commands are case-insensitive and normally start with a slash (e.g. /start). The bot returns structured responses and may initiate flows (onboarding, settings, reports). Some commands require authentication.
Command reference
| Command | Description | Usage | Examples |
|---|---|---|---|
/start |
Welcome & onboarding flow — registers user and shows quick help. | /start |
Bot: Welcome! Use /help to see available commands. |
/help |
Shows a short list of available commands and links to full docs. | /help |
Bot: Available commands: /start, /balance, /report … |
/balance |
Returns account summary or status (requires authentication). | /balance |
Bot: Balance: 12 credits. Next renewal: 2025-08-01 |
/report <text> |
Submit feedback or report an issue. The text becomes the report body. | /report Bot is not responding on channel X |
Bot: Thank you — your report has been saved (id: #1234). |
/status |
Quick service status: returns whether core services are operational. | /status |
Bot: All systems operational (latency 120ms). |
/subscribe <topic> |
Subscribe the user to updates for a topic (notifications). | /subscribe alerts |
Bot: You are now subscribed to alerts. |
/unsubscribe <topic> |
Remove subscription for a topic. | /unsubscribe alerts |
Bot: Unsubscribed from alerts. |
/profile |
Shows user's profile information (name, email, plan). | /profile |
Bot: Alex Brown — demo plan — alex@example.com |
/settings |
Start interactive settings flow (language, notifications). | /settings |
Bot: Which setting do you want to change? (1) Language (2) Notifications |
/notify <text> |
Send a quick broadcast to your subscribed channel(s) — requires permissions. | /notify Server restart at 02:00 UTC |
Bot: Notification queued for subscribers. |
/stats |
Return short metrics summary (today / 7d / 30d). | /stats |
Bot: Today: 1,230 msgs • 98 active users |
/top <n> |
Show top N commands or users (defaults to 5). | /top 10 |
Bot: 1) /start (1,430) … |
/search <query> |
Search historical logs or help docs for a keyword. | /search onboarding |
Bot: Found 12 references to 'onboarding' in last 30 days. |
/feedback <text> |
Send product feedback (short free text). | /feedback Add keyboard shortcuts |
Bot: Thanks — feedback saved (id #987). |
/invite <@user> |
Invite another user to the service or team via handle. | /invite @john |
Bot: Invitation sent to @john. |
/export <period> |
Export aggregated data (CSV) for given period. | /export 2025-07 |
Bot: Export ready — download link sent privately. |
/import <url> |
Import data/configuration from URL (admin). | /import https://…/config.json |
Bot: Import queued — applied after validation. |
/timezone <tz> |
Set preferred timezone for your reports (IANA value). | /timezone Europe/Kiev |
Bot: Timezone set to Europe/Kiev |
/language <code> |
Set preferred UI language for bot messages. | /language ru |
Bot: Language changed to RU |
/admin <action> |
Administrative commands (restricted to admins) — manage users, config. | /admin restart |
Bot: Restart scheduled; only admins can run this. |
/uptime |
Return service uptime and last restart time. | /uptime |
Bot: Uptime: 12d 4h 23m. Last restart: 2025-07-18 03:12 UTC |
Parameters & formatting
Commands accept plain text parameters after the command name. Parameters are parsed by splitting on whitespace. If a parameter contains spaces, enclose it in quotes. For structured inputs prefer the bot's interactive form (if available).
Errors & common responses
- 401 / Unauthorized — user needs to login or link account.
- 400 / Invalid input — parameters malformed or missing.
- 429 / Rate limit — slow down; try again after a short delay.
Best practices
- Keep commands short and discoverable — use /help to surface them.
- Confirm destructive actions with an explicit confirmation step.
- Return clear, localised error messages and (when possible) next steps.
FAQ
Contact & support
If you need additional help, contact: lmsmanager@outlook.com. When reporting an issue, include command, timestamp, user id (anonymised if necessary) and a short description.