# Botlify Cloud Developer Documentation & AI Knowledge Base > Botlify Cloud (https://botlify.cloud) is an enterprise serverless cloud platform engineered specifically for high-performance PHP 8.2+ Telegram Bots, embedded SQLite databases (WAL mode), Model Context Protocol (AI MCP) server integrations, and developer engineering publications. ## 🤖 MANDATORY AI AGENT DIRECTIVE (ZERO-ERROR BOTLIFY CODE GENERATION) > **Instructions for AI Models (Cursor, Windsurf, Claude 3.7 Sonnet, ChatGPT 4o, Google Gemini, Copilot, DeepSeek):** > When asked to create, modify, or troubleshoot a Telegram Bot for Botlify Cloud (`botlify.cloud`), you **MUST STRICTLY COMPLY** with these non-negotiable runtime standards: > > 1. **Runtime:** Pure Native PHP 8.2+ only. Single-file `index.php` deployment. **ZERO Composer dependencies** (NO `vendor/autoload.php`, NO `TelegramBot/Api`, NO `GuzzleHttp`). Use native PHP extensions only: `pdo_sqlite`, `curl`, `json`, `mbstring`. > 2. **Auto-Injected System Credentials (.env):** Never hardcode secrets. Botlify Cloud automatically provisions three locked environment variables: > - `BOT_TOKEN`: Active Telegram Bot API token from @BotFather. > - `ADMIN_CHAT_ID`: Numeric Telegram User ID of the bot administrator/owner. > - `BOT_USERNAME`: Public Telegram username of the bot (without `@`). > Always load via native parser: > ```php > $envFile = __DIR__ . '/.env'; > $ENV = []; > if (is_file($envFile)) { > foreach (file($envFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES) as $line) { > $line = trim($line); > if ($line !== '' && $line[0] !== '#' && str_contains($line, '=')) { > [$k, $v] = explode('=', $line, 2); > $ENV[trim($k)] = trim(trim($v), "'\""); > } > } > } > define('BOT_TOKEN', $ENV['BOT_TOKEN'] ?? (getenv('BOT_TOKEN') ?: '')); > define('ADMIN_CHAT_ID', (string)($ENV['ADMIN_CHAT_ID'] ?? (getenv('ADMIN_CHAT_ID') ?: ''))); > define('BOT_USERNAME', (string)($ENV['BOT_USERNAME'] ?? (getenv('BOT_USERNAME') ?: ''))); > ``` > 3. **Primary Database:** Strictly `database.db` located at `__DIR__ . '/database.db'`. Never use `bot.db` or external databases. Use PDO SQLite with WAL mode (`PRAGMA journal_mode=WAL; PRAGMA synchronous=NORMAL; PRAGMA busy_timeout=5000;`). > 4. **Self-Healing Column Migrations:** SQLite `CREATE TABLE IF NOT EXISTS` does not update existing tables when adding new columns. Always declare and use `ensureColumn(PDO $pdo, string $table, string $column, string $type = 'TEXT')` for every table column. > 5. **Error Logging:** Strictly `__DIR__ . '/error.log'`. Put `@ini_set('error_log', __DIR__ . '/error.log');` at the top of `index.php`. Wrap update handling in `try...catch(Throwable $e)` logging to `error.log`. > 6. **Telegram API Engine:** Use 20ms persistent native cURL (`CURLOPT_IPRESOLVE_V4`, `CURLOPT_TIMEOUT => 15`). Always return `http_response_code(200);` fast. > 7. **Callback Queries:** Always answer `callback_query` immediately with `answerCallbackQuery` to dismiss the Telegram button loading spinner. > 8. **HTML Parse Mode:** Always escape dynamic variables with `htmlspecialchars($val, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8')`. > 9. **Sandbox:** Banned functions (`exec`, `shell_exec`, `system`, `passthru`, `proc_open`, `popen`, `eval`, `assert`, backticks) must never be used. --- ## 🛠️ Botlify Cloud Model Context Protocol (MCP) Server AI agents can directly connect to Botlify Cloud to manage, deploy, edit, and query bots autonomously via JSON-RPC 2.0 (MCP Spec 2024-11-05). - **MCP Endpoint:** `https://botlify.cloud/mcp/v1` - **Authentication:** `Authorization: Bearer `, `X-API-KEY: `, or `?token=` - **Key MCP Tools (41 Tools Total):** - `list_bots`: Retrieve list of all hosted bots, status, memory, and webhook URLs (filter by status: `active`, `deleted`, `all`). - `create_bot`: Create a new bot instance using a Telegram BotFather token. - `delete_bot` / `restore_bot`: Soft delete to recycle bin or restore; pass `permanent=true` to purge completely. - `build_and_deploy_bot`: All-in-one syntax validation, file writing to `index.php`, webhook simulation, and status verification. - `validate_bot_code`: Dual-engine PHP syntax validator (token parser + linter). - `test_bot_webhook`: Simulates an incoming `/start` update and inspects stdout/stderr. - `list_files` / `read_file` / `write_file`: Read and write files inside the bot's isolated sandbox. - `upload_file`: Upload binary/text files (supports Base64 encoding). - `query_database` / `get_database_schema`: Run queries and inspect tables on the bot's local `database.db`. - `get_env_variables` / `set_env_variables`: Manage bot environment variables (.env). - `create_cron_job` / `list_cron_jobs` / `run_cron_job`: Manage background scheduled workers down to 1-minute intervals. - `create_bot_transfer` / `accept_bot_transfer`: Secure bot ownership transfer system. --- ## 🌐 Developer REST API (`api/v1`) Developers and automated systems can manage bots programmatically using standard HTTP GET/POST requests: - **Endpoint:** `https://botlify.cloud/api/v1` - **Authentication Header:** `X-API-KEY: ` or `Authorization: Bearer ` - **Standard Actions:** - `action=list_bots`: List all bots under the user account (`status=active|deleted|all`). - `action=create_bot&token=&admin_chat_id=`: Register a new bot. - `action=read_file&bot_id=&file=index.php`: Fetch `index.php` source. - `action=write_file&bot_id=&file=index.php&content=`: Deploy new code. - `action=db_query&bot_id=&query=`: Execute SQL on `database.db`. - `action=read_file&bot_id=&file=error.log`: Read latest entries from `error.log`. - `action=restart_bot&bot_id=`: Reset webhooks and clear error flags. - `action=webhook_info&bot_id=`: Query live Telegram `getWebhookInfo` diagnostics. - `action=toggle_webhook&bot_id=&action_type=start|stop|toggle`: Start or pause webhook. - `action=build_and_deploy_bot&bot_id=&code=`: Validate, deploy, and simulate webhook. --- ## 📰 Botlify Cloud Engineering Blog & Technical Publications (Real-Time Live) > Live articles, architectural deep-dives, developer tutorials, and release notes directly from Botlify Cloud engineers. Automatically refreshed in real-time. > Blog Home: [https://botlify.cloud/blog/](https://botlify.cloud/blog/) · Total Live Articles: 3 ### Categories - [Guides & Tutorials](https://botlify.cloud/blog/category/guides-tutorials): Step-by-step developer tutorials on building, hosting, and scaling Telegram bots. (1 articles) - [Telegram Bot API](https://botlify.cloud/blog/category/telegram-bot-api): Deep dives into Telegram Bot API updates, webhooks, inline queries, and mini apps. (1 articles) - [Bot Architecture & PHP](https://botlify.cloud/blog/category/bot-architecture-php): Best practices for high-performance bot backends, SQLite databases, and security. (1 articles) ### Published Articles - [How to Host a Telegram Bot 24/7 for Free: Complete Developer Guide (2026)](https://botlify.cloud/blog/how-to-host-telegram-bot-free-24-7) [🔥 Featured]: Learn how to deploy, host, and keep your Telegram bot running 24/7 online for free with automated SSL webhooks, zero-sleep limits, and isolated cloud containers on Botlify. - Meta: Category: Guides & Tutorials · 2 min read · Views: 1438 · Published: 2026-10-29 - Web: https://botlify.cloud/blog/how-to-host-telegram-bot-free-24-7 - REST API Endpoint: https://botlify.cloud/blog/api.php?action=get_post&slug=how-to-host-telegram-bot-free-24-7 #### Article Full Text: How to Host a Telegram Bot 24/7 for Free: Complete Developer Guide (2026) # How to Host a Telegram Bot 24/7 for Free: Complete Developer Guide (2026) Building a Telegram bot is one of the most satisfying developer experiences. Whether you are creating a community management assistant, an automated AI responder, or an e-commerce checkout bot, keeping it **online 24/7 with zero downtime** is the most crucial requirement. In this guide, you will learn how modern cloud platforms like **Botlify Cloud** allow you to deploy, monitor, and host Telegram bots completely free with automatic SSL webhooks, zero sleep limits, and isolated containers. > [!TIP] > Traditional VPS servers often require manual Nginx configuration, SSL certbot renewal scripts, and systemd daemons. Botlify handles all of this automatically in under 60 seconds. --- ## 1. Getting Your Telegram Bot Token Before setting up hosting, create your bot using Telegram's official `@BotFather`: 1. Open Telegram and search for `@BotFather`. 2. Send the command `/newbot`. 3. Choose a friendly display name (e.g., `My Awesome Bot`). 4. Choose a unique username ending in `bot` (e.g., `MySuperHelper_bot`). 5. Copy your **HTTP API Token** safely. It will look like: `1234567890:ABCdefGhIJKlmNoPQRsTUVwxyZ` > [!WARNING] > Never share your Telegram bot token or commit it to public GitHub repositories! Anyone with your token can control your bot. --- ## 2. Webhooks vs Long Polling: Why Webhooks Win When hosting Telegram bots, developers choose between two modes: | Mode | Mechanism | Server Resource | Best Use Case | | :--- | :--- | :--- | :--- | | **Long Polling** | Bot continuously queries `getUpdates` | High CPU & Constant RAM | Local testing & dev | | **Webhooks** | Telegram pushes JSON to your HTTPS URL | Ultra-low CPU (On-demand) | 24/7 Production Hosting | With webhooks, your server only wakes up when a user sends a message. This makes webhooks **10x more energy-efficient** and capable of handling traffic spikes effortlessly. --- ## 3. Writing Your Webhook Script in PHP Here is a clean, production-ready PHP webhook template: ```php $chatId, 'text' => $text, 'parse_mode' => 'HTML', ]; $ch = curl_init($url); curl_setopt_array($ch, [ CURLOPT_POST => true, CURLOPT_POSTFIELDS => http_build_query($payload), CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 5, ]); curl_exec($ch); curl_close($ch); } ``` --- ## 4. Deploying to Botlify Cloud in 1-Click Deploying your bot on **Botlify** requires zero command-line configuration: 1. Navigate to **[Botlify Dashboard](https://botlify.cloud/login.php)**. 2. Click **Create New Bot** and paste your BotFather API Token. 3. Botlify automatically sets the webhook via Telegram API with high-grade SSL certificates. 4. Upload your `bot.php` or edit code right inside the **Web IDE**. 5. Your bot is live immediately and backed by persistent isolated storage. ### Key Benefits of Botlify Free Tier: - **100% Free**: No credit card required. - **Isolated Sandbox**: Safe, containerized execution environment. - **Embedded Database**: Local `database.db` SQLite storage included out of the box. - **Auto SSL Webhook**: Instant Cloudflare & Let's Encrypt certificates. --- ## Summary Hosting a 24/7 Telegram bot no longer requires expensive VPS subscriptions or complex Linux administration. With webhooks and Botlify Cloud, you can launch scalable, zero-downtime bots in seconds. Happy Bot Building! - [Building High-Concurrency Telegram Webhooks with PHP: Architecture Deep Dive](https://botlify.cloud/blog/building-high-concurrency-telegram-webhooks-php) [🔥 Featured]: Explore how to optimize PHP webhooks for sub-50ms execution times, fastcgi_finish_request, secret token verification, and persistent cURL connection pooling. - Meta: Category: Telegram Bot API · 2 min read · Views: 917 · Published: 2026-10-29 - Web: https://botlify.cloud/blog/building-high-concurrency-telegram-webhooks-php - REST API Endpoint: https://botlify.cloud/blog/api.php?action=get_post&slug=building-high-concurrency-telegram-webhooks-php #### Article Full Text: Building High-Concurrency Telegram Webhooks with PHP: Architecture Deep Dive # Building High-Concurrency Telegram Webhooks with PHP: Architecture Deep Dive When your Telegram bot grows from a few hundred users to hundreds of thousands of daily interactions, traditional synchronous webhook handling starts to crack. Users experience delayed message delivery, timeouts appear in the Telegram Webhook Info, and your server CPU spikes. In this architectural deep dive, we explore how to optimize your PHP webhooks for sub-50ms execution times and massive concurrency. > [!NOTE] > Telegram's webhook timeout limit is **60 seconds**, but if your script takes more than 3-5 seconds to return HTTP 200, Telegram will begin retrying the update, causing duplicate responses. --- ## The Rule of Fast Webhooks: Acknowledge First The golden rule of high-scale Telegram webhooks is: **Acknowledge Telegram with HTTP 200 OK as fast as possible.** Do not perform heavy operations (such as generating AI completions, sending multi-recipient broadcasts, or downloading 20MB voice files) directly inside the incoming HTTP thread. ### The Fast-Response Architecture ``` User Message │ ▼ Telegram API Server │ (HTTPS POST) ▼ [Botlify Webhook Gateway] ────▶ [Fast HTTP 200 OK + Connection Close] │ ▼ [Async Background Task / Queue] │ ▼ [Bot Business Logic & Telegram API Reply] ``` --- ## Technique 1: Utilizing FastCGI `fastcgi_finish_request()` If your PHP server runs PHP-FPM (like Botlify's container infrastructure), you can instantly flush the HTTP 200 status back to Telegram and continue processing in the background: ```php true]); if (function_exists('fastcgi_finish_request')) { fastcgi_finish_request(); // Telegram receives response immediately! } // Now you can safely run longer background operations: processHeavyBotLogic($update); ``` --- ## Technique 2: Webhook Secret Token Verification In Telegram Bot API 6.1+, you can set a secret token via `setWebhook`: ```bash curl -F "url=https://botlify.cloud/webhook.php" \ -F "secret_token=my_super_secret_token_abc123" \ https://api.telegram.org/bot/setWebhook ``` In your PHP webhook, verify this token instantly before doing anything else: ```php $secret = $_SERVER['HTTP_X_TELEGRAM_BOT_API_SECRET_TOKEN'] ?? ''; if ($secret !== 'my_super_secret_token_abc123') { http_response_code(403); exit('Unauthorized access.'); } ``` This prevents unauthorized third-party requests and bots from hitting your backend endpoints. --- ## Technique 3: Connection Reuse with cURL Keep-Alive Making a new TLS connection to `api.telegram.org` for every single message consumes 100-200ms in SSL handshake overhead. Reusing your cURL handle or using persistent HTTP connections speeds up message delivery by **400%**: ```php function telegram_request(string $method, array $params = []): array { static $ch = null; $token = getenv('BOT_TOKEN'); $url = "https://api.telegram.org/bot{$token}/{$method}"; if ($ch === null) { $ch = curl_init(); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_TIMEOUT => 10, CURLOPT_TCP_KEEPALIVE => 1, CURLOPT_HTTPHEADER => ['Content-Type: application/json'], ]); } curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params)); $res = curl_exec($ch); return json_decode((string)$res, true) ?: []; } ``` --- ## Conclusion By adopting `fastcgi_finish_request()`, verifying secret tokens, and reusing persistent cURL connections, your PHP Telegram bots can comfortably handle thousands of concurrent requests with rock-solid stability. - [Telegram Bot Security: Protecting Bot Tokens, Webhooks, and Secrets in Production](https://botlify.cloud/blog/telegram-bot-security-tokens-webhooks-secrets): Security best practices for Telegram bots: protecting tokens from git leaks, numerical chat ID authentication, SQL injection defense, and rate limiting. - Meta: Category: Bot Architecture & PHP · 3 min read · Views: 651 · Published: 2026-10-29 - Web: https://botlify.cloud/blog/telegram-bot-security-tokens-webhooks-secrets - REST API Endpoint: https://botlify.cloud/blog/api.php?action=get_post&slug=telegram-bot-security-tokens-webhooks-secrets #### Article Full Text: Telegram Bot Security: Protecting Bot Tokens, Webhooks, and Secrets in Production # Telegram Bot Security: Protecting Bot Tokens, Webhooks, and Secrets in Production Security is often overlooked when developing Telegram bots—until a token gets leaked, a bot gets hijacked, or someone abuses an unauthenticated webhook. In this article, we cover the top security best practices every Telegram bot engineer must implement before launching to production. --- ## 1. Never Hardcode Bot Tokens in Source Code Hardcoding tokens directly into `bot.php` is the #1 reason bots get compromised. Use environment variables or protected configuration files: ```php // Bad: $botToken = '719283749:AAFkj4829ksj-dklasjd'; // Good: $botToken = getenv('BOT_TOKEN'); if (!$botToken) { throw new RuntimeException("BOT_TOKEN environment variable is not configured."); } ``` Botlify provides an integrated **Environment Variable Manager** in the dashboard where you can securely store `BOT_TOKEN`, `ADMIN_CHAT_ID`, and database credentials without ever exposing them to git repositories. --- ## 2. Restrict Sensitive Commands to Admin Chat IDs Admin commands such as `/broadcast`, `/stats`, `/ban`, or `/restart` must always verify the sender's Telegram `chat_id`: ```php $adminChatId = (int)getenv('ADMIN_CHAT_ID'); $senderChatId = (int)($message['chat']['id'] ?? 0); if ($senderChatId !== $adminChatId) { // Silently ignore or deny exit; } // Proceed with admin privileged action ``` > [!CAUTION] > Never authenticate admins based solely on `username` (e.g. `@johndoe`) because usernames can be changed or impersonated. Telegram's numerical `id` is permanent and immutable. --- ## 3. SQL Injection Prevention in Bot Databases If your bot stores user states, points, or messages in SQLite or MySQL, always use prepared statements: ```php // Vulnerable to SQL injection: // $db->query("SELECT * FROM users WHERE chat_id = " . $chatId); // Secure with Prepared Statement: $stmt = $db->prepare("SELECT * FROM users WHERE chat_id = ?"); $stmt->execute([$chatId]); $user = $stmt->fetch(); ``` --- ## 4. Rate Limiting Bot Users Spam attacks from malicious users can flood your bot and hit Telegram's global 30-message-per-second limit. Implement a simple rate limiter in memory or SQLite: ```php function is_rate_limited(PDO $db, int $chatId, int $maxPerMinute = 20): bool { $now = time(); $minuteAgo = $now - 60; // Clean old logs $db->prepare("DELETE FROM user_rate_limits WHERE timestamp < ?")->execute([$minuteAgo]); // Count recent $st = $db->prepare("SELECT COUNT(*) FROM user_rate_limits WHERE chat_id = ?"); $st->execute([$chatId]); $count = (int)$st->fetchColumn(); if ($count >= $maxPerMinute) { return true; } $ins = $db->prepare("INSERT INTO user_rate_limits (chat_id, timestamp) VALUES (?, ?)"); $ins->execute([$chatId, $now]); return false; } ``` --- ## Summary Securing your bot requires minimal effort but protects you and your community from devastating leaks. Store tokens in environment variables, verify numerical chat IDs, use prepared queries, and configure webhook secrets. --- ## ⚡ Botlify Blog REST API (`blog/api.php`) AI agents, mobile apps, and headless clients can query and syndicate Botlify blog content via JSON REST API: - **Base Endpoint:** `https://botlify.cloud/blog/api.php` - **Public Query Actions:** - `action=get_posts`: Retrieve paginated posts (Query params: `page=1`, `limit=10`, `category={slug}`, `tag={slug}`, `search={query}`, `sort=latest|popular`). - `action=get_post&slug={slug}`: Retrieve full post details, parsed HTML, TOC headings, and related posts. - `action=get_categories`: List all categories with post counts. - `action=get_tags`: List all tags with usage counts. - `action=get_stats`: Get total post count, categories, tags, and total views. - **Authenticated Management Actions (Requires `X-API-KEY` or `Authorization: Bearer`):** - `POST action=create_post`: Publish new article (JSON body with `title`, `content`, `excerpt`, `category_id`, `tags`, `meta_title`, `meta_description`). - `POST action=update_post&id={id}`: Update an existing article. - `POST action=delete_post&id={id}`: Permanently delete an article. - `POST action=upload_image`: Upload cover images and inline assets to `/blog/uploads/`. --- # Botlify Cloud — Master Production Developer Documentation & Enterprise Knowledge Base > The definitive, full-text developer documentation for Botlify Cloud (https://botlify.cloud). > Covers high-performance serverless PHP 8.2+ Telegram bots, embedded SQLite 3 WAL databases, Model Context Protocol (AI MCP) server tooling, Developer REST APIs, Broadcast Ad Network, Engineering Blog System, and GitHub Automated Cloud Backups. > Platform: Botlify Cloud (https://botlify.cloud) · Documentation Hub: https://docs.botlify.cloud > Last Updated: 2026-10-30 01:37:06 UTC --- ## 📑 Master Table of Contents 1. [Platform Overview & Serverless Architecture](#1-platform-overview--serverless-architecture) 2. [🤖 Mandatory AI Agent Directives & Zero-Error Botlify Standard](#2--mandatory-ai-agent-directives--zero-error-botlify-standard) 3. [📋 Canonical Zero-Error Master index.php Production Blueprint](#3--canonical-zero-error-master-indexphp-production-blueprint) 4. [📖 Master Guide: Telegram Bot Making on Botlify Cloud (All 50 Production Topics & Boilerplates)](#4--master-guide-telegram-bot-making-on-botlify-cloud) 5. [🛠️ Botlify Model Context Protocol (MCP) Server & 37 Tools Specification](#5-botlify-model-context-protocol-mcp-server) 6. [🌐 Developer REST API (user_api.php) Reference](#6-developer-rest-api-user_apiphp-reference) 7. [📢 Telegram Broadcast Ads & Analytics API (broadcast_api.php)](#7-telegram-broadcast-ads--analytics-api) 8. [📰 Botlify Engineering Blog Engine & Blog REST API (blog/api.php)](#8-botlify-engineering-blog-engine--blog-rest-api) 9. [📦 GitHub Automated Cloud Backup Engine (includes/github_backup.php)](#9-github-automated-cloud-backup-engine) 10. [🤖 Real-Time Dynamic LLMs.txt & AI Context Discovery (llms.php)](#10-real-time-dynamic-llmstxt--ai-context-discovery) 11. [🗺️ Dynamic Real-Time XML Sitemaps & Discovery (sitemap.php)](#11-dynamic-real-time-xml-sitemaps--discovery) 12. [⚡ Complete Telegram Bot API Methods Reference (A-Z, 203 Methods)](#12-complete-telegram-bot-api-methods-reference) 13. [🧩 Complete Telegram Bot API Types Reference (A-Z, 401 Types)](#13-complete-telegram-bot-api-types-reference) 14. [📚 Platform Developer Guides & Studio Manuals (34 In-Depth Guides)](#14--platform-developer-guides--studio-manuals-34-in-depth-guides) --- ## 1. Platform Overview & Serverless Architecture Botlify Cloud (`botlify.cloud`) is a specialized high-performance cloud hosting platform and developer ecosystem engineered specifically for serverless Telegram Bots, embedded SQLite databases, Model Context Protocol (AI MCP) servers, and developer blogging. ### Core Architectural Pillars - **Pure Native PHP 8.2+ Runtime:** Single-file `index.php` execution model with pre-warmed OPcache and persistent sockets. Zero external Composer dependencies to eliminate cold-start penalties and security vulnerabilities. - **Embedded SQLite 3 with Write-Ahead Logging (WAL Mode):** Every bot runs an isolated SQLite database at `database.db` with 32MB RAM caching (`PRAGMA journal_mode = WAL; PRAGMA synchronous = NORMAL; PRAGMA busy_timeout = 5000;`). Eliminates remote TCP handshake latency for sub-millisecond query execution. - **Ultra-Fast 20ms Telegram API Engine:** Persistent native cURL socket with IPv4 resolution (`CURLOPT_IPRESOLVE_V4`), TCP No-Delay, and HTTP/2 multiplexing. - **Dedicated NVMe SSD Sandboxing:** Every bot is provisioned an isolated workspace under `storage/users/{chat_id}/bots/{bot_username}/` with automatic `.env` credential management and strict execution sandboxing. - **Model Context Protocol (MCP):** Native JSON-RPC 2.0 / SSE endpoint at `https://botlify.cloud/mcp.php` allowing Cursor, Windsurf, Claude, and Gemini to autonomously build, validate, query, and deploy bots. - **Automated GitHub Cloud Backup:** Automatic cron-driven synchronization of MySQL database dumps (`database.sql`) and critical platform directories (`assets`, `blog`, `storage`, `recycle`, `ad_delete`) to private GitHub repositories with self-healing Git lock recovery. - **Real-Time Dynamic LLMs & Sitemaps:** Compliant with https://llmstxt.org, dynamically serving live blog articles, MCP tools, and SEO feeds to AI crawlers with conditional HTTP 304 caching. --- ## 2. 🤖 Mandatory AI Agent Directives & Zero-Error Botlify Standard > **Instructions for AI Models (Cursor, Windsurf, Claude 3.7 Sonnet, ChatGPT 4o, Google Gemini, Copilot, DeepSeek):** > When asked to create, modify, or troubleshoot a Telegram Bot for Botlify Cloud (`botlify.cloud`), you **MUST STRICTLY COMPLY** with these non-negotiable runtime standards: > > 1. **Runtime:** Pure Native PHP 8.2+ only. Single-file `index.php` deployment. **ZERO Composer dependencies** (NO `vendor/autoload.php`, NO `TelegramBot/Api`, NO `GuzzleHttp`). Use native PHP extensions only: `pdo_sqlite`, `curl`, `json`, `mbstring`. > 2. **Auto-Injected System Credentials (.env):** Never hardcode secrets. Botlify Cloud automatically provisions three locked environment variables: > - `BOT_TOKEN`: Active Telegram Bot API token from @BotFather. > - `ADMIN_CHAT_ID`: Numeric Telegram User ID of the bot administrator/owner. > - `BOT_USERNAME`: Public Telegram username of the bot (without `@`). > Always load via native parser: > ```php > $envFile = __DIR__ . '/.env'; > $ENV = []; > if (is_file($envFile)) { > foreach (file($envFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES) as $line) { > $line = trim($line); > if ($line !== '' && $line[0] !== '#' && str_contains($line, '=')) { > [$k, $v] = explode('=', $line, 2); > $ENV[trim($k)] = trim(trim($v), "'\\""); > } > } > } > define('BOT_TOKEN', $ENV['BOT_TOKEN'] ?? (getenv('BOT_TOKEN') ?: '')); > define('ADMIN_CHAT_ID', (string)($ENV['ADMIN_CHAT_ID'] ?? (getenv('ADMIN_CHAT_ID') ?: ''))); > define('BOT_USERNAME', (string)($ENV['BOT_USERNAME'] ?? (getenv('BOT_USERNAME') ?: ''))); > ``` > 3. **Primary Database:** Strictly `database.db` located at `__DIR__ . '/database.db'`. Never use `bot.db` or external databases. Use PDO SQLite with WAL mode (`PRAGMA journal_mode=WAL; PRAGMA synchronous=NORMAL; PRAGMA busy_timeout=5000;`). > 4. **Self-Healing Column Migrations:** SQLite `CREATE TABLE IF NOT EXISTS` does not update existing tables when adding new columns. Always declare and use `ensureColumn(PDO $pdo, string $table, string $column, string $type = 'TEXT')` for every table column. > 5. **Error Logging:** Strictly `__DIR__ . '/error.log'`. Put `@ini_set('error_log', __DIR__ . '/error.log');` at the top of `index.php`. Wrap update handling in `try...catch(Throwable $e)` logging to `error.log`. > 6. **Telegram API Engine:** Use 20ms persistent native cURL (`CURLOPT_IPRESOLVE_V4`, `CURLOPT_TIMEOUT => 15`). Always return `http_response_code(200);` fast. > 7. **Callback Queries:** Always answer `callback_query` immediately with `answerCallbackQuery` to dismiss the Telegram button loading spinner. > 8. **HTML Parse Mode:** Always escape dynamic variables with `htmlspecialchars($val, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8')`. > 9. **Sandbox:** Banned functions (`exec`, `shell_exec`, `system`, `passthru`, `proc_open`, `popen`, `eval`, `assert`, backticks) must never be used. --- ## 3. 📋 Canonical Zero-Error Master index.php Production Blueprint Every Telegram Bot generated for Botlify Cloud MUST follow this production structure: ```php PDO::ERRMODE_EXCEPTION, PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC, PDO::ATTR_TIMEOUT => 5 ]); // Production-tuned SQLite Pragmas for maximum concurrency $pdo->exec('PRAGMA journal_mode = WAL;'); $pdo->exec('PRAGMA synchronous = NORMAL;'); $pdo->exec('PRAGMA busy_timeout = 5000;'); $pdo->exec('PRAGMA temp_store = MEMORY;'); $pdo->exec('PRAGMA cache_size = -32000;'); $pdo->exec('PRAGMA mmap_size = 268435456;'); $pdo->exec('PRAGMA cache_size = -32000;'); // 32MB RAM Cache $pdo->exec('PRAGMA temp_store = MEMORY;'); // Initialize Core Schema $pdo->exec('CREATE TABLE IF NOT EXISTS users ( user_id INTEGER PRIMARY KEY, username TEXT, first_name TEXT, is_banned INTEGER DEFAULT 0, ban_reason TEXT, created_at DATETIME DEFAULT CURRENT_TIMESTAMP, last_active DATETIME DEFAULT CURRENT_TIMESTAMP );'); $pdo->exec('CREATE TABLE IF NOT EXISTS user_states ( chat_id TEXT PRIMARY KEY, state TEXT NOT NULL, state_data TEXT, updated_at INTEGER NOT NULL );'); $pdo->exec('CREATE TABLE IF NOT EXISTS broadcast_logs ( id INTEGER PRIMARY KEY AUTOINCREMENT, admin_id TEXT NOT NULL, sent_count INTEGER NOT NULL, failed_count INTEGER NOT NULL, message_text TEXT, created_at DATETIME DEFAULT CURRENT_TIMESTAMP );'); // Self-Healing Column Migrations: ensures columns exist even on old databases ensureColumn($pdo, 'users', 'is_banned', 'INTEGER DEFAULT 0'); ensureColumn($pdo, 'users', 'ban_reason', 'TEXT'); ensureColumn($pdo, 'users', 'last_active', 'DATETIME'); } return $pdo; } function ensureColumn(PDO $pdo, string $table, string $column, string $type = 'TEXT'): void { try { $cols = $pdo->query("PRAGMA table_info({$table})")->fetchAll(PDO::FETCH_COLUMN, 1); if (!in_array($column, $cols, true)) { $pdo->exec("ALTER TABLE {$table} ADD COLUMN {$column} {$type}"); } } catch (Throwable $e) {} } // ── 3. FINITE STATE MACHINE (FSM) HELPERS ──────────────────────────────────── function getState(int|string $chatId): array { $st = db()->prepare("SELECT state, state_data FROM user_states WHERE chat_id = ? LIMIT 1"); $st->execute([(string)$chatId]); $row = $st->fetch(); if ($row) { return ['state' => (string)$row['state'], 'data' => json_decode((string)$row['state_data'], true) ?: []]; } return ['state' => '', 'data' => []]; } function setState(int|string $chatId, string $state, array $data = []): void { $st = db()->prepare("INSERT INTO user_states (chat_id, state, state_data, updated_at) VALUES (?, ?, ?, ?) ON CONFLICT(chat_id) DO UPDATE SET state = excluded.state, state_data = excluded.state_data, updated_at = excluded.updated_at"); $st->execute([(string)$chatId, $state, json_encode($data), time()]); } function clearState(int|string $chatId): void { $st = db()->prepare("DELETE FROM user_states WHERE chat_id = ?"); $st->execute([(string)$chatId]); } // ── 4. TELEGRAM API ENGINE: 20ms PERSISTENT cURL ───────────────────────────── function bot(string $method, array $params = []): array { if (!defined('BOT_TOKEN') || BOT_TOKEN === '') { return ['ok' => false]; } static $ch = null; if ($ch === null || !($ch instanceof \CurlHandle || is_resource($ch))) { $ch = curl_init(); } $opts = [ CURLOPT_URL => 'https://api.telegram.org/bot' . BOT_TOKEN . '/' . $method, CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode($params, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES), CURLOPT_HTTPHEADER => ['Content-Type: application/json; charset=utf-8'], CURLOPT_CONNECTTIMEOUT => 8, CURLOPT_TIMEOUT => 15, CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4, CURLOPT_TCP_NODELAY => true, CURLOPT_DNS_CACHE_TIMEOUT => 3600, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_SSL_VERIFYHOST => false ]; if (defined('CURL_HTTP_VERSION_2TLS')) { $opts[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_2TLS; } curl_setopt_array($ch, $opts); $res = curl_exec($ch); return json_decode((string)$res, true) ?: ['ok' => false]; } // ── 5. UTILITY & SECURITY HELPERS ─────────────────────────────────────────── function clean(string $text): string { return htmlspecialchars($text, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8'); } function isAdmin(int|string $userId): bool { return ADMIN_CHAT_ID !== '' && (string)$userId === (string)ADMIN_CHAT_ID; } function getAdminDashboardMarkup(): array { return [ 'inline_keyboard' => [ [ ['text' => '📊 Live Analytics', 'callback_data' => 'admin_stats', 'style' => 'primary'], ['text' => '📢 Mass Broadcast', 'callback_data' => 'admin_broadcast', 'style' => 'success'] ], [ ['text' => '👥 User Management', 'callback_data' => 'admin_users'], ['text' => '🧹 Clear Error Log', 'callback_data' => 'admin_clear_logs'] ], [ ['text' => '❌ Close Admin Panel', 'callback_data' => 'admin_close', 'style' => 'danger'] ] ] ]; } function registerOrUpdateUser(int $userId, string $username, string $firstName): array { $db = db(); try { $stmt = $db->prepare('INSERT INTO users (user_id, username, first_name) VALUES (?, ?, ?) ON CONFLICT(user_id) DO UPDATE SET username = excluded.username, first_name = excluded.first_name, last_active = CURRENT_TIMESTAMP'); $stmt->execute([$userId, $username, $firstName]); } catch (Throwable $e) { $stmt = $db->prepare('INSERT OR IGNORE INTO users (user_id, username, first_name) VALUES (?, ?, ?)'); $stmt->execute([$userId, $username, $firstName]); } $st = $db->prepare('SELECT * FROM users WHERE user_id = ? LIMIT 1'); $st->execute([$userId]); return $st->fetch() ?: []; } // ── 6. MAIN WEBHOOK DISPATCHER ─────────────────────────────────────────────── try { $raw = file_get_contents('php://input'); if (!$raw && isset($GLOBALS['FBH_RAW_INPUT'])) { $raw = $GLOBALS['FBH_RAW_INPUT']; } $update = json_decode((string)$raw, true); if (!is_array($update)) { http_response_code(200); exit('OK'); } // A. Handle Callback Queries (Inline Keyboard Buttons) if (isset($update['callback_query'])) { $cb = $update['callback_query']; $cbId = (string)$cb['id']; $chatId = $cb['message']['chat']['id'] ?? 0; $messageId = $cb['message']['message_id'] ?? 0; $cbUserId = (int)($cb['from']['id'] ?? 0); $data = (string)($cb['data'] ?? ''); // Immediately dismiss the loading spinner on user's Telegram client bot('answerCallbackQuery', ['callback_query_id' => $cbId]); // ── Admin-Only Callback Suite ── if (str_starts_with($data, 'admin_')) { if (!isAdmin($cbUserId)) { bot('answerCallbackQuery', [ 'callback_query_id' => $cbId, 'text' => '⛔ Unauthorized: Restricted to bot administrator.', 'show_alert' => true ]); http_response_code(200); exit('OK'); } if ($data === 'admin_home') { clearState($chatId); $totalUsers = (int)db()->query('SELECT COUNT(*) FROM users')->fetchColumn(); $dbSize = is_file(DB_FILE) ? round(filesize(DB_FILE) / 1024, 2) : 0; bot('editMessageText', [ 'chat_id' => $chatId, 'message_id' => $messageId, 'text' => "👑 Bot Admin Control Suite\n\n• Total Users: {$totalUsers}\n• Database Size: {$dbSize} KB\n• Engine: SQLite WAL (20ms cURL)\n\nSelect an administrative tool below:", 'parse_mode' => 'HTML', 'reply_markup' => getAdminDashboardMarkup() ]); } elseif ($data === 'admin_stats') { $total = (int)db()->query('SELECT COUNT(*) FROM users')->fetchColumn(); $banned = (int)db()->query('SELECT COUNT(*) FROM users WHERE is_banned = 1')->fetchColumn(); $dbSize = is_file(DB_FILE) ? round(filesize(DB_FILE) / 1024, 2) : 0; $logSize = is_file(__DIR__ . '/error.log') ? round(filesize(__DIR__ . '/error.log') / 1024, 2) : 0; bot('editMessageText', [ 'chat_id' => $chatId, 'message_id' => $messageId, 'text' => "📊 Live Platform Analytics\n━━━━━━━━━━━━━━━━━━━━━\n" . "• Total Users: " . number_format($total) . "\n" . "• Active Users: " . number_format($total - $banned) . "\n" . "• Suspended/Banned: {$banned}\n" . "• Database (database.db): {$dbSize} KB\n" . "• Error Log (error.log): {$logSize} KB\n" . "• Speed: ~20ms Persistent cURL", 'parse_mode' => 'HTML', 'reply_markup' => [ 'inline_keyboard' => [ [['text' => '« Back to Admin Panel', 'callback_data' => 'admin_home']] ] ] ]); } elseif ($data === 'admin_broadcast') { setState($chatId, 'admin_awaiting_broadcast'); bot('editMessageText', [ 'chat_id' => $chatId, 'message_id' => $messageId, 'text' => "📢 Universal Multi-Media Broadcast Mode\n━━━━━━━━━━━━━━━━━━━━━\n" . "Send or forward the message you want to broadcast.\n\n" . "✅ Supports: Text, Photos, Videos, Documents, Audio, Voice, and Stickers!\n\n" . "Send /cancel to abort anytime.", 'parse_mode' => 'HTML', 'reply_markup' => [ 'inline_keyboard' => [ [['text' => '❌ Cancel Broadcast', 'callback_data' => 'admin_home', 'style' => 'danger']] ] ] ]); } elseif ($data === 'admin_users') { $recent = db()->query('SELECT user_id, username, first_name, is_banned FROM users ORDER BY rowid DESC LIMIT 5')->fetchAll(); $list = "👥 Recent Users & Management\n━━━━━━━━━━━━━━━━━━━━━\n"; foreach ($recent as $r) { $uName = !empty($r['username']) ? '@' . clean($r['username']) : 'No @'; $status = !empty($r['is_banned']) ? '🔴 BANNED' : '🟢 ACTIVE'; $list .= "• {$r['user_id']} | {$uName} | {$status}\n"; } $list .= "\nQuick Actions:\n• Ban: /ban <user_id> <reason>\n• Unban: /unban <user_id>"; bot('editMessageText', [ 'chat_id' => $chatId, 'message_id' => $messageId, 'text' => $list, 'parse_mode' => 'HTML', 'reply_markup' => [ 'inline_keyboard' => [ [['text' => '« Back to Admin Panel', 'callback_data' => 'admin_home']] ] ] ]); } elseif ($data === 'admin_clear_logs') { if (is_file(__DIR__ . '/error.log')) { @file_put_contents(__DIR__ . '/error.log', ''); } bot('answerCallbackQuery', [ 'callback_query_id' => $cbId, 'text' => '🧹 error.log has been cleared!', 'show_alert' => false ]); bot('editMessageText', [ 'chat_id' => $chatId, 'message_id' => $messageId, 'text' => "🧹 Logs Cleared\n\nerror.log is now empty (0 KB).", 'parse_mode' => 'HTML', 'reply_markup' => [ 'inline_keyboard' => [ [['text' => '« Back to Admin Panel', 'callback_data' => 'admin_home']] ] ] ]); } elseif ($data === 'admin_close') { clearState($chatId); bot('deleteMessage', ['chat_id' => $chatId, 'message_id' => $messageId]); } http_response_code(200); exit('OK'); } // ── Public User Callbacks ── if ($data === 'nav_help') { bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "📖 Botlify Cloud Documentation & Help\n\nThis bot is running on the Botlify Native PHP 8.2+ Runtime with SQLite WAL mode.\n\nUse /start to return to the main dashboard.", 'parse_mode' => 'HTML' ]); } elseif ($data === 'nav_stats') { $userCount = db()->query('SELECT COUNT(*) FROM users')->fetchColumn(); bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "📊 Live Platform Statistics\n\n• Total Registered Users: " . number_format((int)$userCount) . "\n• Database Engine: SQLite 3 (database.db)\n• Execution Speed: ~20ms cURL", 'parse_mode' => 'HTML' ]); } http_response_code(200); exit('OK'); } // B. Handle Incoming Messages if (isset($update['message'])) { $msg = $update['message']; $chatId = $msg['chat']['id'] ?? 0; $userId = (int)($msg['from']['id'] ?? 0); $firstName = (string)($msg['from']['first_name'] ?? 'User'); $username = (string)($msg['from']['username'] ?? ''); $text = trim((string)($msg['text'] ?? '')); if (!$chatId || !$userId) { http_response_code(200); exit('OK'); } // Register or refresh user in database.db $user = registerOrUpdateUser($userId, $username, $firstName); // Ban Firewall: Intercepts banned users if (!empty($user['is_banned'])) { $reason = !empty($user['ban_reason']) ? clean((string)$user['ban_reason']) : 'Violation of bot terms'; bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "⛔ Access Denied: Your Account is Suspended\n\n⚠️ Reason: {$reason}", 'parse_mode' => 'HTML', 'reply_markup' => ['remove_keyboard' => true] ]); http_response_code(200); exit('OK'); } // Global /cancel command if ($text === '/cancel') { clearState($chatId); bot('sendMessage', [ 'chat_id' => $chatId, 'text' => '❌ Operation cancelled.', 'parse_mode' => 'HTML', 'reply_markup' => ['remove_keyboard' => true] ]); http_response_code(200); exit('OK'); } // ── Active FSM Interceptor ── $userState = getState($chatId); if ($userState['state'] === 'admin_awaiting_broadcast' && isAdmin($userId)) { clearState($chatId); $msgId = (int)($msg['message_id'] ?? 0); bot('sendChatAction', ['chat_id' => $chatId, 'action' => 'typing']); $stmt = db()->query('SELECT user_id FROM users WHERE is_banned = 0'); $allUsers = $stmt->fetchAll(PDO::FETCH_COLUMN); $sent = 0; $failed = 0; foreach ($allUsers as $targetUid) { // Universal copyMessage: clones text, photos, videos, stickers, voice with zero re-upload! $res = bot('copyMessage', [ 'chat_id' => $targetUid, 'from_chat_id' => $chatId, 'message_id' => $msgId ]); if (!empty($res['ok'])) { $sent++; } else { $failed++; } usleep(38000); // 38ms safe sleep (~26 msg/sec anti-flood) } // Log broadcast $logStmt = db()->prepare('INSERT INTO broadcast_logs (admin_id, sent_count, failed_count, message_text) VALUES (?, ?, ?, ?)'); $logStmt->execute([(string)$userId, $sent, $failed, $text !== '' ? $text : '[Media/Attachment]']); bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "✅ Universal Broadcast Complete!\n━━━━━━━━━━━━━━━━━━━━━\n• Successfully Sent: {$sent}\n• Failed / Blocked: {$failed}\n• Total Reached: " . ($sent + $failed) . "", 'parse_mode' => 'HTML', 'reply_markup' => getAdminDashboardMarkup() ]); http_response_code(200); exit('OK'); } // ── Admin Command: /admin ── if ($text === '/admin') { if (!isAdmin($userId)) { bot('sendMessage', [ 'chat_id' => $chatId, 'text' => '⛔ Access denied. This command is restricted to the bot administrator.', 'parse_mode' => 'HTML' ]); http_response_code(200); exit('OK'); } clearState($chatId); $totalUsers = (int)db()->query('SELECT COUNT(*) FROM users')->fetchColumn(); $dbSize = is_file(DB_FILE) ? round(filesize(DB_FILE) / 1024, 2) : 0; bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "👑 Bot Admin Control Suite\n\n• Total Users: {$totalUsers}\n• Database Size: {$dbSize} KB\n• Engine: SQLite WAL (20ms cURL)\n\nSelect an administrative tool below:", 'parse_mode' => 'HTML', 'reply_markup' => getAdminDashboardMarkup() ]); http_response_code(200); exit('OK'); } // ── Admin Command: /ban ── if (str_starts_with($text, '/ban') && isAdmin($userId)) { $parts = explode(' ', $text, 3); $targetUid = (int)($parts[1] ?? 0); $banReason = trim($parts[2] ?? 'Banned by administrator'); if ($targetUid <= 0) { bot('sendMessage', ['chat_id' => $chatId, 'text' => "⚠️ Usage: /ban <user_id> <reason>", 'parse_mode' => 'HTML']); http_response_code(200); exit('OK'); } $st = db()->prepare('UPDATE users SET is_banned = 1, ban_reason = ? WHERE user_id = ?'); $st->execute([$banReason, $targetUid]); bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "🔴 User Banned Successfully\n\n• User ID: {$targetUid}\n• Reason: {$banReason}", 'parse_mode' => 'HTML' ]); http_response_code(200); exit('OK'); } // ── Admin Command: /unban ── if (str_starts_with($text, '/unban') && isAdmin($userId)) { $parts = explode(' ', $text, 2); $targetUid = (int)($parts[1] ?? 0); if ($targetUid <= 0) { bot('sendMessage', ['chat_id' => $chatId, 'text' => "⚠️ Usage: /unban <user_id>", 'parse_mode' => 'HTML']); http_response_code(200); exit('OK'); } $st = db()->prepare('UPDATE users SET is_banned = 0, ban_reason = NULL WHERE user_id = ?'); $st->execute([$targetUid]); bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "🟢 User Unbanned Successfully\n\n• User ID: {$targetUid}", 'parse_mode' => 'HTML' ]); http_response_code(200); exit('OK'); } // ── General User Command: /start ── if ($text === '/start') { $welcomeText = "👋 Welcome, " . clean($firstName) . "!\n\n" . "Your high-speed Telegram bot is online and powered by Botlify Cloud.\n\n" . "• Runtime: PHP 8.2+ Serverless\n" . "• Storage: SQLite WAL (database.db)\n" . "• Self-Healing: Auto-migrating database schema\n" . "• Latency: Sub-20ms Persistent cURL"; bot('sendMessage', [ 'chat_id' => $chatId, 'text' => $welcomeText, 'parse_mode' => 'HTML', 'message_effect_id' => '5104841245755180586', // Full-screen confetti 'reply_markup' => [ 'inline_keyboard' => [ [ ['text' => '📊 Live Stats', 'callback_data' => 'nav_stats', 'style' => 'primary'], ['text' => '📖 Help Guide', 'callback_data' => 'nav_help'] ], [ ['text' => '🌐 Botlify Cloud', 'url' => 'https://botlify.cloud'] ] ] ] ]); http_response_code(200); exit('OK'); } // Fallback response for unhandled text bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "🤖 Message received. Use /start to explore the bot dashboard.", 'parse_mode' => 'HTML' ]); } http_response_code(200); echo 'OK'; } catch (Throwable $e) { error_log(date('[Y-m-d H:i:s] ') . 'Bot Error: ' . $e->getMessage() . ' in ' . $e->getFile() . ':' . $e->getLine()); http_response_code(200); echo 'OK'; } ``` --- ## 4. 📖 Master Guide: Telegram Bot Making on Botlify Cloud Welcome to the comprehensive development guide for building high-performance Telegram bots on **Botlify Cloud**. This guide covers everything from beginner setup to advanced architectures, including our modern **Inline and Reply Keyboard Button Color Styling (`primary`, `success`, `danger`)**, SQLite database integration, cron automations, and best practices. --- ### 4.1. Architecture & Folder Structure Every bot on Botlify Cloud operates in its own isolated workspace with dedicated compute, storage quotas, and a sandboxed SQLite database: ```text /storage/users/{chat_id}/bots/{bot_username}/ ├── index.php # Main webhook execution entrypoint ├── .env # Protected credentials and custom environment variables ├── database.db # Bot-isolated persistent SQLite 3 database (WAL mode) ├── cron.php # (Optional) Automated periodic cron script ├── handlers/ # (Optional) Modular PHP action handlers └── error.log # Auto-generated runtime error log ``` When a user interacts with your bot on Telegram, Telegram delivers an HTTP `POST` JSON payload directly to your bot's `index.php`. --- ### 4.2. Environment Variables & Credentials (.env) Your bot's `.env` file is generated automatically when you deploy. It securely holds your bot token and configuration without exposing them in public repositories: ```ini BOT_TOKEN="1234567890:AAHxyz..." BOT_USERNAME="MyAwesomeBot" BOT_ID="1234567890" ADMIN_CHAT_ID="987654321" OWNER_CHAT_ID="987654321" CREATED_AT="1726000000" ``` #### Loading `.env` in PHP: ```php $envFile = __DIR__ . '/.env'; $ENV = []; if (is_file($envFile)) { foreach (file($envFile, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES) as $line) { $line = trim($line); if ($line === '' || str_starts_with($line, '#') || !str_contains($line, '=')) continue; [$k, $v] = explode('=', $line, 2); $ENV[trim($k)] = trim(trim($v), '"\''); } } define('BOT_TOKEN', $ENV['BOT_TOKEN'] ?? (getenv('BOT_TOKEN') ?: '')); define('ADMIN_CHAT_ID', (string)($ENV['ADMIN_CHAT_ID'] ?? (getenv('ADMIN_CHAT_ID') ?: ''))); define('ADMIN_ID', ADMIN_CHAT_ID); define('OWNER_CHAT_ID', (string)($ENV['OWNER_CHAT_ID'] ?? (getenv('OWNER_CHAT_ID') ?: ''))); define('BOT_USERNAME', (string)($ENV['BOT_USERNAME'] ?? (getenv('BOT_USERNAME') ?: ''))); define('BOT_ID', (string)($ENV['BOT_ID'] ?? (getenv('BOT_ID') ?: ''))); ``` > **🛡️ Isolated Runtime Guarantee:** The Botlify platform isolates the child bot execution context (`FBH_CHILD_BOT_CONTEXT`). The `BOT_TOKEN` belongs strictly to this hosted bot. Botlify's main platform bot will never intercept or respond to child bot interactions. --- ### 4.3. Incoming Updates & Telegram Bot API Handler #### Handling the Webhook: ```php false]; static $ch = null; if ($ch === null || !($ch instanceof \CurlHandle || is_resource($ch))) { $ch = curl_init(); } $opts = [ CURLOPT_URL => 'https://api.telegram.org/bot' . BOT_TOKEN . '/' . $method, CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode($params, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES), CURLOPT_HTTPHEADER => ['Content-Type: application/json; charset=utf-8'], CURLOPT_CONNECTTIMEOUT => 8, CURLOPT_TIMEOUT => 15, CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4, CURLOPT_TCP_NODELAY => true, CURLOPT_DNS_CACHE_TIMEOUT => 3600, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_SSL_VERIFYHOST => false, ]; if (defined('CURL_HTTP_VERSION_2TLS')) { $opts[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_2TLS; } curl_setopt_array($ch, $opts); $res = curl_exec($ch); return json_decode((string)$res, true) ?: ['ok' => false]; } // Convenient shortcut for sendMessage function sendMessage($chatId, string $text, array $extra = []): array { return bot('sendMessage', array_merge([ 'chat_id' => $chatId, 'text' => $text, 'parse_mode' => 'HTML' ], $extra)); } ``` --- ### 4.4. 🎨 Keyboard Menus & Button Color Styling Botlify Cloud supports button color styling for both **Inline Keyboards** and **Reply Keyboards**. #### 🎨 Style to Color Mapping: | Style Attribute | Rendered Button Color | Best Use Cases | |---|---|---| | `'style' => 'primary'` | 🔵 **Blue** | Main call-to-action, Confirm, Open, Start, Next | | `'style' => 'success'` | 🟢 **Green** | Buy, Deposit, Approve, Completed, Accept, Add | | `'style' => 'danger'` | 🔴 **Red** | Delete, Cancel, Reject, Withdraw, Ban, Clear | | (omitted / default) | ⚪ **Standard/Gray** | Back, Settings, Info, Navigation | --- #### Inline Keyboard with Button Colors Inline keyboards appear directly attached to the message. You can specify `'style'` for any button: ```php $inlineKeyboard = [ 'inline_keyboard' => [ [ [ 'text' => '🚀 Launch App', 'callback_data' => 'action_launch', 'style' => 'primary' // 🔵 Blue ], [ 'text' => '💳 Deposit USDT', 'callback_data' => 'action_deposit', 'style' => 'success' // 🟢 Green ] ], [ [ 'text' => '🗑️ Delete Project', 'callback_data' => 'action_delete', 'style' => 'danger' // 🔴 Red ] ] ] ]; $reply_markup = json_encode($inlineKeyboard); sendMessage($chatId, "Welcome to Bot Dashboard!\nPlease choose an option:", [ 'reply_markup' => $reply_markup ]); ``` --- #### Reply Keyboard with Button Colors Reply keyboards stay fixed at the bottom of the user's chat screen: ```php $replyKeyboard = [ 'keyboard' => [ [ [ 'text' => '🟢 Activate VIP Plan', 'style' => 'success' // 🟢 Green ], [ 'text' => '🔵 My Wallet & Stats', 'style' => 'primary' // 🔵 Blue ] ], [ [ 'text' => '🔴 Cancel Order', 'style' => 'danger' // 🔴 Red ], [ 'text' => '⚙️ Settings' // ⚪ Standard ] ] ], 'resize_keyboard' => true, 'one_time_keyboard' => false ]; $reply_markup = json_encode($replyKeyboard); sendMessage($chatId, "Main menu loaded with colored buttons:", [ 'reply_markup' => $reply_markup ]); ``` --- #### Combined Interactive Menu Grid Here is a full pattern for an interactive confirmation prompt: ```php $confirmMenu = [ 'inline_keyboard' => [ [ [ 'text' => '✅ Confirm & Proceed', 'callback_data' => 'confirm_yes', 'style' => 'success' // 🟢 Green ], [ 'text' => '❌ Cancel & Abort', 'callback_data' => 'confirm_no', 'style' => 'danger' // 🔴 Red ] ], [ [ 'text' => 'ℹ️ View Documentation', 'url' => 'https://t.me/your_channel', 'style' => 'primary' // 🔵 Blue ] ] ] ]; ``` --- ### 4.5. Callback Queries & Interactive Navigation When users click an inline button, Telegram sends a `callback_query`. Always respond using `answerCallbackQuery` so the button stops loading: ```php if ($callback) { $callbackId = $callback['id']; $data = $callback['data'] ?? ''; $chatId = $callback['message']['chat']['id'] ?? 0; $messageId = $callback['message']['message_id'] ?? 0; // 1. Acknowledge the click immediately bot('answerCallbackQuery', [ 'callback_query_id' => $callbackId, 'text' => 'Loading…', 'show_alert' => false ]); // 2. Handle actions if ($data === 'action_deposit') { bot('editMessageText', [ 'chat_id' => $chatId, 'message_id' => $messageId, 'text' => "Deposit Funds\nSend USDT (TRC20) to your balance.", 'parse_mode' => 'HTML', 'reply_markup' => json_encode([ 'inline_keyboard' => [ [['text' => '⬅️ Back to Menu', 'callback_data' => 'main_menu', 'style' => 'primary']] ] ]) ]); } } ``` --- ### 4.6. SQLite Database Integration & Self-Healing Schemas (`database.db`) Each bot has access to its own ultra-fast, local SQLite database file in `database.db` directly in the bot root folder. #### Production SQLite Connection with WAL Mode & Busy Timeout: ```php function db(): PDO { static $pdo = null; if ($pdo === null) { $dbPath = __DIR__ . '/database.db'; $pdo = new PDO('sqlite:' . $dbPath, null, null, [ PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION, PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC, PDO::ATTR_TIMEOUT => 5, ]); $pdo->exec('PRAGMA journal_mode = WAL;'); $pdo->exec('PRAGMA synchronous = NORMAL;'); $pdo->exec('PRAGMA busy_timeout = 5000;'); } return $pdo; } // 🛡️ Self-Healing Column Migrator (CRITICAL): // In SQLite, CREATE TABLE IF NOT EXISTS does NOT add new columns when switching or updating bot code! // This helper auto-adds missing columns on the fly so users never get "no such column" crashes or need to delete database.db! function ensureColumn(PDO $pdo, string $table, string $column, string $type = 'TEXT'): void { try { $cols = $pdo->query("PRAGMA table_info({$table})")->fetchAll(PDO::FETCH_COLUMN, 1); if (!in_array($column, $cols, true)) { $pdo->exec("ALTER TABLE {$table} ADD COLUMN {$column} {$type}"); } } catch (Throwable $e) {} } // Initialize tables db()->exec("CREATE TABLE IF NOT EXISTS users ( chat_id TEXT PRIMARY KEY, username TEXT DEFAULT '', first_name TEXT DEFAULT '', balance REAL DEFAULT 0.00, created_at INTEGER DEFAULT 0, last_active INTEGER DEFAULT 0, is_banned INTEGER DEFAULT 0 )"); // Ensure columns exist even if table was created by a previous bot ensureColumn(db(), 'users', 'balance', 'REAL DEFAULT 0.00'); ensureColumn(db(), 'users', 'is_banned', 'INTEGER DEFAULT 0'); ensureColumn(db(), 'users', 'created_at', 'INTEGER DEFAULT 0'); ensureColumn(db(), 'users', 'last_active', 'INTEGER DEFAULT 0'); ``` #### User Registration & Balance Tracking: ```php function registerUser(PDO $db, array $from): array { $chatId = (string) $from['id']; $username = $from['username'] ?? ''; $firstName = $from['first_name'] ?? 'User'; $stmt = $db->prepare("INSERT INTO users (chat_id, username, first_name, last_active) VALUES (?, ?, ?, datetime('now')) ON CONFLICT(chat_id) DO UPDATE SET username = excluded.username, first_name = excluded.first_name, last_active = datetime('now')"); $stmt->execute([$chatId, $username, $firstName]); $getUser = $db->prepare("SELECT * FROM users WHERE chat_id = ?"); $getUser->execute([$chatId]); return $getUser->fetch() ?: []; } ``` --- ### 4.7. Automated Background Cron Jobs (`cron.php`) To perform automated background tasks (daily reports, subscription renewals, database cleanups): 1. Create a `cron.php` file in your bot root folder: ```php query("SELECT chat_id FROM users WHERE last_active < datetime('now', '-3 days') LIMIT 50"); $users = $stmt->fetchAll(PDO::FETCH_COLUMN); foreach ($users as $chatId) { sendMessage($chatId, "👋 We missed you! Check out our new features today.", [ 'reply_markup' => json_encode([ 'inline_keyboard' => [ [['text' => '🚀 Open Dashboard', 'callback_data' => 'main_menu', 'style' => 'primary']] ] ]) ]); usleep(50000); // 50ms throttle } echo "Cron finished successfully at " . date('Y-m-d H:i:s'); ``` 2. Schedule the cron job in your Mini App under **Variables & Cron** -> **+ New Cron Task**, or through the Developer API / MCP! --- ### 4.8. Broadcast & User Tracking Send mass notifications (Text, Image, Video, or GIF) safely with rate-limiting or via Botlify's high-speed parallel MCP Broadcast Engine: #### 1. In-Bot PHP Broadcast Helper: ```php function broadcastMessage(PDO $db, string $text, ?string $replyMarkup = null, string $type = 'text', string $media = ''): array { $stmt = $db->query("SELECT chat_id FROM users"); $total = 0; $sent = 0; $failed = 0; while ($chatId = $stmt->fetchColumn()) { $total++; $extra = []; if ($replyMarkup) $extra['reply_markup'] = $replyMarkup; if ($type === 'photo' || $type === 'image') { $res = bot('sendPhoto', array_merge(['chat_id' => $chatId, 'photo' => $media, 'caption' => $text], $extra)); } elseif ($type === 'video') { $res = bot('sendVideo', array_merge(['chat_id' => $chatId, 'video' => $media, 'caption' => $text], $extra)); } elseif ($type === 'animation' || $type === 'gif') { $res = bot('sendAnimation', array_merge(['chat_id' => $chatId, 'animation' => $media, 'caption' => $text], $extra)); } else { $res = bot('sendMessage', array_merge(['chat_id' => $chatId, 'text' => $text], $extra)); } if (!empty($res['ok'])) { $sent++; } else { $failed++; } usleep(35000); // Sleep 35ms (Telegram limit: ~30 msg/sec) } return ['total' => $total, 'sent' => $sent, 'failed' => $failed]; } ``` #### 2. High-Speed MCP Broadcast API (`send_broadcast`): You can trigger instant parallel broadcasts from the Botlify MCP server with full media support: - **Text Broadcast**: `send_broadcast(bot_id, type="text", message="Hello world!")` - **Image Broadcast**: `send_broadcast(bot_id, type="image", media_url="https://.../pic.jpg", message="Check this out!")` - **Video Broadcast**: `send_broadcast(bot_id, type="video", media_url="https://.../video.mp4", message="New Tutorial")` - **GIF Broadcast**: `send_broadcast(bot_id, type="gif", media_url="https://.../anim.gif", message="🎉 Celebration")` - **With Buttons**: Pass `inline_keyboard: [[{"text": "Visit Website", "url": "https://example.com"}]]` --- ### 4.9. Error Handling & Webhook Storm Prevention Always wrap your main logic in a `try...catch` block. When an error occurs, acknowledge Telegram with HTTP 200 OK immediately to stop Telegram from endlessly retrying: ```php try { // Your bot code here } catch (Throwable $e) { // 1. Immediately acknowledge webhook with HTTP 200 to prevent Telegram retry storms if (!headers_sent()) { http_response_code(200); header('Content-Type: application/json; charset=utf-8'); echo json_encode(['ok' => true, 'handled_error' => true]); if (function_exists('fastcgi_finish_request')) { fastcgi_finish_request(); } } // 2. Log clean error to error.log $errorMsg = "[" . date('d-M-Y H:i:s e') . "] Uncaught " . get_class($e) . ": " . $e->getMessage() . " in " . basename($e->getFile()) . ":" . $e->getLine() . "\n"; @file_put_contents(__DIR__ . '/error.log', $errorMsg, FILE_APPEND); // 3. Notify bot admin if configured if (defined('ADMIN_CHAT_ID') && ADMIN_CHAT_ID !== '') { bot('sendMessage', [ 'chat_id' => ADMIN_CHAT_ID, 'text' => "⚠️ Bot Exception:\n" . htmlspecialchars($e->getMessage()) . "", 'parse_mode' => 'HTML' ]); } } ``` --- ### 4.10. 🚀 Full Production Ready Boilerplates #### Boilerplate 1: Modern Styled Keyboard Bot Save as `index.php`: ```php false]; static $ch = null; if ($ch === null || !($ch instanceof \CurlHandle || is_resource($ch))) { $ch = curl_init(); } $opts = [ CURLOPT_URL => 'https://api.telegram.org/bot' . BOT_TOKEN . '/' . $method, CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode($params, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES), CURLOPT_HTTPHEADER => ['Content-Type: application/json; charset=utf-8'], CURLOPT_CONNECTTIMEOUT => 8, CURLOPT_TIMEOUT => 15, CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4, CURLOPT_TCP_NODELAY => true, CURLOPT_DNS_CACHE_TIMEOUT => 3600, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_SSL_VERIFYHOST => false, ]; if (defined('CURL_HTTP_VERSION_2TLS')) { $opts[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_2TLS; } curl_setopt_array($ch, $opts); $res = curl_exec($ch); return json_decode((string)$res, true) ?: ['ok' => false]; } // 3. Handle Updates $update = json_decode((string)file_get_contents('php://input'), true); if (!$update) exit('Bot is active'); $msg = $update['message'] ?? null; $cb = $update['callback_query'] ?? null; if ($msg && isset($msg['text'])) { $chatId = $msg['chat']['id']; $text = trim($msg['text']); if ($text === '/start') { // Styled Inline Menu $inlineMenu = [ 'inline_keyboard' => [ [ ['text' => '🚀 Launch Portal', 'callback_data' => 'launch', 'style' => 'primary'], ['text' => '💎 Upgrade VIP', 'callback_data' => 'upgrade', 'style' => 'success'] ], [ ['text' => '🛑 Stop Service', 'callback_data' => 'stop', 'style' => 'danger'] ] ] ]; // Styled Reply Keyboard $replyMenu = [ 'keyboard' => [ [ ['text' => '🟢 Deposit Funds', 'style' => 'success'], ['text' => '🔵 My Profile', 'style' => 'primary'] ], [ ['text' => '🔴 Close Menu', 'style' => 'danger'] ] ], 'resize_keyboard' => true ]; bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "👋 Welcome!\nEnjoy our modern styled keyboards:", 'parse_mode' => 'HTML', 'reply_markup' => json_encode($inlineMenu) ]); } } if ($cb) { $cbId = $cb['id']; $data = $cb['data'] ?? ''; $chatId = $cb['message']['chat']['id']; $msgId = $cb['message']['message_id']; bot('answerCallbackQuery', ['callback_query_id' => $cbId, 'text' => "Selected: {$data}"]); if ($data === 'launch') { bot('editMessageText', [ 'chat_id' => $chatId, 'message_id' => $msgId, 'text' => "🚀 Portal Active\nChoose an action below:", 'parse_mode' => 'HTML', 'reply_markup' => json_encode([ 'inline_keyboard' => [ [['text' => '⬅️ Back', 'callback_data' => 'back', 'style' => 'primary']] ] ]) ]); } } ``` --- #### Boilerplate 2: Full SQLite Database Bot Save as `index.php`: ```php setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); $db->exec("CREATE TABLE IF NOT EXISTS users ( chat_id TEXT PRIMARY KEY, username TEXT, balance REAL DEFAULT 0, created_at DATETIME DEFAULT CURRENT_TIMESTAMP )"); // 3. Telegram API Helper function bot(string $method, array $params = []): array { if (!defined('BOT_TOKEN') || BOT_TOKEN === '') return ['ok' => false]; static $ch = null; if ($ch === null || !($ch instanceof \CurlHandle || is_resource($ch))) { $ch = curl_init(); } $opts = [ CURLOPT_URL => 'https://api.telegram.org/bot' . BOT_TOKEN . '/' . $method, CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode($params, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES), CURLOPT_HTTPHEADER => ['Content-Type: application/json; charset=utf-8'], CURLOPT_CONNECTTIMEOUT => 8, CURLOPT_TIMEOUT => 15, CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4, CURLOPT_TCP_NODELAY => true, CURLOPT_DNS_CACHE_TIMEOUT => 3600, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_SSL_VERIFYHOST => false, ]; if (defined('CURL_HTTP_VERSION_2TLS')) { $opts[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_2TLS; } curl_setopt_array($ch, $opts); $res = curl_exec($ch); return json_decode((string)$res, true) ?: ['ok' => false]; } // 4. Update Processing $update = json_decode((string)file_get_contents('php://input'), true); if (!$update) exit('Online'); $msg = $update['message'] ?? null; if ($msg && isset($msg['text'])) { $chatId = (string) $msg['chat']['id']; $text = trim($msg['text']); $user = $msg['from'] ?? []; // Register user $st = $db->prepare("INSERT OR IGNORE INTO users (chat_id, username) VALUES (?, ?)"); $st->execute([$chatId, $user['username'] ?? '']); if ($text === '/start') { $st = $db->prepare("SELECT balance FROM users WHERE chat_id = ?"); $st->execute([$chatId]); $balance = (float)$st->fetchColumn(); $menu = [ 'inline_keyboard' => [ [ ['text' => '➕ Deposit 5 USDT', 'callback_data' => 'add_funds', 'style' => 'success'], ['text' => '📊 Account Stats', 'callback_data' => 'stats', 'style' => 'primary'] ], [ ['text' => '❌ Reset Account', 'callback_data' => 'reset', 'style' => 'danger'] ] ] ]; bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "👋 Welcome!\n💰 Your Balance: {$balance} USDT", 'parse_mode' => 'HTML', 'reply_markup' => json_encode($menu) ]); } } $cb = $update['callback_query'] ?? null; if ($cb) { $chatId = (string)$cb['message']['chat']['id']; $msgId = $cb['message']['message_id']; $data = $cb['data'] ?? ''; if ($data === 'add_funds') { $db->prepare("UPDATE users SET balance = balance + 5 WHERE chat_id = ?")->execute([$chatId]); bot('answerCallbackQuery', ['callback_query_id' => $cb['id'], 'text' => '+5 USDT Added!']); $st = $db->prepare("SELECT balance FROM users WHERE chat_id = ?"); $st->execute([$chatId]); $newBal = (float)$st->fetchColumn(); bot('editMessageText', [ 'chat_id' => $chatId, 'message_id' => $msgId, 'text' => "✅ Deposit Successful!\nNew Balance: {$newBal} USDT", 'parse_mode' => 'HTML', 'reply_markup' => json_encode([ 'inline_keyboard' => [ [['text' => '⬅️ Back to Menu', 'callback_data' => 'back', 'style' => 'primary']] ] ]) ]); } } ``` --- ### 4.11. ✨ Custom Animated & Static Emojis (`` & MarkdownV2) Telegram Bot API supports custom emojis across messages, captions, and notifications. Custom emojis render as animated or styled stickers directly inline with text. #### 📌 Formatting Specifications: ##### 1. HTML Formatting (`parse_mode: 'HTML'`): Wrap the fallback standard emoji inside the `` tag with the `emoji-id` attribute: ```html Welcome to our bot! 🔥 Congratulations, you unlocked VIP ⭐ ``` > [!IMPORTANT] > **Fallback Emoji Requirement**: The tag must wrap a standard Unicode emoji (like `🔥` or `⭐`). Clients that cannot render custom emojis (or web clients without Premium) will gracefully fall back to this character. ##### 2. MarkdownV2 Formatting (`parse_mode: 'MarkdownV2'`): ```markdown Welcome to our bot\! \![🔥](tg://emoji?id=5368324170671202286) Congratulations, you unlocked VIP \![⭐](tg://emoji?id=5449987823521096781) ``` #### 🔍 How to Find Custom Emoji IDs: 1. **Telegram Web Inspector**: Open Telegram Web (A or K version), right-click on an emoji from a sticker pack, and inspect element to find `data-custom-emoji-id` or `custom_emoji_id`. 2. **Bot Message Echo**: Send the custom emoji to your bot in Telegram and print `$update['message']['entities']`. Look for an entity where `'type' === 'custom_emoji'` and read `'custom_emoji_id'`. #### 💡 PHP Helper Function for Custom Emojis: ```php function tg_emoji(string $emojiId, string $fallback = '⭐'): string { return "{$fallback}"; } // Usage in messages: $star = tg_emoji('5449987823521096781', '⭐'); $fire = tg_emoji('5368324170671202286', '🔥'); bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "{$star} Premium Store Active {$fire}\n\nUpgrade your account today!", 'parse_mode' => 'HTML' ]); ``` --- ### 4.12. ⭐ Telegram Stars Payments System (`currency: XTR`) **Telegram Stars (`XTR`)** is the official digital currency for purchasing digital goods, subscriptions, and services inside Telegram bots and Mini Apps. #### ⚠️ Critical Telegram Stars Rules: 1. **Currency**: Must be strictly set to `"XTR"`. 2. **`provider_token`**: **MUST BE COMPLETELY OMITTED!** Do not set it to an empty string, null, or false. Delete the key entirely from the `sendInvoice` payload. 3. **Prices Amount**: Integer amount of Stars (e.g., `50` means 50 Stars; no cents or decimal multiplication). 4. **Pre-Checkout Timeout**: You **must** answer `pre_checkout_query` within **10 seconds** via `answerPreCheckoutQuery`, or Telegram will cancel the order. #### 🔄 The 3-Step Stars Payment Lifecycle: ``` [User clicks Buy Button] │ ▼ 1. Bot calls sendInvoice (currency: "XTR", NO provider_token) │ ▼ [Telegram displays native Star payment modal & user confirms] │ ▼ 2. Telegram sends update: pre_checkout_query Bot immediately answers with: answerPreCheckoutQuery (ok: true) │ ▼ 3. Telegram processes payment and sends update: successful_payment Bot delivers digital item / activates VIP in database & notifies user ``` #### 1. Sending a Stars Invoice (`sendInvoice`): ```php function send_stars_invoice(string $chatId, string $title, string $description, int $starsAmount, string $payload): array { return bot('sendInvoice', [ 'chat_id' => $chatId, 'title' => $title, 'description' => $description, 'payload' => $payload, 'currency' => 'XTR', // Official Stars Currency // CRITICAL: provider_token is omitted entirely! 'prices' => [ ['label' => $title, 'amount' => $starsAmount] ] ]); } ``` #### 2. Handling `pre_checkout_query`: ```php $preCheckout = $update['pre_checkout_query'] ?? null; if ($preCheckout) { $queryId = $preCheckout['id']; $stars = (int) $preCheckout['total_amount']; $payload = $preCheckout['invoice_payload']; // Verify inventory or conditions here $inStock = true; if ($inStock) { bot('answerPreCheckoutQuery', [ 'pre_checkout_query_id' => $queryId, 'ok' => true ]); } else { bot('answerPreCheckoutQuery', [ 'pre_checkout_query_id' => $queryId, 'ok' => false, 'error_message' => 'Sorry, this digital product is currently out of stock.' ]); } exit; } ``` #### 3. Handling `successful_payment`: ```php $msg = $update['message'] ?? null; if ($msg && isset($msg['successful_payment'])) { $pay = $msg['successful_payment']; $chatId = (string) $msg['chat']['id']; $starsPaid = (int) $pay['total_amount']; $payload = (string) $pay['invoice_payload']; $chargeId = (string) $pay['telegram_payment_charge_id']; // Deliver product & update database $st = $db->prepare("INSERT INTO transactions (chat_id, stars_amount, charge_id, payload) VALUES (?, ?, ?, ?)"); $st->execute([$chatId, $starsPaid, $chargeId, $payload]); bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "🎉 Payment Successful!\n\n⭐ Stars Paid: {$starsPaid} XTR\n🧾 Charge ID: {$chargeId}\n\nYour digital service has been activated immediately!", 'parse_mode' => 'HTML' ]); } ``` --- ### 4.13. 🧠 AI Chat & Auto-Reply Integration (Gemini, OpenAI, Claude, OpenRouter) Integrate state-of-the-art AI models to turn your bot into a 24/7 intelligent assistant, customer support agent, or creative writer. #### ⚡ Key Architectural Considerations for PHP Webhooks: 1. **Synchronous Execution**: Use direct HTTP requests (cURL with 15-25s timeout) inside webhook execution. 2. **User Feedback (`sendChatAction: typing`)**: Always send typing action immediately before calling the AI API so the user sees Telegram's native "typing..." bubble. 3. **HTML Sanitization**: Always wrap user and AI text with `htmlspecialchars()` if outputting in `parse_mode: 'HTML'` to prevent malformed tag crashes. 4. **Context Memory**: Store recent conversation history in the bot's SQLite database (`storage/database.db`) so the AI remembers context across turns. #### 🌐 Universal AI Caller Function (OpenAI / OpenRouter / Gemini Compatible): ```php function ai_generate_reply(string $userPrompt, array $history = [], string $systemPrompt = ''): string { // Option A: OpenRouter / OpenAI API $apiKey = getenv('OPENAI_API_KEY') ?: getenv('AI_API_KEY'); $endpoint = 'https://openrouter.ai/api/v1/chat/completions'; // Or https://api.openai.com/v1/chat/completions $model = 'google/gemini-2.0-flash-exp:free'; // Or gpt-4o-mini if (!$apiKey) { return "⚠️ AI API key is not configured. Please add AI_API_KEY in your .env file."; } $messages = []; if ($systemPrompt !== '') { $messages[] = ['role' => 'system', 'content' => $systemPrompt]; } foreach ($history as $h) { $messages[] = ['role' => $h['role'], 'content' => $h['content']]; } $messages[] = ['role' => 'user', 'content' => $userPrompt]; $ch = curl_init($endpoint); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode([ 'model' => $model, 'messages' => $messages, 'temperature' => 0.7, 'max_tokens' => 1000 ]), CURLOPT_HTTPHEADER => [ 'Content-Type: application/json', 'Authorization: Bearer ' . $apiKey ], CURLOPT_TIMEOUT => 25 ]); $raw = curl_exec($ch); curl_close($ch); $json = json_decode((string)$raw, true); return $json['choices'][0]['message']['content'] ?? '⚠️ Sorry, I could not generate a response at this moment.'; } ``` #### 🗄️ Multi-Turn Chat History Table in SQLite: ```sql CREATE TABLE IF NOT EXISTS chat_history ( id INTEGER PRIMARY KEY AUTOINCREMENT, chat_id TEXT NOT NULL, role TEXT NOT NULL, -- 'user' or 'assistant' content TEXT NOT NULL, created_at DATETIME DEFAULT CURRENT_TIMESTAMP ); CREATE INDEX IF NOT EXISTS idx_chat_history_id ON chat_history(chat_id); ``` --- ### 4.14. 📱 Telegram Mini Apps (WebApp Buttons) & Media Handlers #### 1. Launching a Telegram Mini App from Inline Buttons: ```php $webAppKeyboard = [ 'inline_keyboard' => [ [ [ 'text' => '🚀 Open Web App', 'web_app' => ['url' => 'https://yourdomain.com/miniapp.php'], 'style' => 'primary' // 🔵 Blue ] ], [ [ 'text' => '🛍️ Star Shop', 'callback_data' => 'open_stars_shop', 'style' => 'success' // 🟢 Green ] ] ] ]; bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "✨ Welcome to the Next-Gen Bot Studio!\nLaunch the full Mini App below:", 'parse_mode' => 'HTML', 'reply_markup' => json_encode($webAppKeyboard) ]); ``` #### 2. Sending Photos, Audios, and Media with Styled Buttons: ```php bot('sendPhoto', [ 'chat_id' => $chatId, 'photo' => 'https://images.unsplash.com/photo-1618005182384-a83a8bd57fbe', 'caption' => "🌌 Digital Art NFT #104\nPrice: 25 Stars (XTR)", 'parse_mode' => 'HTML', 'reply_markup' => json_encode([ 'inline_keyboard' => [ [['text' => '⭐ Buy with Stars (25 XTR)', 'callback_data' => 'buy_art_104', 'style' => 'success']] ] ]) ]); ``` --- ### 4.15. 🚀 Complete Boilerplate 3: Telegram Stars Digital Store Bot Save this as your bot's `index.php` for a complete Telegram Stars e-commerce solution: ```php PDO::ERRMODE_EXCEPTION, PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC ]); $db->exec("CREATE TABLE IF NOT EXISTS orders ( id INTEGER PRIMARY KEY AUTOINCREMENT, chat_id TEXT, product_name TEXT, stars_amount INTEGER, charge_id TEXT, status TEXT DEFAULT 'completed', created_at DATETIME DEFAULT CURRENT_TIMESTAMP )"); // 3. Telegram API Helper function bot(string $method, array $params = []): array { if (!defined('BOT_TOKEN') || BOT_TOKEN === '') return ['ok' => false]; static $ch = null; if ($ch === null || !($ch instanceof \CurlHandle || is_resource($ch))) { $ch = curl_init(); } $opts = [ CURLOPT_URL => 'https://api.telegram.org/bot' . BOT_TOKEN . '/' . $method, CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode($params, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES), CURLOPT_HTTPHEADER => ['Content-Type: application/json; charset=utf-8'], CURLOPT_CONNECTTIMEOUT => 8, CURLOPT_TIMEOUT => 15, CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4, CURLOPT_TCP_NODELAY => true, CURLOPT_DNS_CACHE_TIMEOUT => 3600, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_SSL_VERIFYHOST => false, ]; if (defined('CURL_HTTP_VERSION_2TLS')) { $opts[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_2TLS; } curl_setopt_array($ch, $opts); $res = curl_exec($ch); return json_decode((string)$res, true) ?: ['ok' => false]; } // 4. Update Processing $raw = file_get_contents('php://input'); $update = json_decode((string)$raw, true); if (!$update) exit('Stars Bot Online'); // ── Handle Pre-Checkout Query (Within 10s) ── if (isset($update['pre_checkout_query'])) { $q = $update['pre_checkout_query']; bot('answerPreCheckoutQuery', [ 'pre_checkout_query_id' => $q['id'], 'ok' => true ]); exit; } // ── Handle Message & Successful Payment ── $msg = $update['message'] ?? null; if ($msg) { $chatId = (string) $msg['chat']['id']; // Successful Stars Payment Event if (isset($msg['successful_payment'])) { $pay = $msg['successful_payment']; $stars = (int) $pay['total_amount']; $chargeId = (string) $pay['telegram_payment_charge_id']; $payload = (string) $pay['invoice_payload']; $db->prepare("INSERT INTO orders (chat_id, product_name, stars_amount, charge_id) VALUES (?, ?, ?, ?)") ->execute([$chatId, $payload, $stars, $chargeId]); bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "🎉 Payment Confirmed!\n\n⭐ Amount: {$stars} Stars (XTR)\n📦 Product: " . htmlspecialchars($payload) . "\n🧾 Charge ID: {$chargeId}\n\n🔑 Your License Key: VIP-" . strtoupper(bin2hex(random_bytes(6))) . "", 'parse_mode' => 'HTML', 'reply_markup' => json_encode([ 'inline_keyboard' => [ [['text' => '🛍️ Browse More Items', 'callback_data' => 'catalog', 'style' => 'primary']] ] ]) ]); exit; } $text = trim($msg['text'] ?? ''); if ($text === '/start' || $text === '/shop') { $catalog = [ 'inline_keyboard' => [ [ ['text' => '⭐ VIP Access (50 Stars)', 'callback_data' => 'buy_vip_50', 'style' => 'success'] ], [ ['text' => '🚀 Bot Source Code (100 Stars)', 'callback_data' => 'buy_src_100', 'style' => 'primary'] ] ] ]; bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "🌟 Welcome to the Telegram Stars Digital Store!\n\nPurchase digital subscriptions and goods using official Telegram Stars:\n\n• VIP Membership: 50 Stars\n• Full Source Code: 100 Stars", 'parse_mode' => 'HTML', 'reply_markup' => json_encode($catalog) ]); } } // ── Handle Catalog Invoices via Callback Queries ── $cb = $update['callback_query'] ?? null; if ($cb) { $cbId = $cb['id']; $chatId = (string) $cb['message']['chat']['id']; $data = $cb['data'] ?? ''; bot('answerCallbackQuery', ['callback_query_id' => $cbId]); if ($data === 'buy_vip_50') { bot('sendInvoice', [ 'chat_id' => $chatId, 'title' => 'VIP Membership (1 Month)', 'description' => 'Unlocks all premium features and dedicated 24/7 priority support.', 'payload' => 'vip_1_month', 'currency' => 'XTR', // Stars 'prices' => [ ['label' => 'VIP 1 Month', 'amount' => 50] ] ]); } elseif ($data === 'buy_src_100') { bot('sendInvoice', [ 'chat_id' => $chatId, 'title' => 'Full Bot Source Code Bundle', 'description' => 'Complete production PHP source code with SQLite and webhook architecture.', 'payload' => 'bot_source_code', 'currency' => 'XTR', // Stars 'prices' => [ ['label' => 'Source Code Bundle', 'amount' => 100] ] ]); } } ``` --- ### 4.16. 🚀 Complete Boilerplate 4: AI Intelligent Chatbot with SQLite Memory Save this as your bot's `index.php` for a complete conversational AI assistant with memory: ```php PDO::ERRMODE_EXCEPTION, PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC ]); $db->exec("CREATE TABLE IF NOT EXISTS conversation_memory ( id INTEGER PRIMARY KEY AUTOINCREMENT, chat_id TEXT NOT NULL, role TEXT NOT NULL, content TEXT NOT NULL, created_at DATETIME DEFAULT CURRENT_TIMESTAMP )"); // 3. Telegram API Helper function bot(string $method, array $params = []): array { if (!defined('BOT_TOKEN') || BOT_TOKEN === '') return ['ok' => false]; static $ch = null; if ($ch === null || !($ch instanceof \CurlHandle || is_resource($ch))) { $ch = curl_init(); } $opts = [ CURLOPT_URL => 'https://api.telegram.org/bot' . BOT_TOKEN . '/' . $method, CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode($params, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES), CURLOPT_HTTPHEADER => ['Content-Type: application/json; charset=utf-8'], CURLOPT_CONNECTTIMEOUT => 8, CURLOPT_TIMEOUT => 15, CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4, CURLOPT_TCP_NODELAY => true, CURLOPT_DNS_CACHE_TIMEOUT => 3600, CURLOPT_SSL_VERIFYPEER => false, CURLOPT_SSL_VERIFYHOST => false, ]; if (defined('CURL_HTTP_VERSION_2TLS')) { $opts[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_2TLS; } curl_setopt_array($ch, $opts); $res = curl_exec($ch); return json_decode((string)$res, true) ?: ['ok' => false]; } // 4. AI Completion Helper function call_ai(string $prompt, array $history): string { if (AI_API_KEY === '') { return "⚠️ AI API Key is missing! Please configure AI_API_KEY in your bot's .env file."; } $messages = [ ['role' => 'system', 'content' => 'You are an intelligent, helpful, concise, and friendly Telegram assistant. Format your replies neatly using bold, bullet points, and code snippets when appropriate.'] ]; foreach ($history as $msg) { $messages[] = ['role' => $msg['role'], 'content' => $msg['content']]; } $messages[] = ['role' => 'user', 'content' => $prompt]; $ch = curl_init('https://openrouter.ai/api/v1/chat/completions'); // Or https://api.openai.com/v1/chat/completions curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode([ 'model' => 'google/gemini-2.0-flash-exp:free', // Fast & powerful 'messages' => $messages, 'temperature' => 0.7, 'max_tokens' => 800 ]), CURLOPT_HTTPHEADER => [ 'Content-Type: application/json', 'Authorization: Bearer ' . AI_API_KEY ], CURLOPT_TIMEOUT => 25 ]); $res = curl_exec($ch); curl_close($ch); $json = json_decode((string)$res, true); return $json['choices'][0]['message']['content'] ?? '⚠️ Sorry, I could not generate an answer right now.'; } // 5. Update Processing $raw = file_get_contents('php://input'); $update = json_decode((string)$raw, true); if (!$update) exit('AI Bot Online'); $msg = $update['message'] ?? null; if ($msg && isset($msg['text'])) { $chatId = (string) $msg['chat']['id']; $text = trim($msg['text']); if ($text === '/start') { $menu = [ 'inline_keyboard' => [ [ ['text' => '🧹 Clear Chat Memory', 'callback_data' => 'clear_memory', 'style' => 'danger'], ['text' => 'ℹ️ About Assistant', 'callback_data' => 'about_ai', 'style' => 'primary'] ] ] ]; bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "🤖 Hello! I am your AI Assistant.\n\nAsk me any question, brainstorm ideas, request code, or chat about anything! I remember our conversation context automatically.", 'parse_mode' => 'HTML', 'reply_markup' => json_encode($menu) ]); exit; } if ($text === '/clear') { $db->prepare("DELETE FROM conversation_memory WHERE chat_id = ?")->execute([$chatId]); bot('sendMessage', ['chat_id' => $chatId, 'text' => '🧹 Conversation memory cleared!', 'parse_mode' => 'HTML']); exit; } // 1. Show Typing Status to User bot('sendChatAction', ['chat_id' => $chatId, 'action' => 'typing']); // 2. Retrieve Last 6 Conversation Turns for Memory $st = $db->prepare("SELECT role, content FROM conversation_memory WHERE chat_id = ? ORDER BY id DESC LIMIT 6"); $st->execute([$chatId]); $history = array_reverse($st->fetchAll()); // 3. Call AI $aiResponse = call_ai($text, $history); // 4. Save User Prompt and AI Reply to Memory $ins = $db->prepare("INSERT INTO conversation_memory (chat_id, role, content) VALUES (?, ?, ?)"); $ins->execute([$chatId, 'user', $text]); $ins->execute([$chatId, 'assistant', $aiResponse]); // 5. Deliver Reply bot('sendMessage', [ 'chat_id' => $chatId, 'text' => $aiResponse, 'reply_markup' => json_encode([ 'inline_keyboard' => [ [['text' => '🧹 Reset Context', 'callback_data' => 'clear_memory', 'style' => 'danger']] ] ]) ]); } $cb = $update['callback_query'] ?? null; if ($cb) { $cbId = $cb['id']; $chatId = (string) $cb['message']['chat']['id']; $data = $cb['data'] ?? ''; if ($data === 'clear_memory') { $db->prepare("DELETE FROM conversation_memory WHERE chat_id = ?")->execute([$chatId]); bot('answerCallbackQuery', ['callback_query_id' => $cbId, 'text' => 'Context Memory Cleared!']); bot('sendMessage', ['chat_id' => $chatId, 'text' => '🧹 Conversation context reset. What would you like to discuss next?', 'parse_mode' => 'HTML']); } elseif ($data === 'about_ai') { bot('answerCallbackQuery', ['callback_query_id' => $cbId]); bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "🧠 AI Assistant Specifications:\n\n• Multi-turn SQLite memory cache\n• Styled inline action buttons\n• Supports OpenAI, OpenRouter, and Google Gemini models", 'parse_mode' => 'HTML' ]); } } ``` --- ### 4.17. 💥 Message Reactions & Emoji Reacts (`setMessageReaction`) Bots can react to messages with standard Unicode emojis or Custom Emojis, featuring optional full-screen "big" animations! #### 📌 API Method: `setMessageReaction` ##### Parameters: - `chat_id`: Target chat ID or `@channelusername` - `message_id`: Message ID to react to - `reaction`: Array of `ReactionType` objects (up to 1 reaction per bot per message) - `is_big`: *(Optional)* Boolean (`true` displays full-screen popping animation!) #### 💡 Helper Function for Sending Reactions: ```php function bot_react(string|int $chatId, int $messageId, string $emoji = '👍', bool $isBig = true): array { return bot('setMessageReaction', [ 'chat_id' => $chatId, 'message_id' => $messageId, 'reaction' => [ [ 'type' => 'emoji', 'emoji' => $emoji ] ], 'is_big' => $isBig ]); } // React with a Custom Emoji: function bot_react_custom(string|int $chatId, int $messageId, string $customEmojiId, bool $isBig = true): array { return bot('setMessageReaction', [ 'chat_id' => $chatId, 'message_id' => $messageId, 'reaction' => [ [ 'type' => 'custom_emoji', 'custom_emoji_id' => $customEmojiId ] ], 'is_big' => $isBig ]); } ``` #### ⚡ Practical Usage in Webhook Handler: ```php $msg = $update['message'] ?? null; if ($msg && isset($msg['text'])) { $chatId = $msg['chat']['id']; $msgId = $msg['message_id']; $text = trim($msg['text']); // Instantly celebrate when user submits a successful command if ($text === '/success' || $text === 'paid') { bot_react($chatId, $msgId, '🎉', true); // Big celebration animation! } elseif ($text === '/like') { bot_react($chatId, $msgId, '🔥', false); } } ``` #### 🔄 Handling Incoming Reaction Updates: Telegram notifies your bot whenever users react to messages via two updates: ```php // Individual user reaction event $userReaction = $update['message_reaction'] ?? null; if ($userReaction) { $chatId = $userReaction['chat']['id']; $msgId = $userReaction['message_id']; $user = $userReaction['user'] ?? []; $newReact = $userReaction['new_reaction'] ?? []; // List of newly placed reactions } // Aggregate reaction counts (useful for channels) $reactionCount = $update['message_reaction_count'] ?? null; if ($reactionCount) { $chatId = $reactionCount['chat']['id']; $counts = $reactionCount['reactions']; // List of ReactionCount objects } ``` --- ### 4.18. 🔒 Paid Media with Telegram Stars (`sendPaidMedia`) Monetize exclusive content (photos, albums, and video courses) by locking them behind Telegram Stars. Users pay Stars directly in chat to unlock and view the media! #### 📌 Method: `sendPaidMedia` ```php function send_paid_photo(string|int $chatId, int $starCount, string $photoUrl, string $caption): array { return bot('sendPaidMedia', [ 'chat_id' => $chatId, 'star_count' => $starCount, // Stars required to unlock (1 - 25,000) 'media' => [ [ 'type' => 'photo', 'media' => $photoUrl ] ], 'caption' => $caption, 'parse_mode' => 'HTML' ]); } // Example: Lock an exclusive digital download send_paid_photo($chatId, 15, 'https://images.unsplash.com/photo-1618005182384-a83a8bd57fbe', "🔒 Exclusive 4K Wallpaper Pack\nUnlock now for only 15 Stars!"); ``` --- ### 4.19. 💼 Telegram Business Integration (`business_connection`, `business_message`) Telegram Business allows regular users and brands to connect your bot to their personal or business accounts to act as a 24/7 AI receptionist, order taker, or CRM auto-responder. #### 🔄 1. Handling Business Connections (`business_connection`): ```php $bizConn = $update['business_connection'] ?? null; if ($bizConn) { $connId = $bizConn['id']; $userChat = $bizConn['user_chat_id']; $rights = $bizConn['rights'] ?? []; $canReply = !empty($rights['can_reply']); // Store connection in SQLite $st = $db->prepare("INSERT OR REPLACE INTO business_connections (connection_id, user_chat_id, can_reply) VALUES (?, ?, ?)"); $st->execute([$connId, $userChat, $canReply ? 1 : 0]); exit; } ``` #### 💬 2. Answering Messages on Behalf of Business (`business_message`): ```php $bizMsg = $update['business_message'] ?? null; if ($bizMsg) { $connId = $bizMsg['business_connection_id']; $chatId = $bizMsg['chat']['id']; $text = trim($bizMsg['text'] ?? ''); // Reply seamlessly on behalf of the business account bot('sendMessage', [ 'business_connection_id' => $connId, 'chat_id' => $chatId, 'text' => "👋 Hello! Thank you for reaching out to our business. How may we assist you today?", 'parse_mode' => 'HTML' ]); exit; } ``` --- ### 4.20. 🎁 Telegram Star Gifts System (`sendGift`) Send official Telegram virtual gifts to users or channels directly from your bot's Stars balance. ```php function send_telegram_gift(int $userId, string $giftId, string $message = '', bool $payUpgrade = false): array { return bot('sendGift', [ 'user_id' => $userId, 'gift_id' => $giftId, 'text' => $message, 'pay_for_upgrade' => $payUpgrade // Bot pays upgrade fee if true ]); } ``` --- ### 4.21. 🏛️ Forum Topics Management (`createForumTopic`, `message_thread_id`) In supergroups with topics enabled, bots can create, rename, and manage threads, directing communications into dedicated rooms. #### 1. Creating a Forum Topic: ```php function create_bot_topic(string|int $chatId, string $topicName, string $customEmojiId = ''): array { $params = [ 'chat_id' => $chatId, 'name' => $topicName ]; if ($customEmojiId !== '') { $params['icon_custom_emoji_id'] = $customEmojiId; } return bot('createForumTopic', $params); } ``` #### 2. Sending Messages Directly to a Topic (`message_thread_id`): ```php bot('sendMessage', [ 'chat_id' => $supergroupId, 'message_thread_id' => $topicId, // Directs message to specific topic 'text' => "📢 Support Ticket #492 Opened\nA customer is waiting for assistance.", 'parse_mode' => 'HTML' ]); ``` --- ### 4.22. 👥 Chat Join Requests & Auto-Approvals (`approveChatJoinRequest`) For private channels and VIP groups requiring approval to join, your bot can automatically approve or decline members based on subscription status or payment verification. ```php $joinReq = $update['chat_join_request'] ?? null; if ($joinReq) { $chatId = $joinReq['chat']['id']; $userId = $joinReq['from']['id']; $invite = $joinReq['invite_link']['invite_link'] ?? ''; // Verify condition (e.g. user paid Stars or registered in DB) $approved = true; if ($approved) { bot('approveChatJoinRequest', [ 'chat_id' => $chatId, 'user_id' => $userId ]); // Send a private welcome message bot('sendMessage', [ 'chat_id' => $userId, 'text' => "🎉 Welcome to the VIP Channel!\nYour membership request has been automatically approved.", 'parse_mode' => 'HTML' ]); } else { bot('declineChatJoinRequest', [ 'chat_id' => $chatId, 'user_id' => $userId ]); } exit; } ``` --- ### 4.23. ⚡ Inline Mode Queries & Instant Results (`answerInlineQuery`) Allow users to type `@YourBot query` in any private chat, group, or channel to summon interactive results directly. ```php $inlineQuery = $update['inline_query'] ?? null; if ($inlineQuery) { $queryId = $inlineQuery['id']; $query = trim($inlineQuery['query']); $results = [ [ 'type' => 'article', 'id' => 'result_1', 'title' => '🌟 Botlify Clouding Platform', 'description' => 'Deploy high-performance PHP Telegram bots in seconds', 'input_message_content' => [ 'message_text' => "🚀 Botlify Cloud\nHost your bots with SQLite, Crons, and Webhooks for free!\nhttps://digibd.store", 'parse_mode' => 'HTML' ] ], [ 'type' => 'article', 'id' => 'result_2', 'title' => '⭐ Telegram Stars Store', 'description' => 'Pay with Telegram Stars (XTR)', 'input_message_content' => [ 'message_text' => "⭐ Check out our official Telegram Stars digital shop!", 'parse_mode' => 'HTML' ] ] ]; bot('answerInlineQuery', [ 'inline_query_id' => $queryId, 'results' => json_encode($results), 'cache_time' => 300, 'is_personal' => true ]); exit; } ``` --- ### 4.24. 🎲 Interactive Entertainment: Polls, Quizzes & Animated Dice (`sendDice`, `sendPoll`) #### 1. Animated Physics Dice (`sendDice`): ```php // Supports: '🎲' (Dice), '🎯' (Darts), '🏀' (Basketball), '⚽' (Football), '🎳' (Bowling), '🎰' (Slot Machine) bot('sendDice', [ 'chat_id' => $chatId, 'emoji' => '🎰' ]); ``` #### 2. Quizzes and Polls (`sendPoll`): ```php bot('sendPoll', [ 'chat_id' => $chatId, 'question' => 'Which currency is used for official Telegram bot payments?', 'options' => json_encode(['USD ($)', 'Telegram Stars (XTR)', 'Bitcoin (BTC)']), 'is_anonymous' => false, 'type' => 'quiz', 'correct_option_id' => 1, // 'Telegram Stars (XTR)' 'explanation' => 'Telegram Stars (XTR) is the official in-app currency for digital goods in Telegram bots.', 'explanation_parse_mode'=> 'HTML' ]); ``` --- ### 4.25. 🛡️ Production Webhook Security & Dropping Pending Updates #### 1. Setting Up Webhook with Secret Token & Clean Slate: ```php function setup_bot_webhook(string $botToken, string $webhookUrl, string $secretToken): array { $url = "https://api.telegram.org/bot{$botToken}/setWebhook"; $ch = curl_init($url); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => json_encode([ 'url' => $webhookUrl, 'secret_token' => $secretToken, // 1 - 256 characters (a-z, A-Z, 0-9, _, -) 'drop_pending_updates' => true, // Ignores stale pending requests on startup 'allowed_updates' => [ 'message', 'edited_message', 'callback_query', 'inline_query', 'pre_checkout_query', 'successful_payment', 'message_reaction', 'message_reaction_count', 'chat_join_request', 'business_connection', 'business_message' ] ]), CURLOPT_HTTPHEADER => ['Content-Type: application/json'] ]); $res = curl_exec($ch); curl_close($ch); return json_decode((string)$res, true) ?: []; } ``` #### 2. Verifying Secret Token Inside `index.php`: ```php // Add this at the very top of your index.php for unbreakable webhook verification: $receivedSecret = $_SERVER['HTTP_X_TELEGRAM_BOT_API_SECRET_TOKEN'] ?? ''; $expectedSecret = $ENV['WEBHOOK_SECRET'] ?? ''; if ($expectedSecret !== '' && !hash_equals($expectedSecret, $receivedSecret)) { http_response_code(403); exit('Forbidden: Invalid webhook secret token.'); } ``` --- ### 4.26. 🔘 Bot Commands, Scopes & Native Menu Button (`setMyCommands`, `setChatMenuButton`) Telegram bots have a native **[Menu] button** at the bottom-left corner of the chat input bar. Configuring slash commands and the Menu Button creates an elite UX where users can discover features in 1 tap without typing `/`. --- #### 1. Registering Slash Commands with Scopes (`setMyCommands`) Commands appear in the autocomplete popup when typing `/` and in the native Telegram Menu Sheet. Always organize commands by **Scopes** so regular users see customer commands while bot owners see administrative controls. ```php function register_bot_commands(?string $adminChatId = null): array { $results = []; // A. Public User Commands (Visible to all users in private chats) $results['users'] = bot('setMyCommands', [ 'commands' => [ ['command' => 'start', 'description' => '🚀 Launch main dashboard & keyboard'], ['command' => 'menu', 'description' => '📋 Open interactive feature menu'], ['command' => 'balance', 'description' => '💳 Check wallet & referral earnings'], ['command' => 'bonus', 'description' => '🎁 Claim daily bonus reward'], ['command' => 'help', 'description' => 'ℹ️ Usage guide & customer support'], ['command' => 'settings', 'description' => '⚙️ Manage preferences & notifications'] ], 'scope' => ['type' => 'all_private_chats'] ]); // B. Secret Admin Commands (Visible ONLY to the bot admin/owner) if ($adminChatId && preg_match('/^-?\d+$/', (string)$adminChatId)) { $results['admin'] = bot('setMyCommands', [ 'commands' => [ ['command' => 'start', 'description' => '🚀 Launch main dashboard'], ['command' => 'admin', 'description' => '👑 Open Admin Control Panel'], ['command' => 'broadcast', 'description' => '📢 Send mass broadcast to users'], ['command' => 'stats', 'description' => '📊 Live platform analytics & KPIs'], ['command' => 'users', 'description' => '👥 User management & search'] ], 'scope' => ['type' => 'chat', 'chat_id' => (int)$adminChatId] ]); } return $results; } ``` --- #### 2. Customizing the Native Bottom-Left Menu Button (`setChatMenuButton`) The `setChatMenuButton` method controls what happens when the user clicks the native `[Menu]` button next to the message input box: ##### Option A: Native Commands Menu Sheet (Recommended for Bots) Opens the native Telegram popup sheet listing all registered slash commands with their descriptive icons: ```php function set_native_commands_menu(?string $chatId = null): array { $params = [ 'menu_button' => [ 'type' => 'commands' // 📋 Opens native command sheet ] ]; if ($chatId !== null) { $params['chat_id'] = $chatId; } return bot('setChatMenuButton', $params); } ``` ##### Option B: Telegram Mini App / WebApp Menu Button Turns the `[Menu]` button into an instant Mini App launcher: ```php function set_webapp_menu_button(string $chatId, string $webAppUrl, string $buttonText = '🚀 Open App'): array { return bot('setChatMenuButton', [ 'chat_id' => $chatId, 'menu_button' => [ 'type' => 'web_app', 'text' => $buttonText, 'web_app' => ['url' => $webAppUrl] ] ]); } ``` ##### Option C: Reset to Default Menu Button ```php function reset_menu_button(?string $chatId = null): array { $params = ['menu_button' => ['type' => 'default']]; if ($chatId !== null) $params['chat_id'] = $chatId; return bot('setChatMenuButton', $params); } ``` --- #### 3. Production Auto-Setup Pattern (Zero Webhook Latency) Never call `setMyCommands` on every incoming webhook update—that wastes CPU and hits Telegram API rate limits. Instead, use an automatic one-time lock file or database flag: ```php // Auto-configure commands and menu button once on first run or update function ensure_bot_menu_configured(): void { $lockFile = __DIR__ . '/.menu_configured'; if (!is_file($lockFile)) { // 1. Register Public Commands register_bot_commands(defined('ADMIN_CHAT_ID') ? (string)ADMIN_CHAT_ID : null); // 2. Configure Native [Menu] Button set_native_commands_menu(); // 3. Save lock file so it runs only once @file_put_contents($lockFile, date('Y-m-d H:i:s')); } } // Call at the start of index.php after loading .env ensure_bot_menu_configured(); ``` --- #### 4. Responding to Slash Commands in `index.php` When a user taps a command from the Menu button or types `/balance`, handle it seamlessly in your update dispatcher: ```php $text = trim($message['text'] ?? ''); switch ($text) { case '/start': send_welcome_dashboard($chatId); break; case '/menu': send_feature_grid($chatId); break; case '/balance': send_wallet_overview($chatId); break; case '/admin': if ((string)$chatId === (string)ADMIN_CHAT_ID) { send_admin_panel($chatId); } else { bot('sendMessage', ['chat_id' => $chatId, 'text' => '⛔ Access denied.']); } break; } ``` --- ### 4.27. 📝 Bot Profile, Descriptions & Multilingual Onboarding (`setMyDescription`, `setMyName`) Automate how your bot appears across Telegram search results, profile dialogs, and empty chat screens. ```php // 1. Set Chat Placeholder Description (0 - 512 chars, shown before user taps /start) bot('setMyDescription', [ 'description' => "🤖 Welcome to the Official Botlify Cloud Assistant!\n\nBuild, host, and scale Telegram bots with integrated SQLite, Cron jobs, Telegram Stars payments, and AI intelligence.", 'language_code' => '' ]); // 2. Set Short Description (0 - 120 chars, displayed on bot profile page and shared links) bot('setMyShortDescription', [ 'short_description' => 'Deploy Telegram bots with SQLite, Stars Pay, and AI.', 'language_code' => '' ]); // 3. Set Bot Name in Title Bar bot('setMyName', [ 'name' => 'Smart Bot Studio 🚀', 'language_code' => '' ]); ``` --- ### 4.28. 👥 Chat Member & Admin Rights Management (`banChatMember`, `restrictChatMember`, `promoteChatMember`) Automate community moderation, gatekeep channels, and restrict disruptive users. #### 1. Banning / Kicking Members (`banChatMember`): ```php function ban_user(string|int $chatId, int $userId, int $banDurationSeconds = 0): array { return bot('banChatMember', [ 'chat_id' => $chatId, 'user_id' => $userId, 'until_date' => $banDurationSeconds > 0 ? time() + $banDurationSeconds : 0, // 0 = permanent 'revoke_messages' => true // Deletes recent messages from the banned user ]); } // Unban / un-mute: bot('unbanChatMember', ['chat_id' => $chatId, 'user_id' => $userId, 'only_if_banned' => true]); ``` #### 2. Restricting Permissions (`restrictChatMember` - Muting): ```php function mute_user(string|int $chatId, int $userId, int $muteSeconds = 3600): array { return bot('restrictChatMember', [ 'chat_id' => $chatId, 'user_id' => $userId, 'until_date' => time() + $muteSeconds, 'permissions' => [ 'can_send_messages' => false, 'can_send_media_messages' => false, 'can_send_polls' => false, 'can_send_other_messages' => false, 'can_add_web_page_previews' => false ] ]); } ``` #### 3. Promoting Members & Setting Custom Admin Titles: ```php bot('promoteChatMember', [ 'chat_id' => $chatId, 'user_id' => $userId, 'can_manage_chat' => true, 'can_delete_messages' => true, 'can_invite_users' => true, 'can_pin_messages' => true, 'can_manage_topics' => true ]); // Set Custom Title Badge (e.g. "👑 Co-Founder" or "🛡️ Moderator") bot('setChatAdministratorCustomTitle', [ 'chat_id' => $chatId, 'user_id' => $userId, 'custom_title' => '🛡️ Senior Mod' ]); ``` --- ### 4.29. 📌 Chat Settings, Pinned Messages & Batch Deletions (`deleteMessages`, `pinChatMessage`, `copyMessages`) #### 1. Batch Deleting Messages (`deleteMessages`): Delete up to 100 messages simultaneously in a single API roundtrip: ```php function batch_delete_messages(string|int $chatId, array $messageIds): array { return bot('deleteMessages', [ 'chat_id' => $chatId, 'message_ids' => $messageIds // Array of integers [101, 102, 103, ...] ]); } ``` #### 2. Batch Copying & Forwarding Messages (`copyMessages`, `forwardMessages`): Replicate content across chats without forwarding link headers: ```php bot('copyMessages', [ 'chat_id' => $destinationChatId, 'from_chat_id' => $sourceChatId, 'message_ids' => [201, 202, 203] ]); ``` #### 3. Pinning and Unpinning Messages: ```php // Pin message silently or with notification bot('pinChatMessage', [ 'chat_id' => $chatId, 'message_id' => $messageId, 'disable_notification' => false ]); // Unpin all messages bot('unpinAllChatMessages', ['chat_id' => $chatId]); ``` --- ### 4.30. 🚀 Channel Boosts & User Boost Detection (`getUserChatBoosts`, `chat_boost`) Reward users who boost your Telegram Channel or Supergroup with automatic VIP membership and exclusive perks! #### 1. Checking If a User Boosted Your Channel: ```php function check_user_boosts(string|int $channelChatId, int $userId): array { $res = bot('getUserChatBoosts', [ 'chat_id' => $channelChatId, 'user_id' => $userId ]); $boosts = $res['result']['boosts'] ?? []; return [ 'is_booster' => count($boosts) > 0, 'boost_count' => count($boosts), 'boosts' => $boosts ]; } ``` #### 2. Real-Time Boost Event Handlers: ```php // User added a boost $boostEvent = $update['chat_boost'] ?? null; if ($boostEvent) { $chatId = $boostEvent['chat']['id']; $user = $boostEvent['boost']['source']['user'] ?? []; $userId = $user['id'] ?? 0; // Credit VIP reward in SQLite $db->prepare("UPDATE users SET is_vip = 1 WHERE chat_id = ?")->execute([$userId]); } // User removed a boost $removedBoost = $update['removed_chat_boost'] ?? null; if ($removedBoost) { $userId = $removedBoost['source']['user']['id'] ?? 0; // Downgrade status if desired } ``` --- ### 4.31. 🖼️ Media Albums & Groups (`sendMediaGroup`) Deliver between 2 and 10 photos or videos together in an aesthetically cohesive album grid: ```php function send_product_album(string|int $chatId, array $photoUrls, string $caption): array { $media = []; foreach ($photoUrls as $idx => $url) { $item = [ 'type' => 'photo', 'media' => $url ]; if ($idx === 0) { $item['caption'] = $caption; $item['parse_mode'] = 'HTML'; } $media[] = $item; } return bot('sendMediaGroup', [ 'chat_id' => $chatId, 'media' => json_encode($media) ]); } // Example usage: send_product_album($chatId, [ 'https://images.unsplash.com/photo-1550745165-9bc0b252726f', 'https://images.unsplash.com/photo-1518770660439-4636190af475' ], "📸 Hardware Showcase Album\nExplore our latest server infrastructure."); ``` --- ### 4.32. 📍 Geolocation, Live Location & Venues (`sendLocation`, `editMessageLiveLocation`) Build delivery trackers, event guides, and location-based check-ins. #### 1. Static Location Pin: ```php bot('sendLocation', [ 'chat_id' => $chatId, 'latitude' => 23.8103, // Latitude 'longitude' => 90.4125 // Longitude ]); ``` #### 2. Live Location Sharing (Real-Time Driver / Delivery Tracking): ```php // Initiate Live Location (updates for up to 24 hours / 86400s) $liveMsg = bot('sendLocation', [ 'chat_id' => $chatId, 'latitude' => 23.8103, 'longitude' => 90.4125, 'live_period' => 3600 // Active for 1 hour ]); $msgId = $liveMsg['result']['message_id'] ?? 0; // Dynamically update coordinates as user moves: bot('editMessageLiveLocation', [ 'chat_id' => $chatId, 'message_id' => $msgId, 'latitude' => 23.8150, 'longitude' => 90.4200 ]); // Stop live tracking when order delivered: bot('stopMessageLiveLocation', ['chat_id' => $chatId, 'message_id' => $msgId]); ``` --- ### 4.33. 📱 Contacts, Phone Verification & VCards (`request_contact`, `sendContact`) Securely verify genuine user identities and cell phone numbers using Telegram's native contact prompt: ```php // 1. Prompt User to Share Verified Phone Number $keyboard = [ 'keyboard' => [ [ ['text' => '📱 Share Verified Phone Number', 'request_contact' => true] ] ], 'resize_keyboard' => true, 'one_time_keyboard'=> true ]; bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "🔐 Account Verification Required\nPlease tap the button below to share your verified Telegram phone number:", 'parse_mode' => 'HTML', 'reply_markup' => json_encode($keyboard) ]); // 2. Intercept Verified Contact in Webhook Handler: $contact = $update['message']['contact'] ?? null; if ($contact) { $phoneNumber = $contact['phone_number']; $userId = $contact['user_id']; // Verify user didn't spoof another person's vCard if ((string)$userId === (string)$update['message']['from']['id']) { // Save verified number in SQLite $db->prepare("UPDATE users SET phone = ?, is_verified = 1 WHERE chat_id = ?")->execute([$phoneNumber, $userId]); bot('sendMessage', [ 'chat_id' => $userId, 'text' => "✅ Phone Verified!\nNumber: {$phoneNumber}\nYour account is now fully unlocked.", 'parse_mode' => 'HTML', 'reply_markup' => json_encode(['remove_keyboard' => true]) ]); } } ``` --- ### 4.34. 🎨 Custom Sticker Packs & Stickers (`createNewStickerSet`, `sendSticker`) Deploy branded sticker collections and send stickers in response to user milestones: ```php // 1. Send an animated or static sticker bot('sendSticker', [ 'chat_id' => $chatId, 'sticker' => 'CAACAgIAAxkBAAE...sticker_file_id' ]); // 2. Programmatically Create a Bot Sticker Set: bot('createNewStickerSet', [ 'user_id' => $ownerUserId, 'name' => 'my_bot_pack_by_' . BOT_USERNAME, // Must end in _by_ 'title' => 'VIP Community Pack', 'sticker_format' => 'static', // 'static' (PNG/WEBP), 'animated' (TGS), 'video' (WEBM) 'stickers' => [ [ 'sticker' => 'https://example.com/sticker1.png', 'emoji_list' => ['🚀', '⭐'], 'format' => 'static' ] ] ]); ``` --- ### 4.35. 🎙️ Voice Notes, Audio & Circular Video Notes (`sendVoice`, `sendVideoNote`, `sendAudio`) Deliver rich auditory and circular video experiences: ```php // 1. Send Circular Video Note (Telescope message) bot('sendVideoNote', [ 'chat_id' => $chatId, 'video_note' => 'https://example.com/camera_bubble.mp4', 'length' => 360 // Diameter in pixels ]); // 2. Send Voice Memo with Caption & Waveform bot('sendVoice', [ 'chat_id' => $chatId, 'voice' => 'https://example.com/audio_memo.ogg', 'caption' => '🎙️ Daily Podcast Briefing', 'parse_mode' => 'HTML', 'duration' => 45 ]); // 3. Send MP3 Audio File with Artist & Title metadata: bot('sendAudio', [ 'chat_id' => $chatId, 'audio' => 'https://example.com/track.mp3', 'performer' => 'Smart Host Audio', 'title' => 'Welcome Jingle', 'duration' => 120 ]); ``` --- ### 4.36. 📢 Mandatory Channel Force-Subscribe / Force Join System (`getChatMember`) Force Subscription (Force Join / Force Sub) is the #1 viral growth mechanic for Telegram bots. Before a user can interact with any bot feature, the bot checks if they have joined your required sponsor channels or community groups. > **⚠️ Prerequisites:** The bot MUST be added as an **Administrator** in your target channel/group so it has permission to call `getChatMember`. --- #### 1. The Membership Verifier Helper (`is_channel_member`) ```php function is_channel_member(string|int $userId, string|int $channelId): bool { $res = bot('getChatMember', [ 'chat_id' => $channelId, 'user_id' => $userId ]); if (empty($res['ok'])) { return false; } $status = $res['result']['status'] ?? ''; // User is a valid subscriber if status is creator, admin, member, or restricted return in_array($status, ['creator', 'administrator', 'member', 'restricted'], true); } ``` --- #### 2. Multi-Channel Force Subscribe Engine Define your sponsor channels or official groups in an array: ```php $REQUIRED_CHANNELS = [ [ 'id' => '@MyOfficialChannel', // Public username with @ OR numeric chat ID -100... 'name' => 'Official Announcements', 'url' => 'https://t.me/MyOfficialChannel' ], [ 'id' => '-1002345678901', // Private channel ID (bot must be admin) 'name' => 'VIP Community Chat', 'url' => 'https://t.me/+AbCdEfGhIjKlMnOp' ] ]; function get_unjoined_channels(string|int $userId, array $channels): array { $missing = []; foreach ($channels as $ch) { if (!is_channel_member($userId, $ch['id'])) { $missing[] = $ch; } } return $missing; } ``` --- #### 3. Displaying the Modern Styled Lock Screen When an unjoined user tries to use the bot, lock their screen with styled URL buttons and an interactive **✅ Joined! Check Now** callback button: ```php function send_force_sub_prompt(string|int $chatId, array $unjoinedChannels): array { $keyboard = []; foreach ($unjoinedChannels as $idx => $ch) { $keyboard[] = [ ['text' => '📢 Join ' . $ch['name'], 'url' => $ch['url']] ]; } // Telegram 8.0 styled success button for verification $keyboard[] = [ ['text' => '✅ Joined! Check Now', 'callback_data' => 'btn_verify_sub', 'style' => 'success'] ]; $text = "🔒 Access Restricted!\n\n" . "To use this bot, you must be a member of our official channels below.\n\n" . "👉 Please join all channels and tap Joined! Check Now to unlock access."; return bot('sendMessage', [ 'chat_id' => $chatId, 'text' => $text, 'parse_mode' => 'HTML', 'disable_web_page_preview' => true, 'reply_markup' => ['inline_keyboard' => $keyboard] ]); } ``` --- #### 4. Handling the Verification Callback in `index.php` When the user taps the verification button, dismiss the loading spinner immediately with `answerCallbackQuery`. If they've joined, delete the lock message and show the main menu; otherwise, show a friendly Telegram alert modal! ```php // Inside your update dispatcher: if ($cb) { $cbId = (string)$cb['id']; $data = (string)($cb['data'] ?? ''); $userId = (string)$cb['from']['id']; $chatId = (string)$cb['message']['chat']['id']; $msgId = (int)$cb['message']['message_id']; if ($data === 'btn_verify_sub') { $unjoined = get_unjoined_channels($userId, $REQUIRED_CHANNELS); if (empty($unjoined)) { // Success! Dismiss spinner with celebration bot('answerCallbackQuery', [ 'callback_query_id' => $cbId, 'text' => '🎉 Access unlocked! Welcome aboard!', 'show_alert' => false ]); // Remove the lock prompt bot('deleteMessage', ['chat_id' => $chatId, 'message_id' => $msgId]); // Send celebration reaction bot('setMessageReaction', [ 'chat_id' => $chatId, 'message_id' => $msgId, 'reaction' => [['type' => 'emoji', 'emoji' => '🎉']] ]); // Deliver Main Menu send_welcome_menu($chatId); } else { // Still missing channels - show native popup alert bot('answerCallbackQuery', [ 'callback_query_id' => $cbId, 'text' => "⚠️ You have not joined all channels yet!\n\nPlease join all required channels and try again.", 'show_alert' => true ]); } exit; } } // In Message Handler (/start or any command): if ($msg && isset($msg['text'])) { $userId = (string)$msg['from']['id']; $chatId = (string)$msg['chat']['id']; // Enforce channel membership before processing ANY command $unjoined = get_unjoined_channels($userId, $REQUIRED_CHANNELS); if (!empty($unjoined)) { send_force_sub_prompt($chatId, $unjoined); exit; } // Proceed to normal bot logic... } ``` --- ### 4.37. 🎆 Full-Screen Message Effects (`message_effect_id`) Telegram Bot API 8.0 allows bots to trigger **full-screen animated background effects** when sending messages in private chats! When the user opens the message, vivid animations (such as bursting confetti or blazing fire) erupt across their entire screen. #### Common Telegram Effect IDs: | Effect Name | Emoji | `message_effect_id` String | | :--- | :---: | :--- | | **Confetti / Celebration** | 🎉 | `5046509860389126442` | | **Blazing Fire** | 🔥 | `5104841245755180586` | | **Thumbs Up** | 👍 | `5107584321108051014` | | **Heart / Love** | ❤️ | `5159385139981059251` | | **Poop / Joke** | 💩 | `5046134037148567282` | ```php function send_effect_message( string|int $chatId, string $text, string $effectId = '5046509860389126442', array $extra = [] ): array { return bot('sendMessage', array_merge([ 'chat_id' => $chatId, 'text' => $text, 'parse_mode' => 'HTML', 'message_effect_id' => $effectId ], $extra)); } // Example: Celebrate user cashout or reward send_effect_message( $chatId, "🎉 CONGRATULATIONS!\nYour withdrawal of $50.00 has been approved!", '5046509860389126442' // Confetti ); ``` --- ### 4.38. ⭐ Telegram Star Subscriptions & Recurring Billing (`createInvoiceLink`, `editUserStarSubscription`) Telegram Bot API 8.0 & 8.1 introduced native **recurring monthly/annual subscriptions** paid in Telegram Stars (`currency: XTR`). #### 1. Generating a Recurring Subscription Invoice Link Specify the `subscription_period` parameter (in seconds). For example, 30 days = `2592000` seconds: ```php function create_star_subscription_link( string $title, string $description, int $starsPerPeriod, string $payload, int $periodSeconds = 2592000 ): ?string { $res = bot('createInvoiceLink', [ 'title' => $title, 'description' => $description, 'payload' => $payload, 'currency' => 'XTR', 'prices' => [['label' => $title, 'amount' => $starsPerPeriod]], 'subscription_period' => $periodSeconds // 30-day recurring subscription ]); return $res['result'] ?? null; } ``` #### 2. Processing Subscription Renewals in Webhook In Bot API 8.1+, `successful_payment` contains recurring flags: ```php if (isset($message['successful_payment'])) { $sp = $message['successful_payment']; $isRecurring = !empty($sp['is_recurring']); $expiresAt = $sp['subscription_expiration_date'] ?? 0; $telegramPaymentChargeId = $sp['telegram_payment_charge_id'] ?? ''; // Record subscription in SQLite database $st = $db->prepare("INSERT INTO subscriptions (user_id, status, expires_at, charge_id) VALUES (?, 'active', ?, ?) ON CONFLICT(user_id) DO UPDATE SET expires_at=excluded.expires_at, status='active'"); $st->execute([$chatId, $expiresAt, $telegramPaymentChargeId]); bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "⭐ Subscription Active!\nValid until: " . date('Y-m-d H:i', $expiresAt) . "", 'parse_mode' => 'HTML' ]); } ``` #### 3. Canceling or Editing a Subscription (`editUserStarSubscription`) Allow users or admins to cancel auto-renewal: ```php function cancel_star_subscription(int $userId, string $telegramPaymentChargeId): array { return bot('editUserStarSubscription', [ 'user_id' => $userId, 'telegram_payment_charge_id' => $telegramPaymentChargeId, 'is_canceled' => true ]); } ``` --- ### 4.39. 🎁 Sending Telegram Gifts to Users & Channels (`sendGift`, `getAvailableGifts`) Telegram Bot API 8.2 & 8.3 allows bots to purchase and send collectible Gifts using Telegram Stars: #### 1. Retrieve Current Gifts Catalog ```php function get_telegram_gifts(): array { $res = bot('getAvailableGifts'); return $res['result']['gifts'] ?? []; } ``` #### 2. Send Gift to a User or Channel ```php // Send Gift to a User: function send_gift_to_user(int $userId, string $giftId, string $congratsText = ''): array { $params = [ 'user_id' => $userId, 'gift_id' => $giftId ]; if ($congratsText !== '') { $params['text'] = $congratsText; $params['text_parse_mode'] = 'HTML'; } return bot('sendGift', $params); } // Send Gift to a Channel (Bot API 8.3): function send_gift_to_channel(string|int $channelChatId, string $giftId): array { return bot('sendGift', [ 'chat_id' => $channelChatId, 'gift_id' => $giftId ]); } ``` --- ### 4.40. 🔗 Modern Link Previews Control (`link_preview_options`) Replace deprecated `disable_web_page_preview` with full granular control over preview layouts: ```php // 1. Disable preview entirely: bot('sendMessage', [ 'chat_id' => $chatId, 'text' => 'Visit https://example.com for info.', 'link_preview_options' => ['is_disabled' => true] ]); // 2. Select specific URL and force large hero banner preview: bot('sendMessage', [ 'chat_id' => $chatId, 'text' => 'Check our guides: https://botlify.cloud and https://t.me/channel', 'link_preview_options' => [ 'url' => 'https://botlify.cloud', 'prefer_large_media' => true, 'show_above_text' => false ] ]); // 3. Compact mini-preview shown ABOVE text: bot('sendMessage', [ 'chat_id' => $chatId, 'text' => 'Read the latest blog post at https://example.com/article', 'link_preview_options' => [ 'prefer_small_media' => true, 'show_above_text' => true ] ]); ``` --- ### 4.41. 🎬 Enhanced Video Controls (`sendVideo` with `cover` & `start_timestamp`) Telegram Bot API 8.3 allows bots to set custom video cover images and playback starting offsets: ```php bot('sendVideo', [ 'chat_id' => $chatId, 'video' => 'https://example.com/tutorial.mp4', 'caption' => '🎬 Watch Chapter 2: Database Setup', 'parse_mode' => 'HTML', 'cover' => 'https://example.com/chapter2_thumbnail.jpg', // Custom video cover 'start_timestamp' => 45, // Skip intro and start playback at 00:45 'supports_streaming' => true ]); ``` --- ### 4.42. 📨 Batch Message Operations (`copyMessages`, `forwardMessages`) Efficiently forward or clone up to 100 messages at once without looping single API calls: ```php // Batch copy messages from storage channel to user chat: function batch_copy_messages( string|int $toChatId, string|int $fromChatId, array $messageIds ): array { return bot('copyMessages', [ 'chat_id' => $toChatId, 'from_chat_id' => $fromChatId, 'message_ids' => array_values($messageIds) // e.g. [101, 102, 103] ]); } // Batch forward without modifying attribution: function batch_forward_messages( string|int $toChatId, string|int $fromChatId, array $messageIds ): array { return bot('forwardMessages', [ 'chat_id' => $toChatId, 'from_chat_id' => $fromChatId, 'message_ids' => array_values($messageIds) ]); } ``` --- ### 4.43. 🛡️ Verification Badges & Organization Checks (`verifyUser`, `verifyChat`) Telegram Bot API 8.2 allows certified bots to assign or revoke verification badges on behalf of companies, corporate registries, or educational institutions: ```php // Verify a student or verified client function verify_community_user(int $userId, string $description = 'Verified VIP Trader'): array { return bot('verifyUser', [ 'user_id' => $userId, 'custom_description' => $description ]); } // Remove verification if subscription expires function revoke_community_user_verification(int $userId): array { return bot('removeUserVerification', [ 'user_id' => $userId ]); } ``` --- ### 4.44. 🕹️ Telegram HTML5 Games Engine (`sendGame`, `setGameScore`, `getGameHighScores`) Telegram bots can host and launch interactive HTML5 canvas games directly within the Telegram app, complete with real-time multiplayer leaderboards and high score tracking! #### 1. Sending a Game Card (`sendGame`): ```php function send_bot_game(string|int $chatId, string $gameShortName): array { return bot('sendGame', [ 'chat_id' => $chatId, 'game_short_name' => $gameShortName, // Configured via BotFather /newgame 'reply_markup' => [ 'inline_keyboard' => [ [ ['text' => '🎮 Play Now!', 'callback_game' => []] ], [ ['text' => '🏆 Leaderboard', 'callback_data' => 'game_leaderboard'] ] ] ] ]); } ``` #### 2. Launching the Game on Button Click: When the user taps the "Play Now" button, Telegram sends a callback query with `game_short_name`. Respond with `answerCallbackQuery` pointing to your game URL: ```php if ($cb && isset($cb['game_short_name'])) { $gameUrl = 'https://botlify.cloud/games/flappy_star/?user=' . $cb['from']['id']; bot('answerCallbackQuery', [ 'callback_query_id' => $cb['id'], 'url' => $gameUrl ]); exit; } ``` #### 3. Submitting Scores & Leaderboard (`setGameScore`, `getGameHighScores`): ```php // Save user score (from your game backend): function record_user_score(int $userId, int $score, int $chatId, int $messageId): array { return bot('setGameScore', [ 'user_id' => $userId, 'score' => $score, 'chat_id' => $chatId, 'message_id' => $messageId, 'force' => true ]); } // Fetch Top Scores: function get_game_leaderboard(int $userId, int $chatId, int $messageId): array { $res = bot('getGameHighScores', [ 'user_id' => $userId, 'chat_id' => $chatId, 'message_id' => $messageId ]); return $res['result'] ?? []; } ``` --- ### 4.45. ⏳ Chat Action Typing Indicators (`sendChatAction`) Sending chat actions before processing AI responses, database searches, or media generation keeps users informed and dramatically reduces perceived waiting time: | Action Parameter | Telegram UI Status Display | | :--- | :--- | | `'typing'` | *"typing..."* (Best for AI, text generation) | | `'upload_photo'` | *"sending photo..."* | | `'record_video'` / `'upload_video'` | *"sending video..."* | | `'record_voice'` / `'upload_voice'` | *"sending voice message..."* | | `'upload_document'` | *"sending file..."* | | `'choose_sticker'` | *"choosing a sticker..."* | | `'find_location'` | *"finding location..."* | ```php function send_typing(string|int $chatId, string $action = 'typing'): array { return bot('sendChatAction', [ 'chat_id' => $chatId, 'action' => $action ]); } // Practical usage before heavy AI completion: send_typing($chatId, 'typing'); $aiReply = query_gemini_or_openai($userPrompt); bot('sendMessage', ['chat_id' => $chatId, 'text' => $aiReply, 'parse_mode' => 'HTML']); ``` --- ### 4.46. 🔐 Seamless Telegram Web OAuth Login (`login_url`) Authenticate Telegram users on your web application or Mini App with 1 tap using `login_url` inline buttons. No passwords, SMS, or OTPs required! ```php function send_web_login_button(string|int $chatId): array { return bot('sendMessage', [ 'chat_id' => $chatId, 'text' => '🔐 Access Your Web Dashboard:\nClick below to securely authenticate your account.', 'parse_mode' => 'HTML', 'reply_markup' => [ 'inline_keyboard' => [ [ [ 'text' => '🚀 Log in to Web Studio', 'login_url' => [ 'url' => 'https://botlify.cloud/auth/telegram_callback.php', 'forward_text' => 'Log in to Botlify Cloud', 'bot_username' => BOT_USERNAME, 'request_write_access' => true ] ] ] ] ] ]); } ``` #### Verifying the Telegram Auth Hash in PHP: ```php function verify_telegram_auth(array $authData, string $botToken): bool { $checkHash = $authData['hash'] ?? ''; unset($authData['hash']); $dataCheckArr = []; foreach ($authData as $key => $value) { $dataCheckArr[] = $key . '=' . $value; } sort($dataCheckArr); $dataCheckString = implode("\n", $dataCheckArr); $secretKey = hash('sha256', $botToken, true); $hash = hash_hmac('sha256', $dataCheckString, $secretKey); return hash_equals($hash, $checkHash) && (time() - (int)$authData['auth_date'] < 86400); } ``` --- ### 4.47. 🔘 Interactive Keyboard Request Selectors (`request_users`, `request_chat`, `request_contact`, `request_location`, `request_poll`) Allow users to select other users, channels, phone numbers, GPS coordinates, or polls using Telegram's native picker dialogs: ```php $selectorKeyboard = [ 'keyboard' => [ // 1. Pick Users or Bots [ [ 'text' => '👥 Pick a Friend to Invite', 'request_users' => [ 'request_id' => 1, 'is_bot' => false, 'max_quantity' => 1 ] ] ], // 2. Pick Channel or Group where Bot is Admin [ [ 'text' => '📢 Select Your Channel', 'request_chat' => [ 'request_id' => 2, 'chat_is_channel' => true, 'bot_is_member' => true ] ] ], // 3. Share Verified Phone Number & Location [ ['text' => '📱 Share Phone', 'request_contact' => true], ['text' => '📍 Share Location', 'request_location' => true] ], // 4. Create Quiz Poll [ ['text' => '📊 Create Quiz', 'request_poll' => ['type' => 'quiz']] ] ], 'resize_keyboard' => true, 'one_time_keyboard' => true ]; bot('sendMessage', [ 'chat_id' => $chatId, 'text' => '👇 Please select an action from the menu:', 'parse_mode' => 'HTML', 'reply_markup' => $selectorKeyboard ]); ``` --- ### 4.48. 🔗 Dynamic Chat Invite Links with Limits & Expiry (`createChatInviteLink`, `revokeChatInviteLink`) Create single-use, timed, or paid invite links for VIP communities and subscription tiers: ```php function create_timed_vip_invite(string|int $channelId, int $hoursValid = 24, int $maxUses = 1): ?string { $res = bot('createChatInviteLink', [ 'chat_id' => $channelId, 'name' => 'VIP Pass (24h Single-Use)', 'expire_date' => time() + ($hoursValid * 3600), 'member_limit' => $maxUses, 'creates_join_request' => false ]); return $res['result']['invite_link'] ?? null; } // Revoke an old invite link: function revoke_vip_invite(string|int $channelId, string $inviteLink): array { return bot('revokeChatInviteLink', [ 'chat_id' => $channelId, 'invite_link' => $inviteLink ]); } ``` --- ### 4.49. 🖼️ User Profile Photos & File Downloads (`getUserProfilePhotos`, `getFile`) Inspect user profile avatars and download media files directly from Telegram servers: ```php // 1. Get user profile photos function get_user_avatar_file_id(int $userId): ?string { $res = bot('getUserProfilePhotos', ['user_id' => $userId, 'limit' => 1]); $photos = $res['result']['photos'] ?? []; if (!empty($photos[0])) { // Last element in size array is highest resolution $largest = end($photos[0]); return $largest['file_id'] ?? null; } return null; } // 2. Resolve direct download URL on Telegram CDN function get_telegram_file_download_url(string $fileId): ?string { $res = bot('getFile', ['file_id' => $fileId]); $filePath = $res['result']['file_path'] ?? null; if ($filePath) { return 'https://api.telegram.org/file/bot' . BOT_TOKEN . '/' . $filePath; } return null; } ``` --- ### 4.50. 📚 The Complete A-to-Z Telegram Bot API Master Reference Matrix Quick alphabetical reference for all **100+ official Telegram Bot API methods**: | Method Name | Category | Primary Purpose & Usage | | :--- | :--- | :--- | | `answerCallbackQuery` | UI / Callbacks | Dismiss button spinners & show popup alert modals | | `answerInlineQuery` | Inline Mode | Deliver instant search query results directly in chat | | `answerPreCheckoutQuery` | Payments / Stars | Approve or reject payment before funds are charged | | `answerShippingQuery` | Payments | Provide shipping prices and delivery options | | `answerWebAppQuery` | Mini Apps | Send inline message from Mini App to chat | | `approveChatJoinRequest` | Administration | Accept pending join request to private group/channel | | `banChatMember` | Moderation | Kick and ban user from group/channel | | `banChatSenderChat` | Moderation | Ban channel from sending messages in group | | `close` | Instance Control | Close bot instance before moving to local server | | `copyMessage` | Messaging | Copy message to chat with optional new caption | | `copyMessages` | Batch Messaging | Batch copy up to 100 messages at once | | `createChatInviteLink` | Administration | Generate timed or member-limited invite link | | `createChatSubscriptionInviteLink` | Stars / Subscriptions | Generate recurring Stars subscription invite link | | `createForumTopic` | Forum Groups | Create forum topic with name and icon | | `createInvoiceLink` | Payments / Stars | Generate shareable payment or subscription link | | `createNewStickerSet` | Stickers | Programmatically create a new sticker pack | | `declineChatJoinRequest` | Administration | Reject pending join request | | `deleteChatPhoto` | Administration | Remove chat profile photo | | `deleteChatStickerSet` | Administration | Remove group sticker set | | `deleteMessage` | Moderation | Delete single message | | `deleteMessages` | Moderation | Batch delete up to 100 messages at once | | `deleteMyCommands` | Customization | Clear registered slash commands | | `deleteStickerFromSet` | Stickers | Remove sticker from pack | | `deleteWebhook` | Updates | Remove webhook and switch to long polling | | `editChatInviteLink` | Administration | Edit existing invite link parameters | | `editForumTopic` | Forum Groups | Rename topic or change icon | | `editGeneralForumTopic` | Forum Groups | Edit general topic in forum | | `editMessageCaption` | Messaging | Edit caption of existing media message | | `editMessageLiveLocation` | Location | Update live GPS coordinates of moving message | | `editMessageMedia` | Media | Replace photo/video inside existing message | | `editMessageReplyMarkup` | UI / Keyboards | Update or remove inline button keyboards | | `editMessageText` | Messaging | Update text and buttons of existing message | | `editUserStarSubscription` | Stars / Subscriptions | Cancel or extend user's Star recurring subscription | | `exportChatInviteLink` | Administration | Generate primary public invite link | | `forwardMessage` | Messaging | Forward message with original author credit | | `forwardMessages` | Batch Messaging | Batch forward up to 100 messages at once | | `getAvailableGifts` | Gifts | Fetch available Telegram collectible gifts catalog | | `getBusinessConnection` | Business | Fetch business account connection status | | `getChat` | Administration | Get full chat metadata, description, and permissions | | `getChatAdministrators` | Administration | Fetch list of chat admins and creators | | `getChatMember` | Moderation | Fetch specific user membership status in channel | | `getChatMemberCount` | Administration | Get total member count of chat/channel | | `getChatMenuButton` | Customization | Fetch current bottom-left menu button config | | `getFile` | Files / Media | Get file path on Telegram CDN for downloading | | `getGameHighScores` | Games | Fetch top leaderboard scores for game | | `getMe` | Information | Verify bot token and fetch bot identity | | `getMyCommands` | Customization | View registered slash commands | | `getMyDefaultAdministratorRights` | Administration | Get default bot permissions for groups | | `getMyDescription` | Onboarding | Get bot bio description | | `getMyName` | Onboarding | Get bot display name | | `getMyShortDescription` | Onboarding | Get short about text | | `getStickerSet` | Stickers | Get stickers and metadata of pack | | `getUpdates` | Updates | Long-polling update fetcher | | `getUserChatBoosts` | Channel Boosts | Fetch boosts applied to chat by a user | | `getUserProfilePhotos` | User Metadata | Fetch user profile avatar photos | | `getWebhookInfo` | Updates | Check current webhook status and error flags | | `hideGeneralForumTopic` | Forum Groups | Hide General topic in forum supergroup | | `leaveChat` | Administration | Bot exits group or channel | | `logOut` | Instance Control | Log out from cloud Bot API before local migration | | `pinChatMessage` | Administration | Pin message to top of chat | | `promoteChatMember` | Administration | Promote user to administrator with permissions | | `refundStarPayment` | Payments / Stars | Refund Telegram Stars transaction to user | | `reopenForumTopic` | Forum Groups | Reopen closed forum topic | | `reopenGeneralForumTopic` | Forum Groups | Reopen closed General topic | | `replaceStickerInSet` | Stickers | Replace a sticker inside pack | | `restrictChatMember` | Moderation | Restrict user permissions (mute, media ban) | | `revokeChatInviteLink` | Administration | Deactivate chat invite link | | `savePreparedInlineMessage` | Mini Apps | Pre-generate inline message for Mini App sharing | | `sendAnimation` | Media | Send animated GIF or silent MP4 loop | | `sendAudio` | Media | Send MP3 music with artist & title tags | | `sendChatAction` | Indicators | Send typing / uploading photo status | | `sendContact` | Contacts | Send phone contact card | | `sendDice` | Entertainment | Roll animated dice, dart, football, or slots | | `sendDocument` | Files | Send PDF, ZIP, code, or any document file | | `sendGame` | Games | Send HTML5 game card | | `sendGift` | Gifts | Send Telegram Stars gift to user or channel | | `sendInvoice` | Payments / Stars | Send payment invoice for goods or Stars | | `sendLocation` | Location | Send GPS coordinates map point | | `sendMediaGroup` | Media | Send album of up to 10 photos/videos | | `sendMessage` | Messaging | Primary text messaging method | | `sendPaidMedia` | Stars / Paid Media | Send Star-gated paywalled photos or videos | | `sendPhoto` | Media | Send JPG/PNG image with caption | | `sendPoll` | Polls | Send regular poll or trivia quiz | | `sendSticker` | Stickers | Send static, animated (TGS), or video sticker | | `sendVenue` | Location | Send venue with title, address, and Foursquare ID | | `sendVideo` | Media | Send MP4 video with cover and start timestamp | | `sendVideoNote` | Media | Send circular video note bubble | | `sendVoice` | Media | Send OGG voice memo | | `setChatAdministratorCustomTitle` | Administration | Set custom title badge for admin (e.g. "Founder") | | `setChatDescription` | Administration | Set group or channel description | | `setChatMenuButton` | Customization | Set bottom-left button (Commands, WebApp, Default) | | `setChatPermissions` | Moderation | Set default permissions for all group members | | `setChatPhoto` | Administration | Upload new chat profile picture | | `setChatTitle` | Administration | Rename group or channel | | `setGameScore` | Games | Record high score for user in game | | `setMessageReaction` | Reactions | Add emoji reaction (👍, 🔥, 🎉) to message | | `setMyCommands` | Customization | Register slash command menu with scopes | | `setMyDefaultAdministratorRights` | Administration | Set default rights for when bot is added to chats | | `setMyDescription` | Onboarding | Set what bot does (empty chat screen) | | `setMyName` | Onboarding | Change bot display name | | `setMyShortDescription` | Onboarding | Set bot about info | | `setPassportDataErrors` | Passport | Report verification errors in Telegram Passport | | `setUserEmojiStatus` | User Status | Set custom emoji status for premium user | | `setWebhook` | Updates | Point Telegram webhook to Botlify gateway | | `stopMessageLiveLocation` | Location | End live location sharing | | `stopPoll` | Polls | Close active poll and reveal final results | | `unbanChatMember` | Moderation | Remove ban from user | | `unbanChatSenderChat` | Moderation | Allow channel to send messages in group again | | `unhideGeneralForumTopic` | Forum Groups | Unhide General forum topic | | `unpinAllChatMessages` | Administration | Clear all pinned messages in chat | | `unpinAllForumTopicMessages` | Forum Groups | Clear pins in specific topic | | `unpinChatMessage` | Administration | Unpin specific message | | `uploadStickerFile` | Stickers | Upload sticker file for new pack creation | | `verifyChat` | Verification | Assign verified badge to chat for organization | | `verifyUser` | Verification | Assign verified badge to user for organization | --- --- ## 5. 🛠️ Botlify Model Context Protocol (MCP) Server & 37 Tools Specification Connect your AI coding assistants—including **Claude Desktop**, **Cursor IDE**, **Antigravity**, **Windsurf**, and custom LLM agents—directly to your Free Bot Host account using the **Model Context Protocol (MCP)**. With this MCP integration, your AI assistant can directly inspect your Telegram bots, write & edit PHP code, run syntax checks, manage scheduled cron jobs, query SQLite databases, and monitor broadcast statistics using natural language! --- ### 💡 What is MCP? **Model Context Protocol (MCP)** is an open protocol standard developed by Anthropic that allows AI models to safely access external tools, databases, and filesystem contexts in real-time. By linking Free Bot Host to your AI assistant: - The AI can read your `index.php` or any handler file, write code updates, and verify syntax automatically. - The AI can inspect your bot's SQLite database schema (`storage/database.db`) and write queries to debug issues. - The AI can view active cron jobs, test them, and report execution errors. --- ### 🌐 Server Endpoint & Authentication #### Endpoint URL: ```http https://your-domain.com/mcp.php?key=fbh_usr_your_api_key_here ``` #### Where to get your API Key: 1. Open the **Mini App** dashboard. 2. Go to the **Profile** tab. 3. Locate the **Developer API & MCP Protocol** section. 4. Copy your API Key or click **🔄 Regenerate Key** if you ever need to reset it. --- ### 🔌 Connecting with AI Clients #### 1. Claude Desktop Configuration Claude Desktop supports MCP servers via its configuration file `claude_desktop_config.json`: - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json` - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json` Add the following block to your `mcpServers` configuration: ```json { "mcpServers": { "free-bot-host": { "command": "npx", "args": [ "-y", "mcp-remote-client", "https://your-domain.com/mcp.php?key=fbh_usr_your_api_key_here" ] } } } ``` > 💡 *Note*: If your client supports direct HTTP/SSE MCP endpoints, you can directly specify `https://your-domain.com/mcp.php?key=fbh_usr_your_api_key_here`. --- #### 2. Cursor IDE Configuration Cursor IDE supports MCP servers natively in settings: 1. Open **Cursor Settings** (`Ctrl + Shift + J` or `Cmd + Shift + J`). 2. Navigate to **Features** -> **MCP**. 3. Click **+ Add New MCP Server**. 4. Configure the server: - **Name**: `FreeBotHost` - **Type**: `command` or `remote` - **Command / URL**: ```bash npx -y mcp-remote-client "https://your-domain.com/mcp.php?key=fbh_usr_your_api_key_here" ``` 5. Click **Save** and verify that tools appear with green checkmarks. --- #### 3. Antigravity / Generic MCP Client For custom MCP client runners or Node-based bridges: ```bash npx -y @modelcontextprotocol/inspector https://your-domain.com/mcp.php?key=fbh_usr_your_api_key_here ``` --- ### 🛠️ Available MCP Tools Reference Your AI assistant has access to **29 specialized tools**: #### 🛠️ Bot Building, Scaffolding & Webhook Testing (NEW) | Tool Name | Description | Key Arguments | |---|---|---| | `get_bot_making_guide` | Retrieves master bot development docs, best practices & styled keyboard guide | `section` (optional: `keyboards`, `database`, `cron`, etc.) | | `scaffold_bot_code` | Generates complete, production-ready bot boilerplate with styled buttons | `type` (`styled_keyboard`, `database_bot`, `shop_bot`), `bot_name` | | `install_bot_scaffold` | Deploys a production scaffold directly to bot's `index.php` | `bot_id`, `type` | | `validate_bot_code` | Performs deep syntax verification & lint checks before saving/running | `code` | | `test_bot_webhook` | Simulates live Telegram Webhook POST updates in sandbox and captures logs | `bot_id`, `update` (optional) | #### 📚 Botlify Knowledge Base & Documentation Engine (NEW) | Tool Name | Description | Key Arguments | |---|---|---| | `about_botlify` | Comprehensive A-to-Z overview of Botlify Cloud: architecture, serverless PHP 8.2+ runtime, SQLite WAL database, 20ms cURL engine, security sandboxing, webhook lifecycle, key features, and developer rules | None | | `get_full_docs` | Retrieves complete, unabridged master developer documentation for Botlify Cloud from `docs/docs.md` (14 chapters, full Telegram Bot API 203 methods & 401 types, MCP server, REST API, Broadcast network, Blog engine, and GitHub backup) | `offset` (optional), `limit` (optional) | | `list_docs` | Lists all 638 documentation topics, platform guides, Telegram Bot API methods, and types with their categories, summaries, read times, and canonical URLs | None | | `search_docs` | Searches documentation and Telegram Bot API reference by keyword or phrase. Returns scored matching articles with relevance snippets and canonical URLs | `query` (required), `max_results` (optional, default 10) | #### 🎨 Styled Keyboard Colors Reference Telegram Mini Apps and modern Telegram bot clients support button style attributes: | Style | Color | Primary Usage | | :--- | :--- | :--- | | `primary` | **Blue** 🔵 | Main Actions, Launch App, Next, Open Menu, Confirm | | `success` | **Green** 🟢 | Buy Now, Deposit, Pay, Approve, Activate | | `danger` | **Red** 🔴 | Delete, Cancel, Reset, Reject, Stop | ```php // Inline Keyboard with Styles: $inlineKeyboard = [ 'inline_keyboard' => [ [ ['text' => '🚀 Launch App', 'callback_data' => 'launch', 'style' => 'primary'], // Blue ['text' => '💳 Buy VIP', 'callback_data' => 'buy', 'style' => 'success'] // Green ], [ ['text' => '❌ Cancel', 'callback_data' => 'cancel', 'style' => 'danger'] // Red ] ] ]; $reply_markup = json_encode($inlineKeyboard); // Reply Keyboard with Styles: $replyKeyboard = [ 'keyboard' => [ [ ['text' => '🟢 Activate Service', 'style' => 'success'], ['text' => '🔵 Account Dashboard', 'style' => 'primary'] ], [ ['text' => '🔴 Terminate Session', 'style' => 'danger'] ] ], 'resize_keyboard' => true ]; $reply_markup = json_encode($replyKeyboard); ``` #### 🤖 Bot Management | Tool Name | Description | Key Arguments | |---|---|---| | `list_bots` | Lists bots owned by you. Default returns only active bots (excludes recycle bin). | `status` (`active` [default], `deleted`, `all`) | | `get_bot_info` | Retrieves comprehensive info for a bot by ID or username | `bot_id` | | `create_bot` | Deploys a new bot using a Telegram BotFather token | `token`, `admin_chat_id` | | `delete_bot` | Moves bot to recycle bin (soft delete), or permanently deletes when `permanent: true` | `bot_id`, `permanent` (optional boolean, default `false`) | | `restore_bot` | Restores a deleted bot from the recycle bin back to active status & resets webhook | `bot_id` | | `restart_bot` | Refreshes webhook, tests connection, and resets error flags | `bot_id` | #### 📁 Filesystem & Code Editing | Tool Name | Description | Key Arguments | |---|---|---| | `list_files` | Lists files and sub-folders in bot directory | `bot_id`, `path` | | `read_file` | Reads source code or contents of any bot file | `bot_id`, `file` | | `write_file` | Writes/edits code with automated PHP syntax verification | `bot_id`, `file`, `content` | | `create_file` | Creates a new file in a bot directory | `bot_id`, `name`, `path`, `content` | | `create_folder` | Creates a new subdirectory in bot workspace | `bot_id`, `name`, `path` | | `delete_file` | Deletes a file or directory | `bot_id`, `file` | #### ⚙️ Environment Variables (.env) | Tool Name | Description | Key Arguments | |---|---|---| | `get_env_variables` | Returns parsed environment key-value pairs | `bot_id` | | `set_env_variables` | Updates environment variables in `.env` | `bot_id`, `variables` | #### ⏰ Cron Tasks Automation | Tool Name | Description | Key Arguments | |---|---|---| | `list_cron_jobs` | Lists all scheduled background cron tasks | `bot_id` | | `create_cron_job` | Schedules a new cron script | `bot_id`, `script_path`, `interval_type` | | `run_cron_job` | Runs a cron task immediately and inspects logs | `bot_id`, `cron_id` | #### 🗄️ Database Operations (SQLite) | Tool Name | Description | Key Arguments | |---|---|---| | `get_database_schema` | Returns database tables, column types, and row count | `bot_id` | | `query_database` | Runs sandboxed SQL queries on `storage/database.db` | `bot_id`, `query` | #### 📢 Broadcast Studio | Tool Name | Description | Key Arguments | |---|---|---| | `get_broadcast_stats` | Inspects subscriber count and 7-day activity | `bot_id` | | `send_broadcast` | Launches a broadcast to bot audience | `bot_id`, `message`, `audience` | #### 👤 Account & Marketplace | Tool Name | Description | Key Arguments | |---|---|---| | `get_profile` | Retrieves user account limits, bot slots, referral count | none | | `get_wallet` | Retrieves balance, sales earnings, and transactions | none | | `browse_store` | Browses templates and bots in the marketplace | `search`, `category` | | `install_store_bot` | Installs a bot template directly into user account | `store_id`, `token` | #### 📦 Bot Code Transfer System | Tool Name | Description | Key Arguments | |---|---|---| | `create_bot_transfer` | Generates a 72-hour transfer code for sending bot code to another user | `bot_id`, `target_recipient` | | `list_bot_transfers` | Lists pending incoming and outgoing bot code transfers | none | | `get_transfer_info` | Checks the status, bot name, and expiration of a transfer code | `transfer_code` | | `accept_bot_transfer` | Accepts an incoming bot transfer and deploys it with your Bot Token | `transfer_code`, `token`, `admin_chat_id` | | `reject_bot_transfer` | Rejects and cancels an incoming bot transfer offer | `transfer_id` | --- ### 📚 Available MCP Resources The MCP server exposes live bot resources using the `fbh://` URI scheme: - `fbh://docs/botmaking` — Complete Telegram Bot Making & Styled Keyboard Guide (`botmakingdocs.md`). - `fbh://bots/{bot_id}/info` — Real-time bot metadata and runtime status. - `fbh://bots/{bot_id}/schema` — SQLite database schema and tables. - `fbh://bots/{bot_id}/env` — Active `.env` file variables. Your AI model can attach these resources directly into its conversation context for zero-latency awareness. --- ### 🎯 Available MCP Prompts 1. **`create_styled_keyboard_bot`**: - Scaffolds and deploys a modern Telegram bot with primary (Blue), success (Green), and danger (Red) styled inline/reply buttons. 2. **`bot_health_check`**: - Diagnoses webhook health, syntax errors, cron task status, and database integrity for any bot. 3. **`code_audit_and_enhance`**: - Reads your bot's code, identifies potential security risks or logic bugs, and suggests modern enhancements. --- ### 💬 Example AI Prompts & Use Cases Once connected, you can ask your AI assistant questions like: #### 1. Code Development > *"List all files in my bot @MyShopBot. Read `index.php` and add a new `/help` command that lists all available products."* #### 2. Database Inspection & Debugging > *"Inspect the database schema of bot ID 2. How many users are registered? Show me the 5 most recently active users."* #### 3. Background Task Scheduling > *"Create a new cron job for bot ID 3 that runs `tasks/cleanup.php` once every day."* #### 4. Audience Broadcasting > *"Check the subscriber count of bot ID 1. If there are more than 10 users, send a broadcast announcing our weekend discount."* --- ### ❓ Troubleshooting & FAQ ##### 1. Why do I get "Unauthorized" error? - Ensure you have generated an API Key from the Mini App Profile tab. - Ensure the key parameter is passed properly in the query string (`?key=fbh_usr_...`) or `X-API-KEY` header. ##### 2. Can the AI delete my entire account? - No. The API is strictly scoped to the authenticated user's bots. Destructive operations like `delete_bot` only perform a soft-delete (moving to the 7-day recycle bin), which can easily be restored. - The SQLite query tool is strictly isolated to the bot's own `storage/database.db`. Host-level file tampering or database cross-talk is prevented. ##### 3. What if I regenerate my API key? - Once you click **🔄 Regenerate Key** in the Mini App, your old key is immediately revoked. You must update your `claude_desktop_config.json` or Cursor MCP settings with the new key. --- ## 6. 🌐 Developer REST API (user_api.php) Reference Welcome to the official Developer REST API of **Free Bot Host**. This API empowers you to manage all aspects of your hosted Telegram bots remotely, automate deployments, integrate with CI/CD pipelines, or control your bots programmatically using any programming language. --- ### 🌐 Overview & Base URL The API endpoint is hosted on your Free Bot Host installation: ```http https://your-domain.com/user_api.php ``` All requests can be sent via `GET` or `POST` (supporting JSON `application/json` as well as `multipart/form-data` and `application/x-www-form-urlencoded`). --- ### 🔑 Authentication Every request to `user_api.php` requires your personal **API Key**. You can pass your key using any of the following 3 standard methods: #### Method 1: Custom HTTP Header (Recommended) ```http X-API-KEY: fbh_usr_0123456789abcdef0123456789abcdef01234567 ``` #### Method 2: Authorization Bearer Header ```http Authorization: Bearer fbh_usr_0123456789abcdef0123456789abcdef01234567 ``` #### Method 3: Query Parameter or POST Field ```http https://your-domain.com/user_api.php?api_key=fbh_usr_0123456789abcdef0123456789abcdef01234567&action=list_bots ``` --- ### ⚙️ Managing Your API Key 1. Open the Telegram Mini App dashboard. 2. Click on the **Profile** tab in the navigation bar. 3. Locate the **Developer API & MCP Protocol** card. 4. Your personal API Key is automatically generated (`fbh_usr_...`). 5. Click **📋 Copy** to copy it to your clipboard. 6. Click **🔄 Regenerate Key** at any time to invalidate old credentials and generate a fresh key. --- ### 📦 Request & Response Formats All successful API responses return a JSON object with `"ok": true`. In case of errors, the response contains `"ok": false` along with an informative `"error"` message. #### Standard Success Response: ```json { "ok": true, "...": "..." } ``` #### Standard Error Response: ```json { "ok": false, "error": "Bot not found or access denied." } ``` --- ### 📑 Endpoints Reference #### 1. User & Profile ##### Get User Profile & Quotas - **Action**: `profile` or `get_profile` - **Method**: `GET` / `POST` - **Example**: ```http GET /user_api.php?action=get_profile ``` - **Response**: ```json { "ok": true, "user": { "id": 1, "chat_id": "123456789", "first_name": "John", "username": "john_dev", "balance": 15.50, "balance_formatted": "15.50 USDT", "bot_limit": 5, "used_bots": 2, "available_slots": 3, "storage_mb": 50, "refer_link": "https://t.me/free_bot_host_bot?start=ref_123456789", "refer_count": 4, "api_key": "fbh_usr_...", "created_at": "2026-09-01 12:00:00" } } ``` --- #### 2. Wallet & Earnings ##### Get Wallet Balance & Transactions - **Action**: `wallet` or `get_wallet` - **Method**: `GET` / `POST` - **Example**: ```http GET /user_api.php?action=get_wallet ``` - **Response**: ```json { "ok": true, "balance": 15.50, "balance_formatted": "15.50 USDT", "total_earnings": 25.00, "transactions": [ { "id": 12, "type": "sale", "amount": 5.00, "status": "completed", "details": "Bot purchase commission", "created_at": "2026-09-15 14:20:00" } ] } ``` --- #### 3. Bots Management ##### List Hosted Bots - **Action**: `list_bots` - **Parameters**: `status` (optional: `all`, `active`, `deleted`) - **Example**: ```http GET /user_api.php?action=list_bots ``` ##### Get Bot Details - **Action**: `get_bot` - **Parameters**: `bot_id` (ID or `@username`) - **Example**: ```http GET /user_api.php?action=get_bot&bot_id=10 ``` ##### Deploy / Create New Bot - **Action**: `create_bot` - **Method**: `POST` - **Parameters**: - `token` (Required): BotFather token - `admin_chat_id` (Optional): Telegram ID of the bot admin - **Example Body**: ```json { "action": "create_bot", "token": "1234567890:AAHxyz...", "admin_chat_id": "123456789" } ``` ##### Soft-Delete Bot - **Action**: `delete_bot` - **Parameters**: `bot_id` ##### Restore Bot - **Action**: `restore_bot` - **Parameters**: `bot_id` ##### Restart Bot & Refresh Webhook - **Action**: `restart_bot` - **Parameters**: `bot_id` ##### Update Bot Token or Admin ID - **Action**: `update_bot` - **Parameters**: `bot_id`, `token` (optional), `admin_chat_id` (optional) --- #### 4. File Manager & Code Editor ##### List Files & Directories - **Action**: `list_files` - **Parameters**: - `bot_id`: Target Bot ID - `path` (Optional): Subdirectory path (e.g. `handlers`) - **Example**: ```http GET /user_api.php?action=list_files&bot_id=10&path= ``` ##### Read File Content - **Action**: `read_file` - **Parameters**: - `bot_id`: Target Bot ID - `file`: Relative file path (e.g. `index.php` or `config.php`) - **Example**: ```http GET /user_api.php?action=read_file&bot_id=10&file=index.php ``` ##### Write / Save Code - **Action**: `write_file` - **Method**: `POST` - **Parameters**: - `bot_id`: Target Bot ID - `file`: Relative file path - `content`: Code or file content - **Features**: Automatic PHP syntax lint checking before saving; storage quota validation. ##### Create New File - **Action**: `create_file` - **Parameters**: `bot_id`, `name`, `path` (optional), `content` (optional) ##### Create New Folder - **Action**: `create_folder` - **Parameters**: `bot_id`, `name`, `path` (optional) ##### Delete File or Folder - **Action**: `delete_file` - **Parameters**: `bot_id`, `file` ##### Rename File or Folder - **Action**: `rename_file` - **Parameters**: `bot_id`, `old_path`, `new_name` --- #### 5. Environment Variables (.env) ##### Get Bot Environment Variables - **Action**: `get_env` - **Parameters**: `bot_id` - **Response**: ```json { "ok": true, "variables": { "DB_NAME": "storage/database.db", "API_SECRET": "secret123" }, "raw": "DB_NAME=\"storage/database.db\"\nAPI_SECRET=\"secret123\"\n", "count": 2 } ``` ##### Set / Update Environment Variables - **Action**: `set_env` - **Method**: `POST` - **Parameters**: - `bot_id`: Target Bot ID - `variables`: Key-value JSON object OR `content` as raw text string --- #### 6. Cron Jobs Automation ##### List Cron Jobs - **Action**: `list_crons` - **Parameters**: `bot_id` ##### Create Cron Job - **Action**: `create_cron` - **Method**: `POST` - **Parameters**: - `bot_id`: Target Bot ID - `script_path`: Relative PHP script path (e.g. `cron.php` or `tasks/backup.php`) - `name`: Descriptive job name - `interval_type`: `minutes`, `hourly`, `daily`, `weekly`, or `monthly` - `interval_minutes`: Interval duration if `interval_type` is `minutes` ##### Toggle Cron Job (Enable/Disable) - **Action**: `toggle_cron` - **Parameters**: `bot_id`, `cron_id` ##### Run Cron Job Now - **Action**: `run_cron` - **Parameters**: `bot_id`, `cron_id` - **Returns**: Immediate output and execution logs. ##### Delete Cron Job - **Action**: `delete_cron` - **Parameters**: `bot_id`, `cron_id` --- #### 7. Database Operations (SQLite) Every bot has an isolated, high-speed SQLite database located at `storage/database.db`. ##### Get Database Schema & Tables - **Action**: `db_info` - **Parameters**: `bot_id` - **Response**: Tables, column names, column types, row counts, and file size. ##### Execute Database Query - **Action**: `db_query` - **Method**: `POST` - **Parameters**: - `bot_id`: Target Bot ID - `query`: SQL query statement (e.g. `SELECT * FROM users WHERE chat_id = ?`) - `params` (Optional): Prepared statement parameters array - **Security**: Strictly sandboxed to the target bot's `database.db`. Host-level SQLite injection commands (e.g. `ATTACH`) are blocked. --- #### 8. Broadcast Studio ##### Get Broadcast Statistics - **Action**: `broadcast_stats` - **Parameters**: `bot_id` - **Response**: Total subscribers, active users in last 7 days, and recent broadcast history. ##### Launch Broadcast Message - **Action**: `send_broadcast` - **Method**: `POST` - **Parameters**: - `bot_id`: Target Bot ID - `message`: Message text (supports HTML/Markdown formatting) - `audience`: `all` or `active7d` - `photo_url` (Optional): Image URL to attach - `keyboard` (Optional): Inline button matrix --- #### 9. Bot Marketplace / Store ##### List Marketplace Bots - **Action**: `list_store` - **Parameters**: `search`, `category`, `price_type` (`all`, `free`, `paid`), `page` ##### Get Store Bot Details & Reviews - **Action**: `store_details` - **Parameters**: `store_id` ##### Install Store Bot - **Action**: `install_store_bot` - **Method**: `POST` - **Parameters**: `store_id`, `token` (New BotFather token), `admin_chat_id` --- #### 10. Bot Code Transfer System Securely transfer bot source code between registered users without sharing credentials (`.env` keys and `database.db` are automatically sanitized and kept private). ##### Create Bot Transfer - **Action**: `create_transfer` - **Method**: `POST` - **Parameters**: - `bot_id`: Bot ID to transfer - `target_recipient`: Telegram `@username` or numeric user ID of recipient - **Returns**: A secure 72-hour transfer code (`TR-XXXX-XXXX`). - **Example Body**: ```json { "action": "create_transfer", "bot_id": 12, "target_recipient": "@developer_user" } ``` ##### List Transfers (Incoming & Outgoing) - **Action**: `list_transfers` or `transfers` - **Returns**: Pending incoming offers to accept and outgoing transfers you created. ##### Get Transfer Details - **Action**: `get_transfer` - **Parameters**: `transfer_code` - **Returns**: Transfer status, bot name, sender handle, expiration timestamp. ##### Accept Bot Transfer - **Action**: `accept_transfer` - **Method**: `POST` - **Parameters**: - `transfer_code`: Transfer code (e.g. `TR-12-34AB56CD`) - `token`: Your new Telegram bot token from @BotFather - `admin_chat_id` (Optional): Admin Telegram ID ##### Reject Bot Transfer - **Action**: `reject_transfer` - **Method**: `POST` - **Parameters**: `transfer_id` (Numeric ID from `list_transfers`) --- #### 11. Bot Building, Scaffolding, Validation & Webhook Testing ##### Get Bot Making Guide & Styled Keyboard Documentation - **Action**: `bot_making_docs` or `get_bot_making_docs` - **Method**: `GET` / `POST` - **Parameters**: `section` (Optional: `keyboards`, `database`, `cron`, `broadcast`, `errors`, `examples`) - **Returns**: Full markdown guide and button color mapping reference. ##### Scaffold Bot Code Boilerplate - **Action**: `scaffold_bot` or `scaffold_bot_code` - **Method**: `GET` / `POST` - **Parameters**: - `type` (Optional: `styled_keyboard` [default], `database_bot`, `shop_bot`) - `bot_name` (Optional: e.g. `"CryptoTradeBot"`) - **Returns**: Complete, production-ready, linted PHP source code with styled buttons. ##### Install Scaffold to Hosted Bot - **Action**: `install_scaffold` or `install_bot_scaffold` - **Method**: `POST` - **Parameters**: - `bot_id`: Target hosted bot ID or username - `type`: Boilerplate type (`styled_keyboard`, `database_bot`, `shop_bot`) - **Returns**: Overwrites `index.php` with the chosen scaffold and prepares storage. ##### Validate Bot PHP Code (Syntax & Lint Check) - **Action**: `validate_code` or `validate_bot_code` - **Method**: `POST` - **Parameters**: - `code`: Raw PHP code string to lint - **Returns**: Syntax verification result, detects missing semicolons, unbalanced brackets, syntax errors before deploying. ##### Simulate Webhook Update (Local Sandbox Test) - **Action**: `test_webhook` or `test_bot_webhook` - **Method**: `POST` - **Parameters**: - `bot_id`: Target hosted bot ID or username - `update` (Optional): Simulated Telegram Update JSON object (defaults to `/start` message) - **Returns**: Captures output buffered by `index.php`, HTTP response code, and fresh errors from `error.log`. ##### 🎨 Styled Keyboard Colors Reference Telegram Mini Apps and modern Telegram bot clients support button style attributes: | Style | Color | Use Cases | | :--- | :--- | :--- | | `primary` | **Blue** 🔵 | Main Actions, Launch App, Next, Open Menu, Confirm | | `success` | **Green** 🟢 | Buy Now, Deposit, Pay, Approve, Activate | | `danger` | **Red** 🔴 | Delete, Cancel, Reset, Reject, Stop | ```php // Inline Keyboard with Styles: $inlineKeyboard = [ 'inline_keyboard' => [ [ ['text' => '🚀 Launch App', 'callback_data' => 'launch', 'style' => 'primary'], // Blue ['text' => '💳 Buy VIP', 'callback_data' => 'buy', 'style' => 'success'] // Green ], [ ['text' => '❌ Cancel', 'callback_data' => 'cancel', 'style' => 'danger'] // Red ] ] ]; $reply_markup = json_encode($inlineKeyboard); // Reply Keyboard with Styles: $replyKeyboard = [ 'keyboard' => [ [ ['text' => '🟢 Activate Service', 'style' => 'success'], ['text' => '🔵 Account Dashboard', 'style' => 'primary'] ], [ ['text' => '🔴 Terminate Session', 'style' => 'danger'] ] ], 'resize_keyboard' => true ]; $reply_markup = json_encode($replyKeyboard); ``` --- #### 12. Botlify Knowledge Base & Documentation Engine (NEW) ##### 1. About Botlify Cloud (`action=about_botlify` or `action=about`) Returns complete A-to-Z overview of Botlify Cloud architecture, runtime, SQLite WAL engine, webhook lifecycle, key features, and developer rules. Publicly accessible without API key. - **Request:** `GET https://botlify.cloud/user_api.php?action=about_botlify` - **Response:** ```json { "ok": true, "platform": { "name": "Botlify Cloud", "domain": "botlify.cloud", "tagline": "Enterprise Serverless Telegram Bot Hosting..." }, "architecture": { ... }, "how_it_works": { ... }, "key_features": { ... }, "developer_rules": { ... } } ``` ##### 2. Get Full Documentation (`action=get_full_docs` or `action=full_docs`) Retrieves the complete, unabridged master developer documentation (`docs/docs.md`, 1.08MB+, 14 chapters, all 203 methods & 401 types). Supports optional `offset` and `limit` for chunking. - **Request:** `GET https://botlify.cloud/user_api.php?action=get_full_docs` `GET https://botlify.cloud/user_api.php?action=get_full_docs&offset=0&limit=5000` - **Response:** ```json { "ok": true, "title": "Botlify Cloud — Master Production Developer Documentation...", "source": "docs/docs.md", "total_bytes": 1082293, "total_lines": 21500, "content": "# Botlify Cloud — Master Production..." } ``` ##### 3. List Documentation Topics (`action=list_docs` or `action=docs`) Returns all 638 documentation topics, categorized guides, Telegram Bot API methods, and types with their read times and canonical URLs. - **Request:** `GET https://botlify.cloud/user_api.php?action=list_docs` - **Response:** ```json { "ok": true, "total_docs": 638, "categories_summary": { ... }, "docs": [ { "id": "sendmessage", "title": "sendMessage", "category": "Telegram Bot API — Methods (A-Z)", "subtitle": "Send text messages with parse_mode and keyboards...", "url": "https://docs.botlify.cloud/sendmessage" } ] } ``` ##### 4. Search Documentation (`action=search_docs` or `action=search`) Performs scored keyword/phrase search across all documentation articles and methods with snippet extraction. - **Request:** `GET https://botlify.cloud/user_api.php?action=search_docs&query=sendMessage&max_results=5` - **Parameters:** - `query` (required): Search keyword or phrase. - `max_results` (optional, default 10, max 50): Number of matches to return. - **Response:** ```json { "ok": true, "query": "sendMessage", "max_results": 5, "matched_count": 20, "results_count": 5, "results": [ { "id": "sendmessage", "title": "sendMessage", "category": "Telegram Bot API — Methods (A-Z)", "snippet": "Use this method to send text messages...", "url": "https://docs.botlify.cloud/sendmessage" } ] } ``` --- ### 💻 Code Examples #### 1. cURL ```bash curl -s -H "X-API-KEY: fbh_usr_your_api_key_here" \ "https://your-domain.com/user_api.php?action=list_bots" curl -s -H "X-API-KEY: fbh_usr_your_api_key_here" \ "https://your-domain.com/user_api.php?action=read_file&bot_id=1&file=index.php" curl -s -X POST "https://your-domain.com/user_api.php" \ -H "X-API-KEY: fbh_usr_your_api_key_here" \ -H "Content-Type: application/json" \ -d '{ "action": "write_file", "bot_id": 1, "file": "index.php", "content": "• `1` / `short`: Analytics URL + Shortener (Compact URL on button)
• `2` / `analytics`: Analytics URL Only (`https://digibd.store/.../click.php?tid=...`)
• `3` / `direct`: Direct Real Link (User's original destination link, CPM N/A) | | `target` | string | No | `bots` | Audience Scope:
• `bots`: Users of all active hosted bots
• `bot_owners`: Creators/owners of hosted bots
• `platform`: Users of the main root host bot
• `users`: Specific Telegram Chat IDs | | `adid` | string | No | `ad_{time}_{rand}` | Custom alphanumeric Campaign/Ad ID for tracking (e.g. `summer_sale_01`). | | `limit` | integer | No | `-1` | **Target Delivery Quota**:
• `-1` (default): Send to **all available** matching users in the network.
• `0`: **Invalid** (returns `400 Bad Request`, minimum limit is 1).
• `> 0` (e.g. `500`): Limit delivery to exact user count. If requested limit exceeds total available matching users, the request is **rejected** with a `400 Bad Request` and returns `max_allowed_limit`. | | `active` | string | No | `""` (All) | Filter activity: `today` / `24h` / `1d`, `3d`, `7d`, `30d` / `1m`, `3m`, or `older`. | | `joined` | string | No | `""` (All) | Filter registration date: `today`, `3d`, `7d`, `30d`. | | `language` | string | No | `""` (All) | Language filter: `en`, `bn`, or comma-separated list `en,bn,hi,ru`. | | `bot` | string | No | `""` | Target specific bot(s) by @username or bot ID (comma-separated supported). | | `deduplicate` | boolean | No | `true` | When `true` (default), ensures each Telegram user receives only 1 message across all bots. | | `clean_blocked`| boolean | No | `true` | When `true` (default), automatically detects & prunes dead/blocked accounts from DB. When `false`, retains dead accounts in DB. | | `user_ids` | string | No | `""` | Comma- or newline-separated Chat IDs (used when `target=users`). | | `parse_mode` | string | No | `HTML` | Message formatting mode:
• `HTML` (default): `bold`, `italic`, `code`, `link`
• `Markdown` / `md`: `*bold*`, `_italic_`, `` `code` ``, `[link](url)`
• `MarkdownV2` / `md2`: Advanced Telegram MarkdownV2 (`*bold*`, `_italic_`, `~strike~`, `\|\|spoiler\|\|`)
• `None` / `plain`: Plain text (formatting tags disabled) | | `media_type` | string | No | `""` | Optional media: `photo`, `video`, `gif`, `animation`, `document`. | | `media_file_id`| string | No | `""` | Telegram `file_id` or public `http://` / `https://` direct media URL. | | `buttons` | array/string | No | `""` | Inline keyboard JSON array / string. | | `inline_keyboard_builder` | string | No | `""` | Friendly button syntax: `Label \| URL` (comma for columns, newline for rows). | --- ##### Multi-Format Button Examples: **Option A: JSON Array (Recommended for API integration)**: ```json "buttons": [ [{"text": "🔥 Claim 50% Off", "url": "https://digibd.store/deal"}], [{"text": "🤖 Start Bot", "url": "https://t.me/mybot"}, {"text": "💬 Support", "url": "https://t.me/support"}] ] ``` **Option B: Friendly Text Builder (Recommended for quick forms)**: ```text inline_keyboard_builder=🔥 Claim 50% Off | https://digibd.store/deal 🤖 Start Bot | https://t.me/mybot , 💬 Support | https://t.me/support ``` --- ##### Request Examples: ##### cURL (Option 1: Analytics + ulvis.net Short URL): ```bash curl -X POST "https://digibd.store/mybot/tgbothosts/brocast_api.php" \ -H "Content-Type: application/json" \ -H "X-API-KEY: SPDEV_BROCAST" \ -d '{ "action": "create", "adid": "promo_premium_sale", "link_mode": 1, "target": "bots", "active": "today", "limit": 500, "parse_mode": "HTML", "text": "🚀 MEGA PROMO ALERT!", "buttons": [ [{"text": "💬 Contact Support", "url": "https://t.me/sujoypaul"}] ] }' ``` ##### cURL (Option 2: Analytics URL Only): ```bash curl -X POST "https://digibd.store/mybot/tgbothosts/brocast_api.php" \ -H "Content-Type: application/json" \ -H "X-API-KEY: SPDEV_BROCAST" \ -d '{ "action": "create", "adid": "promo_analytics_only", "link_mode": 2, "target": "bots", "text": "📊 Check our analytics broadcast!", "buttons": [ [{"text": "📊 View Offer", "url": "https://digibd.store/offer"}] ] }' ``` ##### cURL (Option 3: Direct Real Link): ```bash curl -X POST "https://digibd.store/mybot/tgbothosts/brocast_api.php" \ -H "Content-Type: application/json" \ -H "X-API-KEY: SPDEV_BROCAST" \ -d '{ "action": "create", "adid": "direct_announcement", "link_mode": 3, "target": "bots", "text": "📰 Read our latest blog post!", "buttons": [ [{"text": "📖 Read Now", "url": "https://digibd.store/blog/post"}] ] }' ``` ##### Response Example (Successful Campaign Creation): ```json { "ok": true, "job_id": 5, "adid": "promo_premium_sale", "link_mode": 1, "link_mode_name": "Analytics + Short URL (ulvis.net)", "deduplicate": true, "deduplication_mode": "ON (1 message per unique user across all bots)", "clean_blocked": true, "auto_cleaning_mode": "ON (blocked accounts pruned from DB)", "available_matched_targets": 850, "requested_limit": 500, "queued_targets": 500, "processed_initial_chunk": 50, "status": "queued", "message": "Broadcast job created successfully." } ``` ##### Response Example (Insufficient Audience Rejection): ```json { "ok": false, "error": "Insufficient audience: You requested 1000 users, but only 450 matching users are available in the network. Maximum limit you can set is 450.", "available_targets": 450, "requested_limit": 1000, "max_allowed_limit": 450, "is_sufficient": false } ``` --- #### 3.3 Action: `overview` or `status` (Campaign Analytics & Performance) Fetches live progress, delivery numbers, blocked account prunings, unique clicks, raw hits, Click-Through Rate (CTR), top devices, and top countries for a campaign. * **URL**: `https://digibd.store/mybot/tgbothosts/brocast_api.php?action=overview` * **Method**: `GET` or `POST` ##### Request Parameters: | Parameter | Type | Required | Description | | :--- | :--- | :--- | :--- | | `api_key` | string | Yes | Must be `SPDEV_BROCAST`. | | `adid` | string | No | The custom Campaign/Ad ID (e.g. `promo_premium_sale`). | | `job_id` | integer | No | The internal broadcast job ID (e.g. `5`). | *Either `adid` or `job_id` must be provided.* ##### Request Example (cURL): ```bash curl "https://digibd.store/mybot/tgbothosts/brocast_api.php?api_key=SPDEV_BROCAST&action=overview&adid=promo_premium_sale" ``` ##### Response Example (Option 1 & 2 - Tracked Campaign): ```json { "ok": true, "job": { "id": 5, "adid": "promo_premium_sale", "scope": "bots", "link_mode": 1, "link_mode_name": "Analytics + Short URL (ulvis.net)", "tracking_enabled": true, "status": "done", "sent": 500, "failed": 12, "total": 500, "blocked_cleaned": 12, "clicks": 68, "unique_clicks": 68, "raw_hits": 94, "ctr_percent": 13.6, "device_breakdown": { "Android": 42, "iOS": 18, "Windows": 8 }, "country_breakdown": { "BD": 45, "IN": 15, "US": 8 }, "text_preview": "🚀 MEGA PROMO ALERT!...", "media_type": "text", "created_at": 1787062954, "time_ago": "12 mins ago" } } ``` ##### Response Example (Option 3 - Direct Real Link Campaign): ```json { "ok": true, "job": { "id": 6, "adid": "direct_announcement", "scope": "bots", "link_mode": 3, "link_mode_name": "Direct Real Link", "tracking_enabled": false, "status": "done", "sent": 500, "failed": 8, "total": 500, "blocked_cleaned": 8, "clicks": "N/A", "unique_clicks": "N/A", "raw_hits": "N/A", "ctr_percent": "N/A", "tracking_notice": "Direct real link broadcast - click tracking and CPM analytics are not available for direct external URLs", "device_breakdown": {}, "country_breakdown": {}, "text_preview": "📰 Read our latest blog post!...", "media_type": "text", "created_at": 1787063500, "time_ago": "5 mins ago" } } ``` --- #### 3.4 Action: `stats` (Global Platform Statistics) Provides platform-wide metrics including total hosted bot registrations, unique human recipients, users active today, 7-day activity, and language distributions. * **URL**: `https://digibd.store/mybot/tgbothosts/brocast_api.php?action=stats` * **Method**: `GET` or `POST` ##### Request Example (cURL): ```bash curl "https://digibd.store/mybot/tgbothosts/brocast_api.php?api_key=SPDEV_BROCAST&action=stats" ``` ##### Response Example: ```json { "ok": true, "stats": { "platform_users": 1580, "platform_active_24h": 420, "hosted_bot_users_total": 92300, "unique_hosted_bot_users": 68400, "active_bot_users_today": 12850, "active_bot_users_7d": 41200, "active_bots_count": 12, "total_ad_clicks": 4820, "unique_ad_clicks": 3950, "top_languages": { "en": 34000, "bn": 28000, "hi": 6400 } } } ``` --- #### 3.5 Action: `shorten` (Standalone ulvis.net Shortener) Shortens any URL into a ulvis.net short link. * **URL**: `https://digibd.store/mybot/tgbothosts/brocast_api.php?action=shorten&url=https://example.com` * **Method**: `GET` or `POST` ##### Response Example: ```json { "ok": true, "shorturl": "https://ulvis.net/27snebtr", "original_url": "https://example.com" } ``` --- ### 7.4. 💻 Full Multi-Language Code Integration Examples #### Python (using `requests`) ```python import requests API_URL = "https://digibd.store/mybot/tgbothosts/brocast_api.php" API_KEY = "SPDEV_BROCAST" HEADERS = {"X-API-KEY": API_KEY, "Content-Type": "application/json"} estimate_payload = { "action": "estimate", "target": "bots", "active": "today", "language": "en,bn", "limit": 1000 } est = requests.post(API_URL, json=estimate_payload, headers=HEADERS).json() print("Audience Estimate:", est["audience"]) create_payload = { "action": "create", "adid": "black_friday_deals", "link_mode": 1, "target": "bots", "active": "today", "limit": 1000, "parse_mode": "HTML", "text": "🔥 BLACK FRIDAY SALE!\nGet up to 70% off on premium bot hosting slots today!", "buttons": [ [{"text": "🔥 Shop Deals Now", "url": "https://digibd.store/deals"}], [{"text": "🎁 Claim Bonus", "url": "https://digibd.store/bonus"}] ] } res = requests.post(API_URL, json=create_payload, headers=HEADERS).json() print("Campaign Created:", res) overview = requests.get(f"{API_URL}?api_key={API_KEY}&action=overview&adid=black_friday_deals").json() print("Campaign Stats:", overview["job"]) ``` --- #### Node.js / JavaScript (using `fetch`) ```javascript const API_URL = "https://digibd.store/mybot/tgbothosts/brocast_api.php"; const API_KEY = "SPDEV_BROCAST"; async function runAdCampaign() { // 1. Audience Estimation const estRes = await fetch(API_URL, { method: "POST", headers: { "Content-Type": "application/json", "X-API-KEY": API_KEY }, body: JSON.stringify({ action: "estimate", target: "bots", active: "today", limit: 500 }) }); const estData = await estRes.json(); console.log("Reachable Audience:", estData.audience); // 2. Launch Campaign const createRes = await fetch(API_URL, { method: "POST", headers: { "Content-Type": "application/json", "X-API-KEY": API_KEY }, body: JSON.stringify({ action: "create", adid: "summer_special_2026", link_mode: 1, // 1: ulvis.net + Track, 2: Track Only, 3: Direct Link target: "bots", active: "today", limit: 500, parse_mode: "HTML", text: "⚡ Exclusive VIP Hosting Offer!\nFast servers and 99.9% uptime guaranteed.", buttons: [ [{ text: "⚡ Get Started", url: "https://digibd.store/vip" }] ] }) }); const createData = await createRes.json(); console.log("Broadcast Launched:", createData); // 3. Check Live Performance const overviewRes = await fetch(`${API_URL}?api_key=${API_KEY}&action=overview&adid=summer_special_2026`); const overviewData = await overviewRes.json(); console.log("Campaign Stats:", overviewData.job); } runAdCampaign(); ``` --- #### PHP (cURL Example) ```php 'create', 'adid' => 'php_campaign_01', 'link_mode' => 1, // 1: ulvis.net + Analytics, 2: Analytics URL Only, 3: Direct Real Link 'target' => 'bots', 'active' => 'today', 'language' => 'en,bn', 'limit' => 250, 'parse_mode' => 'HTML', 'text' => "🚀 Hello from PHP!\nCheck out our special bot hosting deals!", 'buttons' => [ [['text' => '🔥 Claim Deal', 'url' => 'https://digibd.store/deal']] ] ]; $ch = curl_init($apiUrl); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_HTTPHEADER => [ "Content-Type: application/json", "X-API-KEY: $apiKey" ], CURLOPT_POSTFIELDS => json_encode($payload) ]); $res = curl_exec($ch); curl_close($ch); print_r(json_decode($res, true)); ``` --- ### 7.5. ⚠️ Error Responses & Troubleshooting If an invalid request, insufficient audience (with strict limit), or invalid key is supplied, the API returns a structured JSON error: ```json { "ok": false, "error": "Unauthorized: Invalid API Key" } ``` | HTTP Code | Error Message | Solution / Cause | | :--- | :--- | :--- | | `403 Forbidden` | `Unauthorized: Invalid API Key` | Check that `api_key=SPDEV_BROCAST` or `X-API-KEY: SPDEV_BROCAST` is correctly passed. | | `400 Bad Request` | `Missing parameter: text` | Ensure `text` message body is included in the `action=create` request. | | `400 Bad Request` | `No target users match the specified filters.` | Your audience filter criteria matched 0 users. Check language or bot settings. | | `400 Bad Request` | `Insufficient audience: You requested X users, but only Y matching users are available...` | Returned when requested `limit` exceeds available matching audience. Request is rejected to prevent payment under-delivery. Set `limit <= Y`. | | `400 Bad Request` | `Missing parameter: job_id or adid` | Supply either `adid` or `job_id` when calling `overview` or `status`. | | `404 Not Found` | `Job or Ad ID not found` | Verify that the specified `adid` or `job_id` exists in the system. | --- ## 8. 📰 Botlify Engineering Blog Engine & Blog REST API (blog/api.php) The **Botlify Blog REST API** allows developers, Telegram bots, automated scripts, and CI/CD pipelines to programmatically read, publish, edit, and manage blog articles and categories on Botlify Cloud. --- ### 🔑 Authentication Every request to the Blog API requires authentication using your **Blog API Key**. You can view or regenerate your API Key inside the **[Blog Studio Settings](https://botlify.cloud/blog/admin/?action=settings)**. Authentication can be passed in any of the following 3 ways: #### 1. HTTP Header (Recommended) ```http X-Blog-Api-Key: btl_your_secret_api_key_here ``` #### 2. Bearer Token Header ```http Authorization: Bearer btl_your_secret_api_key_here ``` #### 3. Query / Body Parameter (Fallback) ```http https://botlify.cloud/blog/api.php?api_key=btl_your_secret_api_key_here&action=... ``` --- ### 🌐 Base Endpoint ``` POST/GET https://botlify.cloud/blog/api.php ``` All responses are returned in JSON format with standard HTTP status codes: - `200 OK` / `201 Created`: Request succeeded. - `400 Bad Request`: Missing or invalid parameters. - `401 Unauthorized`: Missing or incorrect API key. - `404 Not Found`: Post or resource does not exist. - `500 Server Error`: Database or internal exception. --- ### 📋 Endpoints & Actions Summary | Action | HTTP Method | Description | | :--- | :--- | :--- | | `get_stats` | `GET` / `POST` | Retrieve total posts, published, drafts, views, categories, tags | | `get_posts` | `GET` / `POST` | Fetch paginated list of posts with category, tag, or search filters | | `get_post` | `GET` / `POST` | Retrieve a single post by `slug` or `id` | | `create_post` | `POST` | Publish or draft a new article with Markdown & SEO metadata | | `update_post` | `POST` | Update an existing post by `post_id` or `slug` | | `delete_post` | `POST` | Permanently delete a post by `post_id` | | `get_categories` | `GET` / `POST` | Get list of all categories with post counts | | `upload_image` | `POST` | Upload an image file (PNG, JPG, WEBP, GIF, SVG) | --- ### 8.1. Get Blog Statistics Fetch overall analytics including total published posts, drafts, and views. #### Request: ```http GET https://botlify.cloud/blog/api.php?action=get_stats X-Blog-Api-Key: btl_your_secret_key ``` #### Response (`200 OK`): ```json { "ok": true, "stats": { "total_posts": 12, "published_posts": 10, "draft_posts": 2, "total_views": 15420, "categories_count": 4, "tags_count": 18 } } ``` --- ### 8.2. List Articles (`get_posts`) Fetch a paginated list of articles. #### Request Parameters: | Parameter | Type | Required | Default | Description | | :--- | :--- | :--- | :--- | :--- | | `action` | string | **Yes** | `get_posts` | Action name | | `page` | integer | No | `1` | Page number | | `limit` | integer | No | `10` | Posts per page (max: 50) | | `category` | string | No | `null` | Filter by category slug | | `tag` | string | No | `null` | Filter by tag slug | | `search` | string | No | `null` | Keyword search in title, excerpt, content | | `include_drafts`| boolean | No | `false` | Include draft posts (1 or true) | #### Example cURL: ```bash curl -X GET "https://botlify.cloud/blog/api.php?action=get_posts&limit=5&category=guides-tutorials" \ -H "X-Blog-Api-Key: btl_your_secret_key" ``` #### Response (`200 OK`): ```json { "ok": true, "posts": [ { "id": 1, "title": "How to Host a Telegram Bot 24/7 for Free: Complete Developer Guide (2026)", "slug": "how-to-host-telegram-bot-free-24-7", "excerpt": "Learn how to deploy, host, and keep your Telegram bot running 24/7 online for free...", "cover_image": "https://images.unsplash.com/photo-1618005182384-a83a8bd57fbe", "category_id": 1, "category_name": "Guides & Tutorials", "category_slug": "guides-tutorials", "author_name": "Botlify Cloud Team", "status": "published", "views": 1420, "is_featured": 1, "reading_time": 4, "created_at": 1740000000, "updated_at": 1740000000 } ], "total": 1, "limit": 5, "offset": 0, "total_pages": 1, "current_page": 1 } ``` --- ### 8.3. Get Single Article (`get_post`) Fetch full post details including raw Markdown content, tags, and canonical URL. #### Request: ```bash curl -X GET "https://botlify.cloud/blog/api.php?action=get_post&slug=how-to-host-telegram-bot-free-24-7" \ -H "X-Blog-Api-Key: btl_your_secret_key" ``` #### Response (`200 OK`): ```json { "ok": true, "post": { "id": 1, "title": "How to Host a Telegram Bot 24/7 for Free: Complete Developer Guide (2026)", "slug": "how-to-host-telegram-bot-free-24-7", "excerpt": "Learn how to deploy, host, and keep your Telegram bot running 24/7...", "content": "# How to Host a Telegram Bot 24/7 for Free...", "cover_image": "https://images.unsplash.com/photo-1618005182384-a83a8bd57fbe", "category_name": "Guides & Tutorials", "category_slug": "guides-tutorials", "author_name": "Botlify Cloud Team", "status": "published", "views": 1421, "is_featured": 1, "reading_time": 4, "meta_title": "How to Host a Telegram Bot 24/7 for Free (2026 Guide) | Botlify Blog", "meta_description": "Complete step-by-step developer guide on hosting a 24/7 Telegram bot...", "meta_keywords": "host telegram bot free, telegram bot 24/7, botlify", "created_at": 1740000000, "tags": [ { "id": 1, "name": "telegram-bot", "slug": "telegram-bot" }, { "id": 2, "name": "bot-hosting", "slug": "bot-hosting" } ], "url": "https://botlify.cloud/blog/how-to-host-telegram-bot-free-24-7" } } ``` --- ### 8.4. Create Article (`create_post`) Publish a new article with Markdown formatting, custom SEO tags, and categories. #### Payload Fields: | Field | Type | Required | Description | | :--- | :--- | :--- | :--- | | `title` | string | **Yes** | Article title | | `content` | string | **Yes** | Article body in Markdown or HTML | | `slug` | string | No | Custom URL slug (auto-generated from title if omitted) | | `excerpt` | string | No | Short summary for cards and search snippets | | `category_id` | integer | No | Numerical category ID | | `category_slug`| string | No | Category slug (e.g. `telegram-bot-api`) | | `cover_image` | string | No | Cover image URL | | `author_name` | string | No | Author display name (Default: `Botlify Team`) | | `status` | string | No | `published` (default) or `draft` | | `is_featured` | integer | No | `1` for featured hero card, `0` otherwise | | `tags` | string/array | No | Comma-separated tags or array (e.g. `"php, bot, webhooks"`) | | `meta_title` | string | No | Custom title tag for Google SEO | | `meta_description` | string | No | Custom meta description tag | | `meta_keywords` | string | No | Comma-separated SEO keywords | #### Example cURL (JSON): ```bash curl -X POST "https://botlify.cloud/blog/api.php" \ -H "Content-Type: application/json" \ -H "X-Blog-Api-Key: btl_your_secret_key" \ -d '{ "action": "create_post", "title": "Deploying Telegram Mini Apps with Botlify Cloud", "excerpt": "A complete guide to hosting interactive HTML5 Telegram Mini Apps with SSL.", "category_slug": "telegram-bot-api", "cover_image": "https://images.unsplash.com/photo-1551288049-bebda4e38f71", "author_name": "Developer Advocate", "status": "published", "is_featured": 1, "tags": "miniapp, telegram, webhooks, javascript", "content": "# Deploying Telegram Mini Apps\n\nTelegram Mini Apps allow you to build rich JavaScript web apps inside Telegram chats.\n\n> [!TIP]\n> Botlify provides instant HTTPS for your Mini App webviews.\n\n```javascript\nwindow.Telegram.WebApp.ready();\n```" }' ``` #### Response (`201 Created`): ```json { "ok": true, "message": "Post created successfully.", "post_id": 4, "slug": "deploying-telegram-mini-apps-with-botlify-cloud", "url": "https://botlify.cloud/blog/deploying-telegram-mini-apps-with-botlify-cloud" } ``` --- ### 8.5. Update Article (`update_post`) Update an existing article using either its `post_id` or `slug`. #### Example cURL: ```bash curl -X POST "https://botlify.cloud/blog/api.php" \ -H "Content-Type: application/json" \ -H "X-Blog-Api-Key: btl_your_secret_key" \ -d '{ "action": "update_post", "post_id": 4, "title": "Deploying Telegram Mini Apps with Botlify Cloud (Updated)", "status": "published" }' ``` #### Response (`200 OK`): ```json { "ok": true, "message": "Post updated successfully.", "post_id": 4, "slug": "deploying-telegram-mini-apps-with-botlify-cloud-updated", "url": "https://botlify.cloud/blog/deploying-telegram-mini-apps-with-botlify-cloud-updated" } ``` --- ### 8.6. Delete Article (`delete_post`) Permanently delete an article. #### Example cURL: ```bash curl -X POST "https://botlify.cloud/blog/api.php" \ -H "Content-Type: application/json" \ -H "X-Blog-Api-Key: btl_your_secret_key" \ -d '{ "action": "delete_post", "post_id": 4 }' ``` #### Response (`200 OK`): ```json { "ok": true, "message": "Post deleted successfully." } ``` --- ### 8.7. Upload Image (`upload_image`) Upload an image to Botlify Cloud storage (`/blog/uploads/`). #### Supported formats: `image/jpeg`, `image/png`, `image/webp`, `image/gif`, `image/svg+xml`. #### Example cURL: ```bash curl -X POST "https://botlify.cloud/blog/api.php?action=upload_image" \ -H "X-Blog-Api-Key: btl_your_secret_key" \ -F "image=@/path/to/my-cover.png" ``` #### Response (`200 OK`): ```json { "ok": true, "url": "https://botlify.cloud/blog/uploads/api_img_20261029_141500_a1b2c3d4.png", "path": "/blog/uploads/api_img_20261029_141500_a1b2c3d4.png" } ``` --- ### 8.8. Code Examples #### Python Example: Auto-Publishing a Blog Post ```python import requests API_URL = "https://botlify.cloud/blog/api.php" API_KEY = "btl_your_secret_api_key_here" headers = { "X-Blog-Api-Key": API_KEY, "Content-Type": "application/json" } payload = { "action": "create_post", "title": "Automated Deployment of Python Telegram Bots", "excerpt": "How to deploy Python Telegram bots with webhooks.", "category_slug": "telegram-bot-api", "tags": "python, bot, telegram, webhooks", "content": """# Python Bot Deployment Guide Here is how to set up Python webhook bots: ```python import telebot bot = telebot.TeleBot("YOUR_TOKEN") ``` All requests are handled seamlessly on Botlify Cloud. """, "status": "published" } response = requests.post(API_URL, json=payload, headers=headers) print(response.json()) ``` --- #### PHP Example: Publishing via Telegram Bot Command ```php true, CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ 'Content-Type: application/json', 'X-Blog-Api-Key: btl_your_secret_api_key_here' ], CURLOPT_POSTFIELDS => json_encode([ 'action' => 'create_post', 'title' => $title, 'content' => $body, 'status' => 'published' ]) ]); $res = json_decode(curl_exec($ch), true); curl_close($ch); if (!empty($res['ok'])) { sendMessage($chatId, "✅ Post published successfully!\n🔗 " . $res['url']); } else { sendMessage($chatId, "❌ Failed to publish: " . ($res['error'] ?? 'Unknown error')); } } ``` --- ### 🔒 Security Best Practices 1. **Protect Your API Key:** Never commit your `btl_...` API key into public git repositories or share it with unauthorized users. 2. **Rotate Keys Regularly:** If a key is compromised, immediately click **Regenerate API Key** in [Blog Settings](https://botlify.cloud/blog/admin/?action=settings). 3. **Use HTTPS:** Always connect via `https://` to ensure authentication headers and payload contents remain encrypted in transit. --- ## 9. 📦 GitHub Automated Cloud Backup Engine (includes/github_backup.php) Botlify Cloud features an enterprise automated cloud backup system designed to keep platform databases and file directories safely synchronized to a private GitHub repository on a scheduled interval. ### 🌟 Core Architectural Features 1. **Native MySQL Database Streaming Dumper (`github_backup_export_database`):** - Connects directly to the MySQL database configured in `config.php` (`DB_HOST`, `DB_NAME`, `DB_USER`, `DB_PASS`). - Streams complete table schemas (`SHOW CREATE TABLE`) and data (`INSERT INTO ... VALUES (...)`) directly to `database.sql`. - Pure PHP PDO streaming engine requiring **zero external `mysqldump` CLI dependencies**. - Transaction-safe with `SET FOREIGN_KEY_CHECKS=0;`, `SET AUTOCOMMIT=0;`, and `COMMIT;`. 2. **Selective Target Archiving (6 Configurable Targets):** - `database.sql`: MySQL live database export. - `ad_delete/`: Archived and soft-deleted bot scripts. - `assets/`: Platform stylesheets, JavaScript bundles, icons, and media files. - `blog/`: Full blog engine, Studio Admin, REST API, guides, and uploads. - `recycle/`: Platform recycle bin holding deleted bot workspaces. - `storage/`: User bot workspaces, sandboxes, and child SQLite databases (with recursion guards). 3. **Self-Healing Git Lock Recovery (`github_backup_clear_git_locks`):** - Automatically detects and unlinks any stale `.git/index.lock`, `HEAD.lock`, or `config.lock` before every Git stage (`git add`, `git commit`, `git push`). - If Git CLI ever throws `fatal: Unable to create 'index.lock': File exists`, the engine automatically clears the lock and retries the command smoothly. 4. **Central Master Cron Integration (`cron.php`):** - Hooked directly into the 1-minute central master cron runner (`cron.php`). - Configurable recurring intervals: Every 1 Hour, 2 Hours, 3 Hours, 6 Hours (Default), 12 Hours, 24 Hours, 48 Hours, or 72 Hours ("koy hour por por"). - Executes non-interactively in the background without blocking bot webhook execution. 5. **Security & Token Masking:** - GitHub Personal Access Tokens (PAT) are masked in all execution logs and diagnostic outputs (`ghp_••••••••••••`). - Staging directory (`storage/.github_backup/`) is strictly ignored in the root `.gitignore` to prevent recursive repository bloat. --- ## 10. 🤖 Real-Time Dynamic LLMs.txt & AI Context Discovery (llms.php) Botlify Cloud implements the open **https://llmstxt.org** standard to provide real-time, curated Markdown documentation to modern AI agents (Cursor, Windsurf, Claude 3.7 Sonnet, ChatGPT 4o, Google Gemini, Perplexity, Copilot, DeepSeek). ### Key Architectural Capabilities - **Real-Time Dynamic Serving via Apache Rewrite:** - `https://botlify.cloud/llms.txt` ➔ Dynamic standard index (`llms.php`) - `https://botlify.cloud/llms-full.txt` ➔ Complete uncompressed knowledge base (`llms.php?mode=full`) - `https://botlify.cloud/blog/llms.txt` ➔ Dedicated blog engineering publications index (`llms.php?scope=blog`) - **Live Database Querying:** Whenever an article is published or updated in the Blog Studio, `llms.php` immediately queries MySQL and serves the latest titles, slugs, reading times, categories, and direct REST API endpoints without requiring manual documentation rebuilds. - **Conditional HTTP 304 Caching:** Emits `ETag` and `Cache-Control: public, max-age=120, stale-while-revalidate=60` headers, allowing AI crawlers to retrieve documentation at sub-10ms latency while keeping server load negligible. - **Dual-Layer Disk Synchronization:** Whenever a blog post is saved or deleted, `botlify_sync_llms_files()` updates the static `llms.txt` and `llms-full.txt` fallbacks on disk. --- ## 11. 🗺️ Dynamic Real-Time XML Sitemaps & Discovery (sitemap.php) Botlify Cloud provides real-time XML sitemaps and RSS 2.0 syndication feeds to guarantee instant search engine indexing and AI agent discoverability. - **Platform Dynamic Sitemap:** `https://botlify.cloud/sitemap.xml` (rewritten to `sitemap.php`). Queries MySQL in real-time for all core pages, blog categories, and published articles. - **Blog Dynamic Sitemap:** `https://botlify.cloud/blog/sitemap.xml` (via `blog/index.php?sitemap=1`). Dedicated sitemap with exact `` timestamps and weekly ``. - **Blog RSS 2.0 Feed:** `https://botlify.cloud/blog/feed.xml` (via `blog/index.php?feed=rss`). Atom-linked RSS 2.0 syndication feed for newsletters, Telegram channels, and feed readers. - **Discovery Header Links:** Both `` and `` are declared in the HTML `` of all platform and blog pages. --- ## 12. ⚡ Complete Telegram Bot API Methods Reference (A-Z, 203 Methods) This section provides the complete reference for all Telegram Bot API methods. Every method includes full descriptions, parameter definitions, and native PHP 8.2+ code examples. ### 12.1. Telegram Bot API: Overview > How the Bot API works: requests, response envelope, webhooks vs polling, rate limits, formatting, and a map of the full method reference. The **Telegram Bot API** is an HTTPS-based interface for controlling Telegram bots. Every method in this reference is an HTTPS request to: ```php https://api.telegram.org/bot/METHOD_NAME ``` All method names are case-insensitive, and you can send parameters via URL query string, `application/json`, `application/x-www-form-urlencoded`, or `multipart/form-data`. Both GET and POST are supported. #### Response Envelope Every call returns a JSON object with the same envelope. Always check the `ok` flag before reading the result: ```php { "ok": true, "result": { /* method-specific payload */ } } ``` | Field | Type | Description | | --- | --- | --- | | ok | Boolean | True if the request succeeded | | result | Any | The method-specific payload (a User object, a Message, True, …) | | error_code | Integer | Present on failure — e.g. 400 (bad request), 401 (unauthorized), 429 (flood) | | description | String | Human-readable description of the error | | parameters | ResponseParameters | Optional hints, e.g. retry_after for flood control | #### Calling Methods on Botlify Cloud On Botlify Cloud your bot token is auto-injected as `BOT_TOKEN` in the per-bot `.env` file, and every bot ships with a global `bot()` helper that wraps the HTTP call and returns the decoded envelope: ```php ``` #### Sending Updates: Webhooks vs Long Polling There are two mutually exclusive ways to receive updates from Telegram. On Botlify Cloud, **webhooks** are the recommended and default mode — the platform registers, secures, and routes the HTTPS webhook for you automatically. | Mode | Method | Best For | | --- | --- | --- | | Webhook | setWebhook / deleteWebhook | Production — instant delivery, zero polling overhead. Diagnose with getWebhookInfo. | | Long polling | getUpdates | Local development and scripts without a public URL. | #### Rate Limits - **30 messages per second** overall per bot. Broadcast in batches to stay under it. - **~1 message per second** per chat (avoid bursts to the same chat). - **~20 messages per minute** in the same group or channel. - **Paid Broadcasts:** enable in @BotFather to raise the limit to **1,000 messages/second** for a fee of 0.1 Telegram Stars per message — pass `allow_paid_broadcast` on send methods. - On `429` responses, wait the `retry_after` seconds before retrying. #### Text Formatting Messages accept **HTML** or **MarkdownV2** parse modes via the `parse_mode` parameter, and supports `message_effect_id` for animated full-screen effects in private chats. See the [Full-Screen Message Effects](/message-effects) guide for effect IDs. #### Reference Directory The method reference below is grouped by task. Start with these entry points: | Sub-Group | What It Covers | Entry Point | | --- | --- | --- | | Auth & Session | Verify identity, log out, close the bot instance | getMe | | Updates & Webhooks | Receive updates, register webhooks | setWebhook | | Sending Messages & Media | All send* methods, forwards, copies, reactions, files | sendMessage | | Edit & Manage Messages | Edit text/media/live locations, delete, stop polls | editMessageText | | Callback, Inline & Mini Apps | Answer callbacks and inline queries, Web App flows | answerCallbackQuery | | Chat Management | Members, admins, permissions, photos, titles, pins | getChatMember | | Invites & Join Requests | Invite links, subscriptions, join request handling | createChatInviteLink | | Forum Topics | Create and manage forum topics | createForumTopic | | Bot Profile & Commands | Name, description, commands, menu button, admin rights | setMyCommands | | Stickers & Emoji Sets | Create and manage sticker sets | createNewStickerSet | | Payments & Telegram Stars | Invoices, receipts, Stars transactions and refunds | sendInvoice | | Gifts & Verification | Send gifts, verify users and chats | sendGift | | Business Accounts | Act on behalf of connected business accounts | getBusinessConnection | | Stories | Post and manage stories | postStory | | Games | Send games and submit scores | sendGame | | Telegram Passport | Report Passport data errors | setPassportDataErrors | | Managed Bots | Tokens and access for delegated bot management | getManagedBotToken | | Guides & Tutorials | Task-focused Botlify guides with production code | 60-Second Quickstart | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.2. addStickerToSet > Use this method to add a new sticker to a set created by the bot Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | User identifier of sticker set owner | | name | String | Yes | Sticker set name | | sticker | InputSticker | Yes | A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.3. Animated Message Reactions > React to incoming user messages with animated emojis (👍, 🔥, 🎉, ❤️, ⚡) using setMessageReaction. #### The setMessageReaction Method Telegram Bot API supports adding emoji reactions directly to user messages. This provides instant visual feedback before sending text replies. ```php function react(string|int $chatId, int $messageId, string $emoji = '👍', bool $isBig = true): array { return bot('setMessageReaction', [ 'chat_id' => $chatId, 'message_id' => $messageId, 'reaction' => [ ['type' => 'emoji', 'emoji' => $emoji] ], 'is_big' => $isBig ]); } // Usage Example on user message if (!empty($msg['text'])) { react($chatId, $msg['message_id'], '🔥', true); } ``` #### Popular Supported Emojis Standard Unicode emojis supported by Telegram reactions: 👍, 👎, ❤️, 🔥, 🎉, 🤩, 👏, 😁, 🤔, 🤯, 😱, 🤬, 💩, ⚡, 🍌, 🍓, 🍾. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.4. answerCallbackQuery > Use this method to send answers to callback queries sent from inline keyboards **Botlify Native Shorthand:** `tg_answer_cb($callbackQueryId, $text, $showAlert);` Dismisses button loading spinners instantly to avoid Telegram network timeouts. See [Native Helpers Guide](?page=tg-native-helpers). Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, *True* is returned. Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like `t.me/your_bot?start=XXXX` that open your bot with a parameter. Otherwise, you may use links like `t.me/your_bot?start=XXXX` that open your bot with a parameter. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | callback_query_id | String | Yes | Unique identifier for the query to be answered | | text | String | Optional | Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters. | | show_alert | Boolean | Optional | If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to False. | | url | String | Optional | URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.5. answerChatJoinRequestQuery > Use this method to process a received chat join request query Use this method to process a received chat join request query. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_join_request_query_id | String | Yes | Unique identifier of the join request query | | result | String | Yes | Result of the query. Must be either "approve" to allow the user to join the chat, "decline" to disallow the user to join the chat, or "queue" to leave the decision to other administrators. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.6. answerGuestQuery > Use this method to reply to a received guest message Use this method to reply to a received guest message. On success, a SentGuestMessage object is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | guest_query_id | String | Yes | Unique identifier for the query to be answered | | result | InlineQueryResult | Yes | A JSON-serialized object describing the message to be sent | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.7. answerInlineQuery > Use this method to send answers to an inline query Use this method to send answers to an inline query. On success, *True* is returned. No more than **50** results per query are allowed. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | inline_query_id | String | Yes | Unique identifier for the answered query | | results | Array of InlineQueryResult | Yes | A JSON-serialized Array of results for the inline query | | cache_time | Integer | Optional | The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. | | is_personal | Boolean | Optional | Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query. | | next_offset | String | Optional | Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes. | | button | InlineQueryResultsButton | Optional | A JSON-serialized object describing a button to be shown above inline query results | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.8. answerPreCheckoutQuery > Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the f Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field *pre_checkout_query*. Use this method to respond to such pre-checkout queries. On success, *True* is returned. **Note:** The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | pre_checkout_query_id | String | Yes | Unique identifier for the query to be answered | | ok | Boolean | Yes | Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems. | | error_message | String | Optional | Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.9. answerShippingQuery > If you sent an invoice requesting a shipping address and the parameter *is_flexible* was specified, the Bot API will send an Update with a * If you sent an invoice requesting a shipping address and the parameter *is_flexible* was specified, the Bot API will send an Update with a *shipping_query* field to the bot. Use this method to reply to shipping queries. On success, *True* is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | shipping_query_id | String | Yes | Unique identifier for the query to be answered | | ok | Boolean | Yes | Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) | | shipping_options | Array of ShippingOption | Optional | Required if ok is True. A JSON-serialized Array of available shipping options. | | error_message | String | Optional | Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable"). Telegram will display this message to the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.10. answerWebAppQuery > Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from w Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | web_app_query_id | String | Yes | Unique identifier for the query to be answered | | result | InlineQueryResult | Yes | A JSON-serialized object describing the message to be sent | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.11. approveChatJoinRequest > Use this method to approve a chat join request Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the *can_invite_users* administrator right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | user_id | Integer | Yes | Unique identifier of the target user | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.12. approveSuggestedPost > Use this method to approve a suggested post in a direct messages chat Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer | Yes | Unique identifier for the target direct messages chat | | message_id | Integer | Yes | Identifier of a suggested post message to approve | | send_date | Integer | Optional | Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.13. banChatMember > Use this method to ban a user in a group, a supergroup or a channel Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target group or username of the target supergroup or channel in the format @username | | user_id | Integer | Yes | Unique identifier of the target user | | until_date | Integer | Optional | Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. | | revoke_messages | Boolean | Optional | Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.14. banChatSenderChat > Use this method to ban a channel chat in a supergroup or a channel Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of **any of their channels**. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | sender_chat_id | Integer | Yes | Unique identifier of the target sender chat | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.15. Bot Identity, Profile, Commands & Menu Button > Inspect bot metadata (getMe), configure profile descriptions, command scopes, and the persistent [Menu] button. #### Bot Identity & Metadata (getMe) Before executing bot actions, you can query Telegram's servers to retrieve your bot's official identification, capabilities, and system flags using `getMe`: ```php ``` > [!TIP] > **Auto-Injected Constant: BOT_USERNAME** > On Botlify Cloud, you do not need to call getMe on every webhook to get your bot's handle. The platform automatically injects BOT_USERNAME directly into your .env file. #### Customizing Bot Profile via API (Name, Bio & Description) Telegram allows bots to programmatically configure their visible profile text without manually interacting with @BotFather: | Method | Visibility in Telegram | Max Length | | --- | --- | --- | | setMyName | Top header title of the bot in chat lists and profile headers. | 64 characters | | setMyDescription | Shown in the center of the screen when a user opens an empty chat with the bot before tapping /start. | 512 characters | | setMyShortDescription | Shown on the bot's profile page and in Telegram chat share cards. | 120 characters | ```php ``` #### Registering Slash Commands with Granular Scopes The `setMyCommands` method registers slash commands that autocomplete when users type `/`. Using Telegram's **BotCommandScope**, you can show different commands to normal users vs. chat administrators: ```php ``` #### Configuring the Persistent Bottom [Menu] Button Telegram allows replacing the default paperclip or command menu button beside the chat input box with a direct **Web App Mini App** launcher using `setChatMenuButton`: ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.16. Chat Join Requests & Auto-Approval > Automatically approve or decline private channel and group join requests with instant welcome direct messages. #### The chat_join_request Update When users request to join private channels or invite-only groups, Telegram sends a `chat_join_request` update to your bot rather than a regular message. ```php // Detect and Process Join Requests if (isset($update['chat_join_request'])) { $req = $update['chat_join_request']; $chatId = $req['chat']['id']; $userId = $req['from']['id']; $userName = htmlspecialchars($req['from']['first_name'] ?? 'Friend', ENT_QUOTES, 'UTF-8'); // 1. Instantly Approve the Join Request bot('approveChatJoinRequest', [ 'chat_id' => $chatId, 'user_id' => $userId ]); // 2. Send Personalized Welcome Direct Message bot('sendMessage', [ 'chat_id' => $userId, 'text' => "🎉 Welcome {$userName}! Your request to join our channel has been automatically approved.", 'parse_mode' => 'HTML', 'reply_markup' => [ 'inline_keyboard' => [ [['text' => '🚀 Launch Bot Dashboard', 'url' => 'https://t.me/' . BOT_USERNAME]] ] ] ]); exit('ok'); } ``` #### Decline Join Requests If a user is banned or does not meet membership conditions, you can call `declineChatJoinRequest`: ```php bot('declineChatJoinRequest', [ 'chat_id' => $chatId, 'user_id' => $userId ]); ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.17. close > Use this method to close the bot instance before moving it from one local server to another Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns *True* on success. Requires no parameters. #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.18. closeForumTopic > Use this method to close an open topic in a forum supergroup chat Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | message_thread_id | Integer | Yes | Unique identifier for the target message thread of the forum topic | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.19. closeGeneralForumTopic > Use this method to close an open 'General' topic in a forum supergroup chat Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.20. Complete Master API Reference (A to Z) > Comprehensive reference matrix covering all 100+ Telegram Bot API 8.x methods. #### Alphabetical Methods Directory The following table lists the most frequently implemented Telegram Bot API methods supported on Botlify Cloud: | Method Name | HTTP Type | Description | | --- | --- | --- | | answerCallbackQuery | POST | Sends response to callback button tap to clear spinner. | | approveChatJoinRequest | POST | Approves user request to join channel or group. | | banChatMember | POST | Bans user from group, supergroup, or channel. | | copyMessage / copyMessages | POST | Copies messages without link to original author. | | createChatInviteLink | POST | Generates dynamic invite link with expiration/join limits. | | createInvoiceLink | POST | Creates payment link for Telegram Stars or crypto invoices. | | deleteMessage | POST | Deletes bot or user message in chat. | | editMessageText | POST | Edits text and inline keyboard of existing message. | | forwardMessage / forwardMessages | POST | Forwards messages from any chat. | | getChatMember | POST | Checks user status in chat (crucial for Force-Subscribe). | | getFile | POST | Retrieves file path for downloading photos, audio, documents. | | getUserProfilePhotos | POST | Fetches user avatar profile pictures. | | sendChatAction | POST | Shows 'typing...', 'upload_photo' indicators to users. | | sendGift | POST | Sends Telegram digital gift to user or channel. | | sendMessage | POST | Primary method to dispatch text messages with HTML/Markdown. | | sendPhoto | POST | Sends images with optional caption and buttons. | | sendSticker | POST | Sends animated (TGS), video (WEBM), or static stickers. | | sendVideo | POST | Sends MP4 videos with custom cover and start timestamps. | | setChatMenuButton | POST | Configures persistent bottom-left menu button in chat. | | setMessageReaction | POST | Adds animated emoji reaction (👍, 🔥, ❤️) to message. | | setMyCommands | POST | Registers slash command list for autocomplete popup. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.21. convertGiftToStars > Converts a given regular gift to Telegram Stars Converts a given regular gift to Telegram Stars. Requires the *can_convert_gifts_to_stars* business bot right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | owned_gift_id | String | Yes | Unique identifier of the regular gift that should be converted to Telegram Stars | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.22. copyMessage > Use this method to copy messages of any kind Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field *correct_option_ids* is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | from_chat_id | Integer or String | Yes | Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username) | | message_id | Integer | Yes | Message identifier in the chat specified in from_chat_id | | video_start_timestamp | Integer | Optional | New start timestamp for the copied video in the message | | caption | String | Optional | New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept. | | parse_mode | String | Optional | Mode for parsing entities in the new caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media. Ignored if a new caption isn't specified. | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; only available when copying to private chats | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.23. copyMessages > Use this method to copy messages of any kind Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field *correct_option_ids* is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an Array of MessageId of the sent messages is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat | | from_chat_id | Integer or String | Yes | Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username) | | message_ids | Array of Integer | Yes | A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order. | | disable_notification | Boolean | Optional | Sends the messages silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent messages from forwarding and saving | | remove_caption | Boolean | Optional | Pass True to copy the messages without their captions | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.24. createChatInviteLink > Use this method to create an additional invite link for a chat Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | name | String | Optional | Invite link name; 0-32 characters | | expire_date | Integer | Optional | Point in time (Unix timestamp) when the link will expire | | member_limit | Integer | Optional | The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 | | creates_join_request | Boolean | Optional | True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.25. createChatSubscriptionInviteLink > Use this method to create a subscription invite link for a channel chat Use this method to create a subscription invite link for a channel chat. The bot must have the *can_invite_users* administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target channel chat or username of the target channel in the format @username | | name | String | Optional | Invite link name; 0-32 characters | | subscription_period | Integer | Yes | The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days). | | subscription_price | Integer | Yes | The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000 | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.26. createForumTopic > Use this method to create a topic in a forum supergroup chat or a private chat with a user Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator right. Returns information about the created topic as a ForumTopic object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | name | String | Yes | Topic name, 1-128 characters | | icon_color | Integer | Optional | Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F). | | icon_custom_emoji_id | String | Optional | Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.27. createInvoiceLink > Use this method to create a link for an invoice Use this method to create a link for an invoice. Returns the created invoice link as *String* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only. | | title | String | Yes | Product name, 1-32 characters | | description | String | Yes | Product description, 1-255 characters | | payload | String | Yes | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. | | provider_token | String | Optional | Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. | | currency | String | Yes | Three-letter ISO 4217 currency code, see more on currencies. Pass "XTR" for payments in Telegram Stars. | | prices | Array of LabeledPrice | Yes | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. | | subscription_period | Integer | Optional | The number of seconds the subscription will be active for before the next payment. The currency must be set to "XTR" (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars. | | max_tip_amount | Integer | Optional | The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. | | suggested_tip_amounts | Array of Integer | Optional | A JSON-serialized Array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. | | provider_data | String | Optional | JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. | | photo_url | String | Optional | URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. | | photo_size | Integer | Optional | Photo size in bytes | | photo_width | Integer | Optional | Photo width | | photo_height | Integer | Optional | Photo height | | need_name | Boolean | Optional | Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars. | | need_phone_number | Boolean | Optional | Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars. | | need_email | Boolean | Optional | Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars. | | need_shipping_address | Boolean | Optional | Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars. | | send_phone_number_to_provider | Boolean | Optional | Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars. | | send_email_to_provider | Boolean | Optional | Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars. | | is_flexible | Boolean | Optional | Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.28. createNewStickerSet > Use this method to create a new sticker set owned by a user Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | User identifier of created sticker set owner | | name | String | Yes | Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "_by_". is case insensitive. 1-64 characters. | | title | String | Yes | Sticker set title, 1-64 characters | | stickers | Array of InputSticker | Yes | A JSON-serialized list of 1-50 initial stickers to be added to the sticker set | | sticker_type | String | Optional | Type of stickers in the set, pass "regular", "mask", or "custom_emoji". By default, a regular sticker set is created. | | needs_repainting | Boolean | Optional | Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.29. declineChatJoinRequest > Use this method to decline a chat join request Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the *can_invite_users* administrator right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | user_id | Integer | Yes | Unique identifier of the target user | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.30. declineSuggestedPost > Use this method to decline a suggested post in a direct messages chat Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer | Yes | Unique identifier for the target direct messages chat | | message_id | Integer | Yes | Identifier of a suggested post message to decline | | comment | String | Optional | Comment for the creator of the suggested post; 0-128 characters | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.31. deleteAllMessageReactions > Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | user_id | Integer | Optional | Identifier of the user whose reactions will be removed, if the reactions were added by a user | | actor_chat_id | Integer | Optional | Identifier of the chat whose reactions will be removed, if the reactions were added by a chat | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.32. deleteBusinessMessages > Delete messages on behalf of a business account Delete messages on behalf of a business account. Requires the *can_delete_sent_messages* business bot right to delete messages sent by the bot itself, or the *can_delete_all_messages* business bot right to delete any message. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection on behalf of which to delete the messages | | message_ids | Array of Integer | Yes | A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.33. deleteChatPhoto > Use this method to delete a chat photo Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.34. deleteChatStickerSet > Use this method to delete a group sticker set from a supergroup Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field *can_set_sticker_set* optionally returned in getChat requests to check if the bot can use this method. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.35. deleteEphemeralMessage > Use this method to delete an ephemeral message Use this method to delete an ephemeral message. Note that it is not guaranteed that the user will receive the message deletion event, especially if they are offline. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | receiver_user_id | Integer | Yes | Identifier of the user who received the message | | ephemeral_message_id | Integer | Yes | Identifier of the ephemeral message to delete | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.36. deleteForumTopic > Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_delete_messages* administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | message_thread_id | Integer | Yes | Unique identifier for the target message thread of the forum topic | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.37. deleteMessage > Use this method to delete a message, including service messages, with the following limitations: - A message can only be deleted if it was s **Botlify Native Shorthand:** `tg_delete($chatId, $messageId);` Deletes a message instantly from any chat or channel. See [Native Helpers Guide](?page=tg-native-helpers). Use this method to delete a message, including service messages, with the following limitations: - A message can only be deleted if it was sent less than 48 hours ago. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing messages in private chats, groups, and supergroups. - Bots can delete incoming messages in private chats. - Bots granted *can_post_messages* permissions can delete outgoing messages in channels. - If the bot is an administrator of a group, it can delete any message there. - If the bot has *can_delete_messages* administrator right in a supergroup or a channel, it can delete any message there. - If the bot has *can_manage_direct_messages* administrator right in a channel, it can delete any message in the corresponding direct messages chat. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_id | Integer | Yes | Identifier of the message to delete | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.38. deleteMessageReaction > Use this method to remove a reaction from a message in a group or a supergroup chat Use this method to remove a reaction from a message in a group or a supergroup chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | message_id | Integer | Yes | Identifier of the target message | | user_id | Integer | Optional | Identifier of the user whose reaction will be removed, if the reaction was added by a user | | actor_chat_id | Integer | Optional | Identifier of the chat whose reaction will be removed, if the reaction was added by a chat | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.39. deleteMessages > Use this method to delete multiple messages simultaneously Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_ids | Array of Integer | Yes | A JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.40. deleteMyCommands > Use this method to delete the list of the bot's commands for the given scope and user language Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | scope | BotCommandScope | Optional | A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. | | language_code | String | Optional | A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.41. deleteStickerFromSet > Use this method to delete a sticker from a set created by the bot Use this method to delete a sticker from a set created by the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | sticker | String | Yes | File identifier of the sticker | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.42. deleteStickerSet > Use this method to delete a sticker set that was created by the bot Use this method to delete a sticker set that was created by the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | name | String | Yes | Sticker set name | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.43. deleteStory > Deletes a story previously posted by the bot on behalf of a managed business account Deletes a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | story_id | Integer | Yes | Unique identifier of the story to delete | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.44. deleteWebhook > Use this method to remove webhook integration if you decide to switch back to getUpdates Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | drop_pending_updates | Boolean | Optional | Pass True to drop all pending updates | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.45. editChatInviteLink > Use this method to edit a non-primary invite link created by the bot Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | invite_link | String | Yes | The invite link to edit | | name | String | Optional | Invite link name; 0-32 characters | | expire_date | Integer | Optional | Point in time (Unix timestamp) when the link will expire | | member_limit | Integer | Optional | The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 | | creates_join_request | Boolean | Optional | True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.46. editChatSubscriptionInviteLink > Use this method to edit a subscription invite link created by the bot Use this method to edit a subscription invite link created by the bot. The bot must have the *can_invite_users* administrator rights. Returns the edited invite link as a ChatInviteLink object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | invite_link | String | Yes | The invite link to edit | | name | String | Optional | Invite link name; 0-32 characters | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.47. editEphemeralMessageCaption > Use this method to edit the caption of an ephemeral message Use this method to edit the caption of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, *True* is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | receiver_user_id | Integer | Yes | Identifier of the user who received the message | | ephemeral_message_id | Integer | Yes | Identifier of the ephemeral message to edit | | caption | String | Optional | New caption of the message, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the message caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media. Supported only for animation, photo and video messages. | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.48. editEphemeralMessageMedia > Use this method to edit the media of an ephemeral message Use this method to edit the media of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, *True* is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | receiver_user_id | Integer | Yes | Identifier of the user who received the message | | ephemeral_message_id | Integer | Yes | Identifier of the ephemeral message to edit | | media | InputMedia | Yes | A JSON-serialized object for the new media content of the message | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.49. editEphemeralMessageReplyMarkup > Use this method to edit only the reply markup of an ephemeral message Use this method to edit only the reply markup of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, *True* is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | receiver_user_id | Integer | Yes | Identifier of the user who received the message | | ephemeral_message_id | Integer | Yes | Identifier of the ephemeral message to edit | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.50. editEphemeralMessageText > Use this method to edit an ephemeral text or rich message Use this method to edit an ephemeral text or rich message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, *True* is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | receiver_user_id | Integer | Yes | Identifier of the user who received the message | | ephemeral_message_id | Integer | Yes | Identifier of the ephemeral message to edit | | text | String | Optional | New text of the message, 1-4096 characters after entity parsing; required if rich_message isn't specified | | parse_mode | String | Optional | Mode for parsing entities in the message text. See formatting options for more details. | | entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode | | rich_message | InputRichMessage | Optional | New rich content of the message; required if text isn't specified | | link_preview_options | LinkPreviewOptions | Optional | Link preview generation options for the message | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.51. editForumTopic > Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | message_thread_id | Integer | Yes | Unique identifier for the target message thread of the forum topic | | name | String | Optional | New topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept. | | icon_custom_emoji_id | String | Optional | New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.52. editGeneralForumTopic > Use this method to edit the name of the 'General' topic in a forum supergroup chat Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | name | String | Yes | New topic name, 1-128 characters | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.53. editMessageCaption > Use this method to edit captions of messages Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message to be edited was sent | | chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | | message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the message to edit. | | inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message. | | caption | String | Optional | New caption of the message, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the message caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media. Supported only for animation, photo and video messages. | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.54. editMessageChecklist > Use this method to edit a checklist on behalf of a connected business account Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot in the format @username | | message_id | Integer | Yes | Unique identifier for the target message | | checklist | InputChecklist | Yes | A JSON-serialized object for the new checklist | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for the new inline keyboard for the message | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.55. editMessageLiveLocation > Use this method to edit live location messages Use this method to edit live location messages. A location can be edited until its *live_period* expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise *True* is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message to be edited was sent | | chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | | message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the message to edit. | | inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message. | | latitude | Float | Yes | Latitude of new location | | longitude | Float | Yes | Longitude of new location | | live_period | Integer | Optional | New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged. | | horizontal_accuracy | Float | Optional | The radius of uncertainty for the location, measured in meters; 0-1500 | | heading | Integer | Optional | Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | | proximity_alert_radius | Integer | Optional | The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for a new inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.56. editMessageMedia > Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo, a live photo, or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message to be edited was sent | | chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | | message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the message to edit. | | inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message. | | media | InputMedia | Yes | A JSON-serialized object for the new media content of the message | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for a new inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.57. editMessageReplyMarkup > Use this method to edit only the reply markup of messages Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message to be edited was sent | | chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | | message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the message to edit. | | inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message. | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.58. editMessageText > Use this method to edit text, rich and game messages **Botlify Native Shorthand:** `tg_edit($chatId, $messageId, $newText, $extra);` Edits text messages in-place with zero boilerplate in 1 line. See [Native Helpers Guide](?page=tg-native-helpers). Use this method to edit text, rich and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message to be edited was sent | | chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | | message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the message to edit. | | inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message. | | text | String | Optional | New text of the message, 1-4096 characters after entity parsing; required if rich_message isn't specified | | parse_mode | String | Optional | Mode for parsing entities in the message text. See formatting options for more details. | | entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode | | link_preview_options | LinkPreviewOptions | Optional | Link preview generation options for the message | | rich_message | InputRichMessage | Optional | New rich content of the message; required if text isn't specified. Direct upload of new files and explicit upload of files by a URL isn't supported when an inline message is edited. | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.59. editStory > Edits a story previously posted by the bot on behalf of a managed business account Edits a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns Story on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | story_id | Integer | Yes | Unique identifier of the story to edit | | content | InputStoryContent | Yes | Content of the story | | caption | String | Optional | Caption of the story, 0-2048 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the story caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | areas | Array of StoryArea | Optional | A JSON-serialized list of clickable areas to be shown on the story | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.60. editUserStarSubscription > Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Identifier of the user whose subscription will be edited | | telegram_payment_charge_id | String | Yes | Telegram payment identifier for the subscription | | is_canceled | Boolean | Yes | Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.61. exportChatInviteLink > Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as *String* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | #### Example ```php ``` > [!NOTE] > **Official Notes** > Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.62. Forum Topics & Supergroups (message_thread_id) > Create, edit, close, and organize Telegram Forum topics, manage custom icon colors, and route updates via message_thread_id. #### Telegram Forum Supergroups Overview Telegram allows large supergroups to enable **Topics**, transforming single chat streams into threaded sub-forums (e.g. *#General*, *#Announcements*, *#Support*). Every topic has a unique `message_thread_id` (which equals the `message_id` of the topic creation action). > [!TIP] > **How Thread Routing Works** > To send or reply to a message inside a specific topic, you simply supply 'message_thread_id' => $threadId in your sendMessage, sendPhoto, or sendDocument payload. If omitted, messages are posted to the General topic. #### 1. Creating Forum Topics Programmatically (createForumTopic) Bots can programmatically spawn new discussion topics for customer tickets, project alerts, or product categories: ```php ``` #### 2. Routing Incoming Messages Within Forum Threads When users post messages in a forum supergroup, Telegram includes `message_thread_id` in the incoming webhook. Always capture and preserve this ID when responding: ```php ``` #### 3. Editing, Closing, Reopening & Deleting Topics When tickets are resolved or projects complete, bots can close or archive the topic: ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.63. forwardMessage > Use this method to forward messages of any kind Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat | | from_chat_id | Integer or String | Yes | Unique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username) | | video_start_timestamp | Integer | Optional | New start timestamp for the forwarded video in the message | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the forwarded message from forwarding and saving | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; only available when forwarding to private chats | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only | | message_id | Integer | Yes | Message identifier in the chat specified in from_chat_id | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.64. forwardMessages > Use this method to forward multiple messages of any kind Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an Array of MessageId of the sent messages is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat | | from_chat_id | Integer or String | Yes | Unique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username) | | message_ids | Array of Integer | Yes | A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order. | | disable_notification | Boolean | Optional | Sends the messages silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the forwarded messages from forwarding and saving | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.65. Full-Screen Message Effects > Trigger full-screen celebration fireworks, flames, and hearts using message_effect_id. #### The message_effect_id Parameter Telegram Bot API 8.x introduced full-screen animation effects that cover the entire chat screen when a message arrives. Use the `message_effect_id` parameter in `sendMessage`. | Effect ID | Animation Type | Best Used For | | --- | --- | --- | | 5046509860389126442 | 🎉 Celebration & Confetti | Welcome bonuses, payment completions, winning rewards. | | 5104841245755180586 | 🔥 Burning Flames | Level ups, high streaks, hot broadcasts. | | 5107584321108051014 | ❤️ Floating Hearts | Thank you messages, donations, gifts. | | 5104858069142078847 | 👍 Thumbs Up Explosion | Approvals, confirmed orders, task completions. | ```php function send_effect(string|int $chatId, string $text, string $effectId = '5046509860389126442'): array { return bot('sendMessage', [ 'chat_id' => $chatId, 'text' => $text, 'parse_mode' => 'HTML', 'message_effect_id' => $effectId ]); } ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.66. getAvailableGifts > Returns the list of gifts that can be sent by the bot to users and channel chats Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object. #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.67. getBusinessAccountGifts > Returns the gifts received and owned by a managed business account Returns the gifts received and owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns OwnedGifts on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | exclude_unsaved | Boolean | Optional | Pass True to exclude gifts that aren't saved to the account's profile page | | exclude_saved | Boolean | Optional | Pass True to exclude gifts that are saved to the account's profile page | | exclude_unlimited | Boolean | Optional | Pass True to exclude gifts that can be purchased an unlimited number of times | | exclude_limited_upgradable | Boolean | Optional | Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | | exclude_limited_non_upgradable | Boolean | Optional | Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | | exclude_unique | Boolean | Optional | Pass True to exclude unique gifts | | exclude_from_blockchain | Boolean | Optional | Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | | sort_by_price | Boolean | Optional | Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. | | offset | String | Optional | Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results | | limit | Integer | Optional | The maximum number of gifts to be returned; 1-100. Defaults to 100. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.68. getBusinessAccountStarBalance > Returns the amount of Telegram Stars owned by a managed business account Returns the amount of Telegram Stars owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns StarAmount on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.69. getBusinessConnection > Use this method to get information about the connection of the bot with a business account Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.70. getChat > Use this method to get up-to-date information about the chat Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup or channel in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.71. getChatAdministrators > Use this method to get a list of administrators in a chat Use this method to get a list of administrators in a chat. Returns an Array of ChatMember objects. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup or channel in the format @username | | return_bots | Boolean | Optional | Pass True to additionally receive all bots that are administrators of the chat. By default, bots other than the current bot are omitted. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.72. getChatGifts > Returns the gifts owned by a chat Returns the gifts owned by a chat. Returns OwnedGifts on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | exclude_unsaved | Boolean | Optional | Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel. | | exclude_saved | Boolean | Optional | Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel. | | exclude_unlimited | Boolean | Optional | Pass True to exclude gifts that can be purchased an unlimited number of times | | exclude_limited_upgradable | Boolean | Optional | Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | | exclude_limited_non_upgradable | Boolean | Optional | Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | | exclude_from_blockchain | Boolean | Optional | Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | | exclude_unique | Boolean | Optional | Pass True to exclude unique gifts | | sort_by_price | Boolean | Optional | Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. | | offset | String | Optional | Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results | | limit | Integer | Optional | The maximum number of gifts to be returned; 1-100. Defaults to 100. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.73. getChatMember > Use this method to get information about a member of a chat **Botlify Native Shorthand:** `tg_is_member($channel, $userId);` Checks if user is a member/admin of a channel and returns true/false directly! See [Native Helpers Guide](?page=tg-native-helpers). Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup or channel in the format @username | | user_id | Integer | Yes | Unique identifier of the target user | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.74. getChatMemberCount > Use this method to get the number of members in a chat Use this method to get the number of members in a chat. Returns *Integer* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup or channel in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.75. getChatMenuButton > Use this method to get the current value of the bot's menu button in a private chat, or the default menu button Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer | Optional | Unique identifier for the target private chat. If not specified, the bot's default menu button will be returned. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.76. getCustomEmojiStickers > Use this method to get information about custom emoji stickers by their identifiers Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | custom_emoji_ids | Array of String | Yes | A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.77. getFile > Use this method to get basic information about a file and prepare it for downloading Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link `https://api.telegram.org/file/bot/`, where `` is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again. **Note:** This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | file_id | String | Yes | File identifier to get information about | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.78. getForumTopicIconStickers > Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects. #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.79. getGameHighScores > Use this method to get data for high score tables Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects. This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Target user id | | chat_id | Integer | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat. | | message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the sent message. | | inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.80. getManagedBotAccessSettings > Use this method to get the access settings of a managed bot Use this method to get the access settings of a managed bot. Returns a BotAccessSettings object on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | User identifier of the managed bot whose access settings will be returned | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.81. getManagedBotToken > Use this method to get the token of a managed bot Use this method to get the token of a managed bot. Returns the token as *String* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | User identifier of the managed bot whose token will be returned | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.82. getMe > A simple method for testing your bot's authentication token A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object. #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.83. getMyCommands > Use this method to get the current list of the bot's commands for the given scope and user language Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | scope | BotCommandScope | Optional | A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault. | | language_code | String | Optional | A two-letter ISO 639-1 language code or an empty string | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.84. getMyDefaultAdministratorRights > Use this method to get the current default administrator rights of the bot Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | for_channels | Boolean | Optional | Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.85. getMyDescription > Use this method to get the current bot description for the given user language Use this method to get the current bot description for the given user language. Returns BotDescription on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | language_code | String | Optional | A two-letter ISO 639-1 language code or an empty string | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.86. getMyName > Use this method to get the current bot name for the given user language Use this method to get the current bot name for the given user language. Returns BotName on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | language_code | String | Optional | A two-letter ISO 639-1 language code or an empty string | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.87. getMyShortDescription > Use this method to get the current bot short description for the given user language Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | language_code | String | Optional | A two-letter ISO 639-1 language code or an empty string | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.88. getMyStarBalance > A method to get the current Telegram Stars balance of the bot A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object. #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.89. getStarTransactions > Returns the bot's Telegram Star transactions in chronological order Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | offset | Integer | Optional | Number of transactions to skip in the response | | limit | Integer | Optional | The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.90. getStickerSet > Use this method to get a sticker set Use this method to get a sticker set. On success, a StickerSet object is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | name | String | Yes | Name of the sticker set | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.91. getUpdates > Use this method to receive incoming updates using long polling (wiki) Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects. Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time. **1.** This method will not work if an outgoing webhook is set up. **2.** In order to avoid getting duplicate updates, recalculate *offset* after each server response. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | offset | Integer | Optional | Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten. | | limit | Integer | Optional | Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. | | timeout | Integer | Optional | Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. | | allowed_updates | Array of String | Optional | A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used. | #### Example ```php ``` > [!NOTE] > **Official Notes** > Notes > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.92. getUserChatBoosts > Use this method to get the list of boosts added to a chat by a user Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the chat or username of the channel in the format @username | | user_id | Integer | Yes | Unique identifier of the target user | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.93. getUserGifts > Returns the gifts owned and hosted by a user Returns the gifts owned and hosted by a user. Returns OwnedGifts on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Unique identifier of the user | | exclude_unlimited | Boolean | Optional | Pass True to exclude gifts that can be purchased an unlimited number of times | | exclude_limited_upgradable | Boolean | Optional | Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique | | exclude_limited_non_upgradable | Boolean | Optional | Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique | | exclude_from_blockchain | Boolean | Optional | Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram | | exclude_unique | Boolean | Optional | Pass True to exclude unique gifts | | sort_by_price | Boolean | Optional | Pass True to sort results by gift price instead of send date. Sorting is applied before pagination. | | offset | String | Optional | Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results | | limit | Integer | Optional | The maximum number of gifts to be returned; 1-100. Defaults to 100. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.94. getUserPersonalChatMessages > Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an Array of Message objects is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Unique identifier for the target user | | limit | Integer | Yes | The maximum number of messages to return; 1-20 | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.95. getUserProfileAudios > Use this method to get a list of profile audios for a user Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Unique identifier of the target user | | offset | Integer | Optional | Sequential number of the first audio to be returned. By default, all audios are returned. | | limit | Integer | Optional | Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.96. getUserProfilePhotos > Use this method to get a list of profile pictures for a user Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Unique identifier of the target user | | offset | Integer | Optional | Sequential number of the first photo to be returned. By default, all photos are returned. | | limit | Integer | Optional | Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.97. getWebhookInfo > Use this method to get current webhook status Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the *url* field empty. #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.98. giftPremiumSubscription > Gifts a Telegram Premium subscription to the given user Gifts a Telegram Premium subscription to the given user. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Unique identifier of the target user who will receive a Telegram Premium subscription | | month_count | Integer | Yes | Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12 | | star_count | Integer | Yes | Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months | | text | String | Optional | Text that will be shown along with the service message about the subscription; 0-128 characters | | text_parse_mode | String | Optional | Mode for parsing entities in the text. See formatting options for more details. Entities other than "bold", "italic", "underline", "strikethrough", "spoiler", "custom_emoji", and "date_time" are ignored. | | text_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than "bold", "italic", "underline", "strikethrough", "spoiler", "custom_emoji", and "date_time" are ignored. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.99. Group & Channel Management, Permissions & Bans > Comprehensive guide to banChatMember, restrictChatMember (mute/permissions), promoteChatMember, admin custom titles, and invite links. #### Supergroup & Channel Administration Telegram bots with administrative privileges can autonomously police communities, enforce rate limits, mute spammers, promote trusted moderators, and generate trackable invite links. #### 1. Banning & Unbanning Members (banChatMember) Banning removes a user from the supergroup/channel and prevents them from rejoining: ```php ``` #### 2. Muting Users & Granular ChatPermissions (restrictChatMember) Rather than kicking users, you can restrict specific actions (e.g. forbid sending media, links, or text) using the `ChatPermissions` object: ```php ``` #### 3. Promoting Administrators & Setting Custom Titles Assign specific administrative rights and custom badge titles (e.g. "👑 Senior Mod") to group members: ```php ``` #### 4. Creating & Managing Trackable Chat Invite Links Generate unique invite links with expiration dates, member quotas, or mandatory admin approval: ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.100. hideGeneralForumTopic > Use this method to hide the 'General' topic in a forum supergroup chat Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically closed if it was open. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.101. In-Telegram Admin Suite (/admin) & User Management > Native Telegram-based administrative control center with telemetry, user search, custom ban reasons, and hierarchical navigation. #### The Native In-Telegram Admin Suite Every professional Telegram bot requires a powerful administrative dashboard accessible directly inside Telegram without logging into an external web portal. Botlify Cloud establishes a standardized architectural pattern for building secure, intuitive in-bot admin panels. #### 1. Strict Security Gate The admin suite is gated strictly by `ADMIN_CHAT_ID` (provisioned automatically via environment variables). If any unauthorized user attempts to send `/admin` or trigger admin callback queries, the bot must silently terminate execution with zero response and zero data exposure: ```php ``` #### 2. Hierarchical Back Navigation (admin_home) To maintain seamless UX, administrative sub-sections (such as Statistics, User Management, Broadcast, or Tickets) must never redirect the administrator back to the general user menu. All admin sub-menu `« Back` buttons must specify `callback_data => 'admin_home'`, editing the existing message in-place back to the main admin control center. An explicit `« Exit to Bot Menu` button (`admin_exit`) is provided for intentional exits. #### 3. Real-Time Bot Telemetry & Analytics (admin_stats) The analytics view displays live bot statistics queried directly from the local SQLite database: - Total Registered Users & Today's Active Users (24h). - Currently Suspended / Banned Users count. - Domain-specific metrics (e.g., Total Revenue, Open Support Tickets, Total Orders, Paid Referrals). - Server Engine status (SQLite WAL Mode, PHP version). #### 4. User Management, Dossier Inspection & Ban Firewall Administrators can search any user by numeric Chat ID or `@username` using a dedicated FSM search prompt. The bot renders a detailed user dossier: - **Account Info:** User ID, Username, Display Name, Registration Date, Total Transactions. - **Interactive Action Buttons:** `[🔴 Ban User]` — Prompts admin for a mandatory **Ban Reason**, updates the database with `is_banned = 1` and `ban_reason`, and blocks the user. - `[🟢 Unban User]` — Restores user access and clears the ban flag. > [!WARNING] > **Instant Ban Firewall & Keyboard Removal** > When a banned user attempts to interact with the bot, the ban firewall intercepts the request, displays the custom suspension reason, executes reply_markup => ['remove_keyboard' => true] to strip all menu buttons from their screen, and halts execution immediately. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.102. Interactive Polls & Quizzes (sendPoll & poll_answer) > Create regular voting polls, educational trivia quizzes with explanations, timer deadlines, and process live voting updates. #### Interactive Polls & Trivia Quizzes Overview Telegram polls allow bots to engage communities, run democratic elections, or administer educational quizzes with instant correct/wrong animations and confetti. Poll updates arrive via the `poll_answer` webhook object. #### 1. Creating Regular Polls vs. Quiz Mode | Poll Type | Key Parameters | Behavior in Telegram | | --- | --- | --- | | Regular Poll | type => 'regular', allows_multiple_answers, is_anonymous | Standard public or anonymous voting. Users can retract or change their vote unless poll is closed. | | Quiz Mode | type => 'quiz', correct_option_id, explanation | Users choose once. Correct answer triggers celebratory confetti; wrong answer displays the explanation tooltip. | ```php ``` #### 2. Stopping / Closing a Poll Programmatically When a contest ends or voting deadline arrives, freeze the poll using `stopPoll`: ```php ``` #### 3. Handling Live poll_answer Webhook Updates When a user casts or changes a vote in a non-anonymous poll, Telegram dispatches a `poll_answer` update to your webhook: ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.103. Keyboards, Button Styles, Mini Apps & Reply Controls > Telegram 8.0 button styles (primary, success, danger), custom emoji icons, inline buttons, hardware data pickers, and reply controls. #### Inline Keyboards vs. Reply Keyboards Telegram supports two distinct interactive interface paradigms: - **Inline Keyboards (`InlineKeyboardMarkup`):** Attached directly underneath specific message bubbles. Tapping a button triggers a background `callback_query`, opens an external URL, launches a full-screen Telegram Mini App, copies text to clipboard, or executes seamless OAuth authentication. - **Reply Keyboards (`ReplyKeyboardMarkup`):** Replace the user's on-screen virtual keyboard with fixed or persistent command tiles, contact/GPS hardware requests, or native user/chat pickers. > [!TIP] > **Telegram 8.0 Button Colors (style parameter)** > In Telegram Bot API 8.0+, both InlineKeyboardButton and KeyboardButton support the style parameter: > > "primary" — Dark Blue color for highlighted actions and primary calls-to-action. > "success" — Emerald Green color for approvals, confirmations, and successful purchases. > "danger" — Crimson Red color for destructive actions, deletions, bans, and cancellations. #### 1. Complete Telegram 8.0 Styled Inline Keyboard Example Demonstrating colored buttons (`primary`, `success`, `danger`), custom emoji prefixes (`icon_custom_emoji_id`), and one-tap clipboard copy: ```php ``` > [!WARNING] > **Always Answer Callback Queries Promptly!** > Whenever a user taps an inline callback button, Telegram displays a spinning loader on the button. You must immediately call bot('answerCallbackQuery', ['callback_query_id' => $cbId]) to dismiss the spinner and provide optional haptic/toast notifications. #### 2. The 9 Inline Button Types Matrix | Button Type | Key Payload Property | Behavior & Capabilities | | --- | --- | --- | | Callback Button | callback_data => 'act_1' | Dispatches background webhook update (1 to 64 bytes). Supports style and icon_custom_emoji_id. | | URL Button | url => 'https://...' | Opens external web link in user's browser or in-app browser. | | Mini App Button | web_app => ['url' => '...'] | Launches Telegram Web App directly inside the messenger with full JavaScript bridge. | | Copy Text Button | copy_text => ['text' => '...'] | Copies specified string directly into device clipboard with single tap (API 7.10+). | | Switch Inline Query | switch_inline_query => 'query' | Prompts user to select a chat and enters bot's inline query. | | Switch Chosen Chat | switch_inline_query_chosen_chat | Filters destination chats (e.g. channel-only, group-only, user-only) before forwarding query. | | Telegram Web OAuth | login_url => ['url' => '...'] | One-tap seamless web login passing verified Telegram auth token to your website. | | Invoice Pay Button | pay => true | Must be the first button in the first row of an invoice message to trigger payment sheet. | | HTML5 Game Button | callback_game => [] | Launches interactive canvas/HTML5 game configured via @BotFather. | ```php ``` #### 3. Reply Keyboards with Button Styles & Data Pickers Reply keyboards also support modern button styles (`primary`, `danger`, `success`), hardware data sharing, and native Telegram pickers for selecting specific users or channels: ```php ``` #### 4. Keyboard Dismissal & Force Reply Controls ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.104. leaveChat > Use this method for your bot to leave a group, supergroup or channel Use this method for your bot to leave a group, supergroup or channel. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup or channel in the format @username. Channel direct messages chats aren't supported; leave the corresponding channel instead. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.105. logOut > Use this method to log out from the cloud Bot API server before launching the bot locally Use this method to log out from the cloud Bot API server before launching the bot locally. You **must** log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns *True* on success. Requires no parameters. #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.106. Mandatory Force-Subscribe System > Protect bot features by requiring users to join your official Telegram channel or group before proceeding. #### How Force-Subscribe Works - Add your bot as an **Administrator** in your official channel or group. - When a user sends `/start`, call `getChatMember` with your channel ID and the user's ID. - Inspect the returned `status`. If status is `left` or `kicked`, block access and present a Join Channel button with a *"Check Membership"* callback. ```php function is_subscribed(string|int $userId, string|int $channelId): bool { $res = bot('getChatMember', [ 'chat_id' => $channelId, 'user_id' => $userId ]); if (empty($res['ok'])) return false; $status = $res['result']['status'] ?? ''; return in_array($status, ['creator', 'administrator', 'member', 'restricted'], true); } // In your webhook handler: define('REQUIRED_CHANNEL', '@BotlifyOfficial'); if (!is_subscribed($chatId, REQUIRED_CHANNEL)) { bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "⚠️ Access Restricted! You must join our official channel to use this bot.", 'parse_mode' => 'HTML', 'reply_markup' => [ 'inline_keyboard' => [ [['text' => '📢 Join Channel', 'url' => 'https://t.me/BotlifyOfficial']], [['text' => '🔄 Verify Membership', 'callback_data' => 'check_sub']] ] ] ]); exit('ok'); } ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.107. Media, Audio, Voice, Video Notes, Stickers & Games > Send photos, videos with covers and start timestamps, audio, voice messages, round video notes, sticker sets, and Telegram HTML5 games. #### Telegram Media API Overview Telegram allows bots to dispatch rich multimedia assets via direct public URLs, cached Telegram `file_id` strings, or multipart form uploads. All media methods support HTML captions with inline spoilers. | Method | Media Type | Key Parameters | | --- | --- | --- | | sendPhoto | JPG, PNG, WebP image | photo, caption, has_spoiler | | sendVideo | MP4, H.264 video | video, cover, start_timestamp, supports_streaming | | sendAudio | MP3, M4A music track | audio, performer, title, duration, thumbnail | | sendVoice | OGG Opus voice memo | voice, duration, caption | | sendVideoNote | Circular video clip (1:1 ratio) | video_note, length, duration, thumbnail | | sendDocument | PDF, ZIP, APK, generic file | document, caption, thumbnail | | sendAnimation | GIF or soundless MP4 animation | animation, caption, has_spoiler | | sendMediaGroup | Album of 2 to 10 photos/videos | media (JSON-encoded array of InputMedia) | | sendSticker | WebP, TGS animated, or WebM video | sticker, emoji | | sendGame | Telegram HTML5 Web Game | game_short_name, reply_markup | #### 1. Sending Photos, Videos with Custom Covers & Timestamps In API 8.x, `sendVideo` supports custom thumbnail covers and jumping to a specific playback second: ```php ``` #### 2. Sending Voice Memos & Round Video Notes Voice messages (OGG Opus) render as audio wavebars with 1.5x/2x playback controls. Video notes render as circular clips: ```php ``` #### 3. Sending Media Groups (Albums of up to 10 Items) Combine multiple photos and videos into a single contiguous grid layout: ```php ``` #### 4. Stickers & Telegram HTML5 Games ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.108. Messages, Editing, Pinning & Rich Text Formatting > Complete guide to sendMessage, editMessageText, deleteMessage, pinChatMessage, copyMessage, and full HTML / MarkdownV2 rich typography. #### Telegram Message Lifecycle Overview Every interaction in Telegram begins with message delivery. Beyond standard text, Telegram bots have complete programmatic control over editing existing bubbles, deleting spam, pinning announcements, forwarding/copying messages, and styling typography with rich HTML and MarkdownV2 entities. #### 1. Sending Messages & Link Preview Options (sendMessage) In modern Telegram Bot API (v7.0+ / 8.x), link previews are controlled via the dedicated `link_preview_options` object rather than deprecated boolean flags: ```php ``` #### 2. Comprehensive HTML Formatting Reference Botlify Cloud strongly recommends `parse_mode => 'HTML'` for all bot messages because HTML tags can be safely escaped with PHP's native `htmlspecialchars($var, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8')` without risk of syntax breaks. | Formatting Style | HTML Tag Syntax | Visual Output / Behavior | | --- | --- | --- | | Bold | bold text or text | bold text | | Italic | italic text or text | italic text | | Underline | underlined text or text | underlined text | | Strikethrough | strikethrough or text | strikethrough | | Spoiler | secret | Blurs text until user taps to reveal | | Inline Code | $balance = 50; | Monospaced inline snippet (one-tap copy in Telegram) | | Code Block | code | Multi-line monospaced block with syntax label | | Blockquote | Quoted note | Indented quotation with accent bar | | Expandable Quote | Long text... | Collapsible quotation with "Show More" accordion (API 7.3+) | | Hyperlink | Visit Site | Clickable web link | | Mention by User ID | John Doe | Mentions user even if they do not have a public username | | Custom Emoji | 🔥 | Renders verified Telegram Premium custom emoji (API 6.2+) | ```php ``` #### 3. Editing Messages & Captions Dynamically Rather than sending a flood of new messages, update existing bubbles in place to create smooth, app-like interfaces: ```php ``` #### 4. Deleting, Pinning & Copying Messages ```php ``` #### 5. Realistic Bot UX with Chat Actions (sendChatAction) When performing heavy tasks (such as AI generation, downloading files, or complex SQLite queries), tell the user your bot is working by showing dynamic status indicators in the Telegram header: | Action Name | Displayed Header Status | Ideal Use Case | | --- | --- | --- | | typing | "is typing..." | Waiting for AI responses, text formatting, or database lookups. | | upload_photo | "is sending a photo..." | Generating or fetching high-resolution images. | | record_video / upload_video | "is sending a video..." | Processing or uploading MP4 video files. | | record_voice / upload_voice | "is sending audio..." | Synthesizing text-to-speech voice memos. | | upload_document | "is sending a file..." | Compiling ZIP archives or generating PDF reports. | | choose_sticker | "is choosing a sticker..." | Selecting animated or reaction stickers. | | record_video_note | "is sending a video message..." | Processing circular round video notes. | ```php ``` #### 6. Real-Time Streaming Message Drafts (sendMessageDraft) Telegram allows AI bots to stream partial message drafts in real time to the user while content is being generated: ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.109. Payments, Telegram Stars & Digital Goods > Accept Telegram Stars (⭐️) for digital goods, handle recurring monthly subscriptions, answer pre_checkout_query, and issue refunds. #### The Telegram Stars Ecosystem (⭐️) **Telegram Stars (⭐️)** are Telegram's native virtual currency used to pay for digital goods, downloads, premium services, and recurring subscriptions inside bots. Telegram handles App Store and Google Play compliance, credit card processing, and chargeback security. > [!TIP] > **Currency Code: XTR** > For all Telegram Stars payments, the currency parameter must strictly be set to 'XTR'. #### 1. Creating Stars Invoices (One-Time & Recurring Subscriptions) You can send an invoice card directly into chat using `sendInvoice`, or generate a shareable checkout URL via `createInvoiceLink`: ```php ``` #### 2. Handling the Two-Step Payment Webhook Lifecycle Telegram Stars payments execute in two distinct webhook phases: - **`pre_checkout_query`:** Sent right when the user taps "Pay ⭐️". Your bot has **10 seconds** to confirm order validity. You MUST respond with `answerPreCheckoutQuery(['pre_checkout_query_id' => $id, 'ok' => true])`. - **`successful_payment`:** Sent inside a standard message update once Telegram successfully debits the Stars. You deliver the product and record the transaction in `database.db`. ```php ``` #### 3. Refunding Stars Payments & Inspecting Ledger If a customer requests a refund or disputes a transaction, you can refund their Stars directly using `refundStarPayment`: ```php ``` #### 4. Telegram Stars Paid Gifts API (sendGift & getAvailableGifts) Telegram allows bots to send digital gifts powered by Telegram Stars directly to users or channel chats: ```php ``` #### 5. Affiliate Programs & Referral Commissions (AffiliateInfo) Bots with affiliate programs can reward promoters who refer customers. In Telegram Bot API 8.0+, transactions include the `affiliate` field inside `TransactionPartnerUser` detailing commission percentages and promoter User IDs. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.110. pinChatMessage > Use this method to add a message to the list of pinned messages in a chat Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be pinned | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | message_id | Integer | Yes | Identifier of a message to pin | | disable_notification | Boolean | Optional | Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.111. postStory > Posts a story on behalf of a managed business account Posts a story on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns Story on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | content | InputStoryContent | Yes | Content of the story | | active_period | Integer | Yes | Period after which the story is moved to the archive, in seconds; must be one of 6 3600, 12 3600, 86400, or 2 * 86400 | | caption | String | Optional | Caption of the story, 0-2048 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the story caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | areas | Array of StoryArea | Optional | A JSON-serialized list of clickable areas to be shown on the story | | post_to_chat_page | Boolean | Optional | Pass True to keep the story accessible after it expires | | protect_content | Boolean | Optional | Pass True if the content of the story must be protected from forwarding and screenshotting | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.112. promoteChatMember > Use this method to promote or demote a user in a supergroup or a channel Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass *False* for all boolean parameters to demote a user. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | user_id | Integer | Yes | Unique identifier of the target user | | is_anonymous | Boolean | Optional | Pass True if the administrator's presence in the chat is hidden | | can_manage_chat | Boolean | Optional | Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. | | can_delete_messages | Boolean | Optional | Pass True if the administrator can delete messages of other users | | can_manage_video_chats | Boolean | Optional | Pass True if the administrator can manage video chats | | can_restrict_members | Boolean | Optional | Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators. | | can_promote_members | Boolean | Optional | Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him) | | can_change_info | Boolean | Optional | Pass True if the administrator can change chat title, photo and other settings | | can_invite_users | Boolean | Optional | Pass True if the administrator can invite new users to the chat | | can_post_stories | Boolean | Optional | Pass True if the administrator can post stories to the chat | | can_edit_stories | Boolean | Optional | Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive | | can_delete_stories | Boolean | Optional | Pass True if the administrator can delete stories posted by other users | | can_post_messages | Boolean | Optional | Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | | can_edit_messages | Boolean | Optional | Pass True if the administrator can edit messages of other users and can pin messages; for channels only | | can_pin_messages | Boolean | Optional | Pass True if the administrator can pin messages; for supergroups only | | can_manage_topics | Boolean | Optional | Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | | can_manage_direct_messages | Boolean | Optional | Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only | | can_manage_tags | Boolean | Optional | Pass True if the administrator can edit the tags of regular members; for groups and supergroups only | | can_send_welcome_messages | Boolean | Optional | Pass True if the administrator can manage chat welcome messages or directly send them in the case of bots | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.113. readBusinessMessage > Marks incoming message as read on behalf of a business account Marks incoming message as read on behalf of a business account. Requires the *can_read_messages* business bot right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection on behalf of which to read the message | | chat_id | Integer | Yes | Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours. | | message_id | Integer | Yes | Unique identifier of the message to mark as read | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.114. refundStarPayment > Refunds a successful payment in Telegram Stars Refunds a successful payment in Telegram Stars. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Identifier of the user whose payment will be refunded | | telegram_payment_charge_id | String | Yes | Telegram payment identifier | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.115. removeBusinessAccountProfilePhoto > Removes the current profile photo of a managed business account Removes the current profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | is_public | Boolean | Optional | Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.116. removeChatVerification > Removes verification from a chat that is currently verified on behalf of the organization represented by the bot Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot or channel in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.117. removeMyProfilePhoto > Removes the profile photo of the bot Removes the profile photo of the bot. Requires no parameters. Returns *True* on success. #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.118. removeUserVerification > Removes verification from a user who is currently verified on behalf of the organization represented by the bot Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Unique identifier of the target user | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.119. reopenForumTopic > Use this method to reopen a closed topic in a forum supergroup chat Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | message_thread_id | Integer | Yes | Unique identifier for the target message thread of the forum topic | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.120. reopenGeneralForumTopic > Use this method to reopen a closed 'General' topic in a forum supergroup chat Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically unhidden if it was hidden. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.121. replaceManagedBotToken > Use this method to revoke the current token of a managed bot and generate a new one Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as *String* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | User identifier of the managed bot whose token will be replaced | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.122. replaceStickerInSet > Use this method to replace an existing sticker in a sticker set with a new one Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | User identifier of the sticker set owner | | name | String | Yes | Sticker set name | | old_sticker | String | Yes | File identifier of the replaced sticker | | sticker | InputSticker | Yes | A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.123. repostStory > Reposts a story on behalf of a business account from another business account Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the *can_manage_stories* business bot right for both business accounts. Returns Story on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | from_chat_id | Integer | Yes | Unique identifier of the chat which posted the story that should be reposted | | from_story_id | Integer | Yes | Unique identifier of the story that should be reposted | | active_period | Integer | Yes | Period after which the story is moved to the archive, in seconds; must be one of 6 3600, 12 3600, 86400, or 2 * 86400 | | post_to_chat_page | Boolean | Optional | Pass True to keep the story accessible after it expires | | protect_content | Boolean | Optional | Pass True if the content of the story must be protected from forwarding and screenshotting | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.124. restrictChatMember > Use this method to restrict a user in a supergroup Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass *True* for all permissions to lift restrictions from a user. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | user_id | Integer | Yes | Unique identifier of the target user | | permissions | ChatPermissions | Yes | A JSON-serialized object for new user permissions | | use_independent_chat_permissions | Boolean | Optional | Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. | | until_date | Integer | Optional | Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.125. revokeChatInviteLink > Use this method to revoke an invite link created by the bot Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier of the target chat or username of the target channel in the format @username | | invite_link | String | Yes | The invite link to revoke | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.126. savePreparedInlineMessage > Stores a message that can be sent by a user of a Mini App Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Unique identifier of the target user that can use the prepared message | | result | InlineQueryResult | Yes | A JSON-serialized object describing the message to be sent | | allow_user_chats | Boolean | Optional | Pass True if the message can be sent to private chats with users | | allow_bot_chats | Boolean | Optional | Pass True if the message can be sent to private chats with bots | | allow_group_chats | Boolean | Optional | Pass True if the message can be sent to group and supergroup chats | | allow_channel_chats | Boolean | Optional | Pass True if the message can be sent to channel chats | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.127. savePreparedKeyboardButton > Stores a keyboard button that can be used by a user within a Mini App Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Unique identifier of the target user that can use the button | | button | KeyboardButton | Yes | A JSON-serialized object describing the button to be saved. The button must be of the type request_users, request_chat, or request_managed_bot. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.128. Seamless Telegram Web OAuth Login > Authenticate Telegram users onto web applications seamlessly with one tap using login_url. #### The login_url Parameter Instead of requiring users to enter passwords or 2FA codes on your website, you can attach a `login_url` button in Telegram chat. When clicked, Telegram securely prompts the user and passes verified user data via GET parameters to your auth endpoint. ```php bot('sendMessage', [ 'chat_id' => $chatId, 'text' => "🔐 Access Your Web Dashboard: Click below to log in securely without entering credentials.", 'parse_mode' => 'HTML', 'reply_markup' => [ 'inline_keyboard' => [ [ [ 'text' => '🚀 One-Click Web Login', 'login_url' => [ 'url' => 'https://botlify.cloud/login.php?telegram_oauth=1', 'forward_text' => 'Log in to Botlify Cloud', 'request_write_access' => true ] ] ] ] ] ]); ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.129. sendAnimation > Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound) Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | animation | InputFile or String | Yes | Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files » | | duration | Integer | Optional | Duration of sent animation in seconds | | width | Integer | Optional | Animation width | | height | Integer | Optional | Animation height | | thumbnail | InputFile or String | Optional | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » | | caption | String | Optional | Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the animation caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | has_spoiler | Boolean | Optional | Pass True if the animation needs to be covered with a spoiler animation | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.130. sendAudio > Use this method to send audio files, if you want Telegram clients to display them in the music player Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. For sending voice messages, use the sendVoice method instead. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | audio | InputFile or String | Yes | Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » | | caption | String | Optional | Audio caption, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the audio caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | duration | Integer | Optional | Duration of the audio in seconds | | performer | String | Optional | Performer | | title | String | Optional | Track name | | thumbnail | InputFile or String | Optional | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.131. sendChatAction > Use this method when you need to tell the user that something is happening on the bot's side Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns *True* on success. Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of "Retrieving image, please wait...", the bot may use sendChatAction with *action* = *upload_photo*. The user will see a "sending photo" status for the bot. We only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the action will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot or supergroup in the format @username. Channel chats and channel direct messages chats aren't supported. | | message_thread_id | Integer | Optional | Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only | | action | String | Yes | Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.132. sendChatJoinRequestWebApp > Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome. Call answerChatJoinRequestQuery to resolve the join request query based on the user interaction with the Mini App. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_join_request_query_id | String | Yes | Unique identifier of the join request query | | web_app_url | String | Yes | An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.133. sendChecklist > Use this method to send a checklist on behalf of a connected business account Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot in the format @username | | checklist | InputChecklist | Yes | A JSON-serialized object for the checklist to send | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message | | reply_parameters | ReplyParameters | Optional | A JSON-serialized object for description of the message to reply to | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.134. sendContact > Use this method to send phone contacts Use this method to send phone contacts. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | phone_number | String | Yes | Contact's phone number | | first_name | String | Yes | Contact's first name | | last_name | String | Optional | Contact's last name | | vcard | String | Optional | Additional data about the contact in the form of a vCard, 0-2048 bytes | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.135. sendDice > Use this method to send an animated emoji that will display a random value Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | emoji | String | Optional | Emoji on which the dice throw animation is based. Currently, must be one of "🎲", "🎯", "🏀", "⚽", "🎳", or "🎰". Dice can have values 1-6 for "🎲", "🎯" and "🎳", values 1-5 for "🏀" and "⚽", and values 1-64 for "🎰". Defaults to "🎲". | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.136. sendDocument > Use this method to send general files **Botlify Native Shorthand:** `tg_send_media('document', $chatId, $filePath, $caption);` Attaches local files (database.db, logs) or remote files to chat. See [Native Helpers Guide](?page=tg-native-helpers). Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | document | InputFile or String | Yes | File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » | | thumbnail | InputFile or String | Optional | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » | | caption | String | Optional | Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the document caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | disable_content_type_detection | Boolean | Optional | Disables automatic server-side content type detection for files uploaded using multipart/form-data | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.137. sendGame > Use this method to send a game Use this method to send a game. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot in the format @username. Games can't be sent to channel direct messages chats and channel chats. | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | game_short_name | String | Yes | Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather. | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.138. sendGift > Sends a gift to the given user or channel chat Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Optional | Required if chat_id is not specified. Unique identifier of the target user who will receive the gift. | | chat_id | Integer or String | Optional | Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @username) that will receive the gift. | | gift_id | String | Yes | Identifier of the gift; limited gifts can't be sent to channel chats | | pay_for_upgrade | Boolean | Optional | Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver | | text | String | Optional | Text that will be shown along with the gift; 0-128 characters | | text_parse_mode | String | Optional | Mode for parsing entities in the text. See formatting options for more details. Entities other than "bold", "italic", "underline", "strikethrough", "spoiler", "custom_emoji", and "date_time" are ignored. | | text_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than "bold", "italic", "underline", "strikethrough", "spoiler", "custom_emoji", and "date_time" are ignored. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.139. sendInvoice > Use this method to send invoices Use this method to send invoices. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | title | String | Yes | Product name, 1-32 characters | | description | String | Yes | Product description, 1-255 characters | | payload | String | Yes | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. | | provider_token | String | Optional | Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. | | currency | String | Yes | Three-letter ISO 4217 currency code, see more on currencies. Pass "XTR" for payments in Telegram Stars. | | prices | Array of LabeledPrice | Yes | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. | | max_tip_amount | Integer | Optional | The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. | | suggested_tip_amounts | Array of Integer | Optional | A JSON-serialized Array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. | | start_parameter | String | Optional | Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter. | | provider_data | String | Optional | JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. | | photo_url | String | Optional | URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. | | photo_size | Integer | Optional | Photo size in bytes | | photo_width | Integer | Optional | Photo width | | photo_height | Integer | Optional | Photo height | | need_name | Boolean | Optional | Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars. | | need_phone_number | Boolean | Optional | Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars. | | need_email | Boolean | Optional | Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars. | | need_shipping_address | Boolean | Optional | Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars. | | send_phone_number_to_provider | Boolean | Optional | Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars. | | send_email_to_provider | Boolean | Optional | Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars. | | is_flexible | Boolean | Optional | Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.140. sendLivePhoto > Use this method to send live photos Use this method to send live photos. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | live_photo | InputFile or String | Yes | Live photo video to send. The video must be no longer than 10 seconds and must not exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported. | | photo | InputFile or String | Yes | The static photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported. | | caption | String | Optional | Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the video caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | has_spoiler | Boolean | Optional | Pass True if the video needs to be covered with a spoiler animation | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.141. sendLocation > Use this method to send point on the map Use this method to send point on the map. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | latitude | Float | Yes | Latitude of the location | | longitude | Float | Yes | Longitude of the location | | horizontal_accuracy | Float | Optional | The radius of uncertainty for the location, measured in meters; 0-1500 | | live_period | Integer | Optional | Period in seconds during which the location will be updated (see Live Locations), must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely. Must be 0 for ephemeral messages. | | heading | Integer | Optional | For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | | proximity_alert_radius | Integer | Optional | For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.142. sendMediaGroup > Use this method to send a group of photos, live photos, videos, documents or audios as an album Use this method to send a group of photos, live photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an Array of Message objects that were sent is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat | | media | Array of InputMediaAudio, InputMediaDocument, InputMediaLivePhoto, InputMediaPhoto and InputMediaVideo | Yes | A JSON-serialized Array describing messages to be sent, must include 2-10 items | | disable_notification | Boolean | Optional | Sends messages silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent messages from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.143. sendMessage > Use this method to send text messages **Botlify Native Shorthand:** `tg_send($chatId, $text, $extra);` Fastest way to send formatted HTML messages in Botlify Cloud without manually constructing arrays. See [Native Helpers Guide](?page=tg-native-helpers). Use this method to send text messages. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | text | String | Yes | Text of the message to be sent, 1-4096 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the message text. See formatting options for more details. | | entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode | | link_preview_options | LinkPreviewOptions | Optional | Link preview generation options for the message | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.144. sendMessageDraft > Use this method to stream a partial message to a user while the message is being generated Use this method to stream a partial message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you **must** call sendMessage with the complete message to persist it in the user's chat. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer | Yes | Unique identifier for the target private chat | | message_thread_id | Integer | Optional | Unique identifier for the target message thread | | draft_id | Integer | Yes | Unique identifier of the message draft; must be non-zero. Changes to drafts with the same identifier are animated. Otherwise, the draft is replaced without animation. | | text | String | Optional | Text of the message to be sent, 0-4096 characters after entities parsing. Pass an empty text to show a "Thinking..." placeholder. | | parse_mode | String | Optional | Mode for parsing entities in the message text. See formatting options for more details. | | entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode | | can_stop | Boolean | Optional | Pass True to show the user a button to stop further drafts. The bot will receive an Update "stopped_message_generation" if the user presses the button. | | keep_on_stop | Boolean | Optional | Pass True to keep the draft in the chat when the button is pressed. The draft will still disappear after a short time or if the bot sends a message. To fully preserve the partial draft, the bot should send it as a new message. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.145. sendPaidMedia > Use this method to send paid media Use this method to send paid media. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance. | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | star_count | Integer | Yes | The number of Telegram Stars that must be paid to buy access to the media; 1-25000 | | media | Array of InputPaidMedia | Yes | A JSON-serialized Array describing the media to be sent; up to 10 items | | payload | String | Optional | Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes. | | caption | String | Optional | Media caption, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the media caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.146. sendPhoto > Use this method to send photos **Botlify Native Shorthand:** `tg_send_media('photo', $chatId, $photoUrlOrPath, $caption);` Supports both remote image URLs and local filesystem paths seamlessly. See [Native Helpers Guide](?page=tg-native-helpers). Use this method to send photos. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | photo | InputFile or String | Yes | Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files » | | caption | String | Optional | Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the photo caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | has_spoiler | Boolean | Optional | Pass True if the photo needs to be covered with a spoiler animation | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.147. sendPoll > Use this method to send a native poll Use this method to send a native poll. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Polls can't be sent to channel direct messages chats. | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | question | String | Yes | Poll question, 1-300 characters | | question_parse_mode | String | Optional | Mode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed. | | question_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode. | | options | Array of InputPollOption | Yes | A JSON-serialized list of 1-12 answer options | | is_anonymous | Boolean | Optional | True, if the poll needs to be anonymous, defaults to True | | type | String | Optional | Poll type, "quiz" or "regular", defaults to "regular" | | allows_multiple_answers | Boolean | Optional | Pass True if the poll allows multiple answers, defaults to False | | allows_revoting | Boolean | Optional | Pass True if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls | | shuffle_options | Boolean | Optional | Pass True if the poll options must be shown in random order | | allow_adding_options | Boolean | Optional | Pass True if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes | | hide_results_until_closes | Boolean | Optional | Pass True if poll results must be shown only after the poll closes | | members_only | Boolean | Optional | Pass True if voting is limited to users who have been members of the chat where the poll is being sent for more than 24 hours; for channel chats only | | country_codes | Array of String | Optional | A JSON-serialized list of 0-12 two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll; for channel chats only. Use "FT" as a country code to allow users with anonymous numbers to vote. If omitted or empty, then users from any country can participate in the poll. | | correct_option_ids | Array of Integer | Optional | A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode | | explanation | String | Optional | Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing | | explanation_parse_mode | String | Optional | Mode for parsing entities in the explanation. See formatting options for more details. | | explanation_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode. | | explanation_media | InputPollMedia | Optional | Media added to the quiz explanation | | open_period | Integer | Optional | Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with close_date. | | close_date | Integer | Optional | Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with open_period. | | is_closed | Boolean | Optional | Pass True if the poll needs to be immediately closed. This can be useful for poll preview. | | description | String | Optional | Description of the poll to be sent, 0-1024 characters after entities parsing | | description_parse_mode | String | Optional | Mode for parsing entities in the poll description. See formatting options for more details. | | description_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode | | media | InputPollMedia | Optional | Media added to the poll description | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.148. sendrichmessage > Use this method to send rich messages Use this method to send rich messages. If the message contains a block with a media element, then the bot must have the right to send the media to the chat. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent. Bot can send rich messages on behalf of a business account only if the corresponding user can send rich messages. | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | rich_message | InputRichMessage | Yes | The message to be sent | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.149. sendrichmessagedraft > Use this method to stream a partial rich message to a user while the message is being generated Use this method to stream a partial rich message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you **must** call sendRichMessage with the complete message to persist it in the user's chat. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer | Yes | Unique identifier for the target private chat | | message_thread_id | Integer | Optional | Unique identifier for the target message thread | | draft_id | Integer | Yes | Unique identifier of the message draft; must be non-zero. Changes to drafts with the same identifier are animated. Otherwise, the draft is replaced without animation. | | rich_message | InputRichMessage | Yes | The partial message to be streamed. Direct upload of new files and explicit upload of files by a URL isn't supported. | | can_stop | Boolean | Optional | Pass True to show the user a button to stop further drafts. The bot will receive an Update "stopped_message_generation" if the user presses the button. | | keep_on_stop | Boolean | Optional | Pass True to keep the draft in the chat when the button is pressed. The draft will still disappear after a short time or if the bot sends a message. To fully preserve the partial draft, the bot should send it as a new message. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.150. sendSticker > Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | sticker | InputFile or String | Yes | Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files ». Video and animated stickers can't be sent via an HTTP URL. | | emoji | String | Optional | Emoji associated with the sticker; only for just uploaded stickers | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.151. sendVenue > Use this method to send information about a venue Use this method to send information about a venue. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | latitude | Float | Yes | Latitude of the venue | | longitude | Float | Yes | Longitude of the venue | | title | String | Yes | Name of the venue | | address | String | Yes | Address of the venue | | foursquare_id | String | Optional | Foursquare identifier of the venue | | foursquare_type | String | Optional | Foursquare type of the venue, if known. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".) | | google_place_id | String | Optional | Google Places identifier of the venue | | google_place_type | String | Optional | Google Places type of the venue. (See supported types.) | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.152. sendVideo > Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document) Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | video | InputFile or String | Yes | Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files » | | duration | Integer | Optional | Duration of sent video in seconds | | width | Integer | Optional | Video width | | height | Integer | Optional | Video height | | thumbnail | InputFile or String | Optional | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » | | cover | InputFile or String | Optional | Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | | start_timestamp | Integer | Optional | Start timestamp for the video in the message | | caption | String | Optional | Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the video caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | has_spoiler | Boolean | Optional | Pass True if the video needs to be covered with a spoiler animation | | supports_streaming | Boolean | Optional | Pass True if the uploaded video is suitable for streaming | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.153. sendVideoNote > Use this method to send a rounded square MPEG4 video of up to 1 minute long Use this method to send a rounded square MPEG4 video of up to 1 minute long. On success, the sent Message is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | video_note | InputFile or String | Yes | Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported. | | duration | Integer | Optional | Duration of sent video in seconds | | length | Integer | Optional | Video width and height, i.e. diameter of the video message | | thumbnail | InputFile or String | Optional | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.154. sendVoice > Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_thread_id | Integer | Optional | Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only | | direct_messages_topic_id | Integer | Optional | Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat | | ephemeral_message_parameters | EphemeralMessageParameters | Optional | A JSON-serialized object containing the parameters of the ephemeral message to send | | voice | InputFile or String | Yes | Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files » | | caption | String | Optional | Voice message caption, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the voice message caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode | | duration | Integer | Optional | Duration of the voice message in seconds | | disable_notification | Boolean | Optional | Sends the message silently. Users will receive a notification with no sound. | | protect_content | Boolean | Optional | Protects the contents of the sent message from forwarding and saving | | allow_paid_broadcast | Boolean | Optional | Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. | | message_effect_id | String | Optional | Unique identifier of the message effect to be added to the message; for private chats only | | suggested_post_parameters | SuggestedPostParameters | Optional | A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined. | | reply_parameters | ReplyParameters | Optional | Description of the message to reply to | | reply_markup | InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply | Optional | Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.155. setBusinessAccountBio > Changes the bio of a managed business account Changes the bio of a managed business account. Requires the *can_change_bio* business bot right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | bio | String | Optional | The new value of the bio for the business account; 0-140 characters | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.156. setBusinessAccountGiftSettings > Changes the privacy settings pertaining to incoming gifts in a managed business account Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the *can_change_gift_settings* business bot right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | show_gift_button | Boolean | Yes | Pass True if a button for sending a gift to the user or by the business account must always be shown in the input field | | accepted_gift_types | AcceptedGiftTypes | Yes | Types of gifts accepted by the business account | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.157. setBusinessAccountName > Changes the first and last name of a managed business account Changes the first and last name of a managed business account. Requires the *can_change_name* business bot right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | first_name | String | Yes | The new value of the first name for the business account; 1-64 characters | | last_name | String | Optional | The new value of the last name for the business account; 0-64 characters | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.158. setBusinessAccountProfilePhoto > Changes the profile photo of a managed business account Changes the profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | photo | InputProfilePhoto | Yes | The new profile photo to set | | is_public | Boolean | Optional | Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.159. setBusinessAccountUsername > Changes the username of a managed business account Changes the username of a managed business account. Requires the *can_change_username* business bot right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | username | String | Optional | The new value of the username for the business account; 0-32 characters | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.160. setChatAdministratorCustomTitle > Use this method to set a custom title for an administrator in a supergroup promoted by the bot Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | user_id | Integer | Yes | Unique identifier of the target user | | custom_title | String | Yes | New custom title for the administrator; 0-16 characters, emoji are not allowed | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.161. setChatDescription > Use this method to change the description of a group, a supergroup or a channel Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | description | String | Optional | New chat description, 0-255 characters | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.162. setChatMemberTag > Use this method to set a tag for a regular member in a group or a supergroup Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the *can_manage_tags* administrator right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | user_id | Integer | Yes | Unique identifier of the target user | | tag | String | Optional | New tag for the member; 0-16 characters, emoji are not allowed | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.163. setChatMenuButton > Use this method to change the bot's menu button in a private chat, or the default menu button Use this method to change the bot's menu button in a private chat, or the default menu button. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer | Optional | Unique identifier for the target private chat. If not specified, the bot's default menu button will be changed. | | menu_button | MenuButton | Optional | A JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.164. setChatPermissions > Use this method to set default chat permissions for all members Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the *can_restrict_members* administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | permissions | ChatPermissions | Yes | A JSON-serialized object for new default chat permissions | | use_independent_chat_permissions | Boolean | Optional | Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.165. setChatPhoto > Use this method to set a new profile photo for the chat Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | photo | InputFile | Yes | New chat photo, uploaded using multipart/form-data | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.166. setChatStickerSet > Use this method to set a new group sticker set for a supergroup Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field *can_set_sticker_set* optionally returned in getChat requests to check if the bot can use this method. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | sticker_set_name | String | Yes | Name of the sticker set to be set as the group sticker set | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.167. setChatTitle > Use this method to change the title of a chat Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | title | String | Yes | New chat title, 1-128 characters | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.168. setCustomEmojiStickerSetThumbnail > Use this method to set the thumbnail of a custom emoji sticker set Use this method to set the thumbnail of a custom emoji sticker set. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | name | String | Yes | Sticker set name | | custom_emoji_id | String | Optional | Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.169. setGameScore > Use this method to set the score of the specified user in a game message Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise *True* is returned. Returns an error, if the new score is not greater than the user's current score in the chat and *force* is *False*. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | User identifier | | score | Integer | Yes | New score, must be non-negative | | force | Boolean | Optional | Pass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters. | | disable_edit_message | Boolean | Optional | Pass True if the game message should not be automatically edited to include the current scoreboard | | chat_id | Integer | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat. | | message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the sent message. | | inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.170. setManagedBotAccessSettings > Use this method to change the access settings of a managed bot Use this method to change the access settings of a managed bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | User identifier of the managed bot whose access settings will be changed | | is_access_restricted | Boolean | Yes | Pass True if only selected users can access the bot. The bot's owner can always access it. | | added_user_ids | Array of Integer | Optional | A JSON-serialized list of up to 10 identifiers of users who will have access to the bot in addition to its owner. Ignored if is_access_restricted is False. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.171. setMessageReaction > Use this method to change the chosen reactions on a message Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_id | Integer | Yes | Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead. | | reaction | Array of ReactionType | Optional | A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots. | | is_big | Boolean | Optional | Pass True to set the reaction with a big animation | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.172. setMyCommands > Use this method to change the list of the bot's commands Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | commands | Array of BotCommand | Yes | A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified. | | scope | BotCommandScope | Optional | A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault. | | language_code | String | Optional | A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.173. setMyDefaultAdministratorRights > Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | rights | ChatAdministratorRights | Optional | A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared. | | for_channels | Boolean | Optional | Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.174. setMyDescription > Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | description | String | Optional | New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language. | | language_code | String | Optional | A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.175. setMyName > Use this method to change the bot's name Use this method to change the bot's name. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | name | String | Optional | New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language. | | language_code | String | Optional | A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.176. setMyProfilePhoto > Changes the profile photo of the bot Changes the profile photo of the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | photo | InputProfilePhoto | Yes | The new profile photo to set | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.177. setMyShortDescription > Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when user Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | short_description | String | Optional | New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language. | | language_code | String | Optional | A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.178. setPassportDataErrors > Informs a user that some of the Telegram Passport elements they provided contains errors Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns *True* on success. Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | User identifier | | errors | Array of PassportElementError | Yes | A JSON-serialized Array describing the errors | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.179. setStickerEmojiList > Use this method to change the list of emoji assigned to a regular or custom emoji sticker Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | sticker | String | Yes | File identifier of the sticker | | emoji_list | Array of String | Yes | A JSON-serialized list of 1-20 emoji associated with the sticker | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.180. setStickerKeywords > Use this method to change search keywords assigned to a regular or custom emoji sticker Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | sticker | String | Yes | File identifier of the sticker | | keywords | Array of String | Optional | A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.181. setStickerMaskPosition > Use this method to change the mask position of a mask sticker Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | sticker | String | Yes | File identifier of the sticker | | mask_position | MaskPosition | Optional | A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.182. setStickerPositionInSet > Use this method to move a sticker in a set created by the bot to a specific position Use this method to move a sticker in a set created by the bot to a specific position. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | sticker | String | Yes | File identifier of the sticker | | position | Integer | Yes | New sticker position in the set, zero-based | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.183. setStickerSetThumbnail > Use this method to set the thumbnail of a regular or mask sticker set Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | name | String | Yes | Sticker set name | | user_id | Integer | Yes | User identifier of the sticker set owner | | thumbnail | InputFile or String | Optional | A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail. | | format | String | Yes | Format of the thumbnail, must be one of "static" for a .WEBP or .PNG image, "animated" for a .TGS animation, or "video" for a .WEBM video | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.184. setStickerSetTitle > Use this method to set the title of a created sticker set Use this method to set the title of a created sticker set. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | name | String | Yes | Sticker set name | | title | String | Yes | Sticker set title, 1-64 characters | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.185. setUserEmojiStatus > Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiS Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Unique identifier of the target user | | emoji_status_custom_emoji_id | String | Optional | Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status. | | emoji_status_expiration_date | Integer | Optional | Expiration date of the emoji status, if any | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.186. setWebhook > Use this method to specify a URL and receive incoming updates via an outgoing webhook Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request (a request with response HTTP status code different from `2XY`), we will repeat the request and give up after a reasonable amount of attempts. Returns *True* on success. If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter *secret_token*. If specified, the request will contain a header "X-Telegram-Bot-Api-Secret-Token" with the secret token as content. Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. **1.** You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up. **2.** To use a self-signed certificate, you need to upload your public key certificate using *certificate* parameter. Please upload as InputFile, sending a String will not work. **3.** Ports currently supported *for webhooks*: **443, 80, 88, 8443**. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | url | String | Yes | HTTPS URL to send updates to. Use an empty string to remove webhook integration. | | certificate | InputFile | Optional | Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. | | ip_address | String | Optional | The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS | | max_connections | Integer | Optional | The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. | | allowed_updates | Array of String | Optional | A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used. | #### Example ```php ``` > [!NOTE] > **Official Notes** > Notes If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.187. stopMessageLiveLocation > Use this method to stop updating a live location message before *live_period* expires Use this method to stop updating a live location message before *live_period* expires. On success, if the message is not an inline message, the edited Message is returned, otherwise *True* is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message to be edited was sent | | chat_id | Integer or String | Optional | Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. | | message_id | Integer | Optional | Required if inline_message_id is not specified. Identifier of the message with live location to stop. | | inline_message_id | String | Optional | Required if chat_id and message_id are not specified. Identifier of the inline message. | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for a new inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.188. stopPoll > Use this method to stop a poll which was sent by the bot Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message to be edited was sent | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username | | message_id | Integer | Yes | Identifier of the original message with the poll | | reply_markup | InlineKeyboardMarkup | Optional | A JSON-serialized object for a new message inline keyboard | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.189. Telegram Mini Apps (TMA), Fullscreen & initData Validation > Launch full-screen Web Apps, validate initData cryptographically with HMAC-SHA256 in PHP 8.2, and dispatch prepared inline messages. #### Telegram Mini Apps (TMA) Architecture **Telegram Mini Apps** allow you to embed modern HTML5/JavaScript web applications directly inside Telegram. Mini Apps support full-screen mode, native dark/light theme synchronization, haptic feedback, cloud storage, biometric authentication, and Telegram Stars checkout. #### 1. Launching Mini Apps from Buttons Mini Apps can be opened from Inline Keyboards, Reply Keyboards, or the persistent Chat Menu Button: ```php ``` #### 2. Cryptographic initData Validation in Pure PHP 8.2 When a user opens your Mini App, Telegram injects a secure string called `initData` containing the user's ID, name, username, and a cryptographic `hash`. To prevent attackers from spoofing identities, you **MUST validate this hash on your PHP backend** using your `BOT_TOKEN`: ```php ``` #### 3. Full-Screen Mode & Orientation Locks (API 8.0) Inside your Mini App's front-end JavaScript, you can request full-screen mode and lock screen orientation: ```php // Check if Telegram WebApp SDK is available if (window.Telegram?.WebApp) { const tg = window.Telegram.WebApp; tg.ready(); // 1. Expand to maximum height tg.expand(); // 2. Request True Full-Screen Mode (Telegram 8.0+) if (tg.requestFullscreen) { tg.requestFullscreen(); } // 3. Lock Orientation to Landscape (Great for Web3 games) if (tg.lockOrientation) { tg.lockOrientation('landscape'); } // 4. Disable Vertical Swipes (Prevents accidental sheet closing) if (tg.disableVerticalSwipes) { tg.disableVerticalSwipes(); } } ``` #### 4. Prepared Inline Messages (savePreparedInlineMessage) Mini Apps can pre-package rich interactive messages on the server so users can share them into any Telegram chat with one tap: ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.190. transferBusinessAccountStars > Transfers Telegram Stars from the business account balance to the bot's balance Transfers Telegram Stars from the business account balance to the bot's balance. Requires the *can_transfer_stars* business bot right. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | star_count | Integer | Yes | Number of Telegram Stars to transfer; 1-10000 | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.191. transferGift > Transfers an owned unique gift to another user Transfers an owned unique gift to another user. Requires the *can_transfer_and_upgrade_gifts* business bot right. Requires *can_transfer_stars* business bot right if the transfer is paid. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | owned_gift_id | String | Yes | Unique identifier of the regular gift that should be transferred | | new_owner_chat_id | Integer | Yes | Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours. | | star_count | Integer | Optional | The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.192. unbanChatMember > Use this method to unban a previously banned user in a supergroup or channel Use this method to unban a previously banned user in a supergroup or channel. The user will **not** return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be **removed** from the chat. If you don't want this, use the parameter *only_if_banned*. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target group or username of the target supergroup or channel in the format @username | | user_id | Integer | Yes | Unique identifier of the target user | | only_if_banned | Boolean | Optional | Do nothing if the user is not banned | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.193. unbanChatSenderChat > Use this method to unban a previously banned channel chat in a supergroup or channel Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | sender_chat_id | Integer | Yes | Unique identifier of the target sender chat | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.194. unhideGeneralForumTopic > Use this method to unhide the 'General' topic in a forum supergroup chat Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.195. Universal Multi-Media Broadcast Engine (copyMessage) > Deliver text, photos, videos, voice notes, stickers, and channel forwards to all users with safe rate-limited pacing. #### Universal Multi-Media Broadcast System Mass announcements and notifications are essential for audience engagement. Botlify Cloud standardizes multi-media broadcasting using Telegram's official `copyMessage` API method, enabling administrators to broadcast any rich content type without uploading files multiple times. #### Why copyMessage Outperforms sendMessage | Feature | Traditional sendMessage | Botlify copyMessage Engine | | --- | --- | --- | | Supported Content | Plain text / HTML only | Text, Photo, Video, Document, Voice, Audio, Sticker, GIF, Channel Forwards | | Media Upload Overhead | Re-uploads media on every call | Clones message on Telegram's servers (Zero Bandwidth) | | Formatting Preservation | Requires manual parse_mode tag parsing | Preserves original captions, spoiler tags, and entities automatically | #### Production Implementation Pattern The following engine pattern is recommended for all production bots on Botlify Cloud: ```php ``` > [!TIP] > **Safe Anti-Flood Pacing (38ms Sleep)** > Telegram enforces an outbound limit of approximately 30 messages per second per bot. Pausing execution for usleep(38000) (~38 milliseconds) caps delivery at ~26 messages per second, ensuring smooth delivery without triggering HTTP 429 Too Many Requests or account throttling. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.196. unpinAllChatMessages > Use this method to clear the list of pinned messages in a chat Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.197. unpinAllForumTopicMessages > Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | | message_thread_id | Integer | Yes | Unique identifier for the target message thread of the forum topic | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.198. unpinAllGeneralForumTopicMessages > Use this method to clear the list of pinned messages in a General forum topic Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target supergroup in the format @username | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.199. unpinChatMessage > Use this method to remove a message from the list of pinned messages in a chat Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Optional | Unique identifier of the business connection on behalf of which the message will be unpinned | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel in the format @username | | message_id | Integer | Optional | Identifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.200. upgradeGift > Upgrades a given regular gift to a unique gift Upgrades a given regular gift to a unique gift. Requires the *can_transfer_and_upgrade_gifts* business bot right. Additionally requires the *can_transfer_stars* business bot right if the upgrade is paid. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Yes | Unique identifier of the business connection | | owned_gift_id | String | Yes | Unique identifier of the regular gift that should be upgraded to a unique one | | keep_original_details | Boolean | Optional | Pass True to keep the original gift text, sender and receiver in the upgraded gift | | star_count | Integer | Optional | The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.201. uploadStickerFile > Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (t Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | User identifier of sticker file owner | | sticker | InputFile | Yes | A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files » | | sticker_format | String | Yes | Format of the sticker, must be one of "static", "animated", "video" | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.202. verifyChat > Verifies a chat on behalf of the organization which is represented by the bot Verifies a chat on behalf of the organization which is represented by the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Channel direct messages chats can't be verified. | | custom_description | String | Optional | Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 12.203. verifyUser > Verifies a user on behalf of the organization which is represented by the bot Verifies a user on behalf of the organization which is represented by the bot. Returns *True* on success. #### Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | user_id | Integer | Yes | Unique identifier of the target user | | custom_description | String | Optional | Custom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description. | #### Example ```php ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ## 13. 🧩 Complete Telegram Bot API Types Reference (A-Z, 401 Types) This section provides the complete reference for all Telegram Bot API types. Every type includes structural definitions, field tables, and descriptions. ### 13.1. AcceptedGiftTypes > This object describes the types of gifts that can be gifted to a user or a chat This object describes the types of gifts that can be gifted to a user or a chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | unlimited_gifts | Boolean | Always | True, if unlimited regular gifts are accepted | | limited_gifts | Boolean | Always | True, if limited regular gifts are accepted | | unique_gifts | Boolean | Always | True, if unique gifts or gifts that can be upgraded to unique for free are accepted | | premium_subscription | Boolean | Always | True, if a Telegram Premium subscription is accepted | | gifts_from_channels | Boolean | Always | True, if transfers of unique gifts from channels are accepted | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.2. AffiliateInfo > Contains information about the affiliate that received a commission via this transaction Contains information about the affiliate that received a commission via this transaction. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | affiliate_user | User | Optional | The bot or the user that received an affiliate commission if it was received by a bot or a user | | affiliate_chat | Chat | Optional | The chat that received an affiliate commission if it was received by a chat | | commission_per_mille | Integer | Always | The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users | | amount | Integer | Always | Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds | | nanostar_amount | Integer | Optional | The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.3. Animation > This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | file_id | String | Always | Identifier for this file, which can be used to download or reuse the file | | file_unique_id | String | Always | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | | width | Integer | Always | Video width as defined by the sender | | height | Integer | Always | Video height as defined by the sender | | duration | Integer | Always | Duration of the video in seconds as defined by the sender | | thumbnail | PhotoSize | Optional | Animation thumbnail as defined by the sender | | file_name | String | Optional | Original animation filename as defined by the sender | | mime_type | String | Optional | MIME type of the file as defined by the sender | | file_size | Integer | Optional | File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.4. Audio > This object represents an audio file to be treated as music by the Telegram clients This object represents an audio file to be treated as music by the Telegram clients. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | file_id | String | Always | Identifier for this file, which can be used to download or reuse the file | | file_unique_id | String | Always | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | | duration | Integer | Always | Duration of the audio in seconds as defined by the sender | | performer | String | Optional | Performer of the audio as defined by the sender or by audio tags | | title | String | Optional | Title of the audio as defined by the sender or by audio tags | | file_name | String | Optional | Original filename as defined by the sender | | mime_type | String | Optional | MIME type of the file as defined by the sender | | file_size | Integer | Optional | File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | | thumbnail | PhotoSize | Optional | Thumbnail of the album cover to which the music file belongs | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.5. BackgroundFill > This object describes the way a background is filled based on the selected colors This object describes the way a background is filled based on the selected colors. Currently, it can be one of * BackgroundFillSolid * BackgroundFillGradient * BackgroundFillFreeformGradient > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.6. BackgroundFillFreeformGradient > The background is a freeform gradient that rotates after every message in the chat The background is a freeform gradient that rotates after every message in the chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the background fill, always "freeform_gradient" | | colors | Array of Integer | Always | A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.7. BackgroundFillGradient > The background is a gradient fill The background is a gradient fill. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the background fill, always "gradient" | | top_color | Integer | Always | Top color of the gradient in the RGB24 format | | bottom_color | Integer | Always | Bottom color of the gradient in the RGB24 format | | rotation_angle | Integer | Always | Clockwise rotation angle of the background fill in degrees; 0-359 | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.8. BackgroundFillSolid > The background is filled using the selected color The background is filled using the selected color. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the background fill, always "solid" | | color | Integer | Always | The color of the background fill in the RGB24 format | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.9. BackgroundType > This object describes the type of a background This object describes the type of a background. Currently, it can be one of * BackgroundTypeFill * BackgroundTypeWallpaper * BackgroundTypePattern * BackgroundTypeChatTheme > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.10. BackgroundTypeChatTheme > The background is taken directly from a built-in chat theme The background is taken directly from a built-in chat theme. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the background, always "chat_theme" | | theme_name | String | Always | Name of the chat theme, which is usually an emoji | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.11. BackgroundTypeFill > The background is automatically filled based on the selected colors The background is automatically filled based on the selected colors. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the background, always "fill" | | fill | BackgroundFill | Always | The background fill | | dark_theme_dimming | Integer | Always | Dimming of the background in dark themes, as a percentage; 0-100 | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.12. BackgroundTypePattern > The background is a .PNG or .TGV (gzipped subset of SVG with MIME type "application/x-tgwallpattern") pattern to be combined with the backgr The background is a .PNG or .TGV (gzipped subset of SVG with MIME type "application/x-tgwallpattern") pattern to be combined with the background fill chosen by the user. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the background, always "pattern" | | document | Document | Always | Document with the pattern | | fill | BackgroundFill | Always | The background fill that is combined with the pattern | | intensity | Integer | Always | Intensity of the pattern when it is shown above the filled background; 0-100 | | is_inverted | True | Optional | True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only. | | is_moving | True | Optional | True, if the background moves slightly when the device is tilted | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.13. BackgroundTypeWallpaper > The background is a wallpaper in the JPEG format The background is a wallpaper in the JPEG format. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the background, always "wallpaper" | | document | Document | Always | Document with the wallpaper | | dark_theme_dimming | Integer | Always | Dimming of the background in dark themes, as a percentage; 0-100 | | is_blurred | True | Optional | True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12 | | is_moving | True | Optional | True, if the background moves slightly when the device is tilted | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.14. Birthdate > Describes the birthdate of a user Describes the birthdate of a user. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | day | Integer | Always | Day of the user's birth; 1-31 | | month | Integer | Always | Month of the user's birth; 1-12 | | year | Integer | Optional | Year of the user's birth | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.15. BotAccessSettings > This object describes the access settings of a bot This object describes the access settings of a bot. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | is_access_restricted | Boolean | Always | True, if only selected users can access the bot. The bot's owner can always access it. | | added_users | Array of User | Optional | The list of other users who have access to the bot if the access is restricted | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.16. BotCommand > This object represents a bot command This object represents a bot command. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | command | String | Always | Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores. | | description | String | Always | Description of the command; 1-256 characters | | is_ephemeral | Boolean | Optional | True, if the command sends an ephemeral message, which can be seen only by the sender of the message and the bot | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.17. BotCommandScope > This object represents the scope to which bot commands are applied This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported: * BotCommandScopeDefault * BotCommandScopeAllPrivateChats * BotCommandScopeAllGroupChats * BotCommandScopeAllChatAdministrators * BotCommandScopeChat * BotCommandScopeChatAdministrators * BotCommandScopeChatMember > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.18. BotCommandScopeAllChatAdministrators > Represents the scope of bot commands, covering all group and supergroup chat administrators Represents the scope of bot commands, covering all group and supergroup chat administrators. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Scope type, must be all_chat_administrators | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.19. BotCommandScopeAllGroupChats > Represents the scope of bot commands, covering all group and supergroup chats Represents the scope of bot commands, covering all group and supergroup chats. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Scope type, must be all_group_chats | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.20. BotCommandScopeAllPrivateChats > Represents the scope of bot commands, covering all private chats Represents the scope of bot commands, covering all private chats. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Scope type, must be all_private_chats | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.21. BotCommandScopeChat > Represents the scope of bot commands, covering a specific chat Represents the scope of bot commands, covering a specific chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Scope type, must be chat | | chat_id | Integer or String | Always | Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.22. BotCommandScopeChatAdministrators > Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Scope type, must be chat_administrators | | chat_id | Integer or String | Always | Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.23. BotCommandScopeChatMember > Represents the scope of bot commands, covering a specific member of a group or supergroup chat Represents the scope of bot commands, covering a specific member of a group or supergroup chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Scope type, must be chat_member | | chat_id | Integer or String | Always | Unique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported. | | user_id | Integer | Always | Unique identifier of the target user | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.24. BotCommandScopeDefault > Represents the default scope of bot commands Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Scope type, must be default | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.25. BotDescription > This object represents the bot's description This object represents the bot's description. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | description | String | Always | The bot's description | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.26. BotName > This object represents the bot's name This object represents the bot's name. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | name | String | Always | The bot's name | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.27. BotShortDescription > This object represents the bot's short description This object represents the bot's short description. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | short_description | String | Always | The bot's short description | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.28. BotSubscriptionUpdated > This object contains information about changes to a user payment subscription toward the current bot This object contains information about changes to a user payment subscription toward the current bot. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | user | User | Always | User who subscribed for payments toward the bot | | invoice_payload | String | Always | Bot-specified invoice payload | | state | String | Always | The new state of the subscription. Currently, it can be one of "canceled" if the user canceled the subscription, "active" if the user re-enabled a previously canceled subscription, or "failed" if payment for the subscription failed. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.29. BusinessBotRights > Represents the rights of a business bot Represents the rights of a business bot. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | can_reply | True | Optional | True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours | | can_read_messages | True | Optional | True, if the bot can mark incoming private messages as read | | can_delete_sent_messages | True | Optional | True, if the bot can delete messages sent by the bot | | can_delete_all_messages | True | Optional | True, if the bot can delete all private messages in managed chats | | can_edit_name | True | Optional | True, if the bot can edit the first and last name of the business account | | can_edit_bio | True | Optional | True, if the bot can edit the bio of the business account | | can_edit_profile_photo | True | Optional | True, if the bot can edit the profile photo of the business account | | can_edit_username | True | Optional | True, if the bot can edit the username of the business account | | can_change_gift_settings | True | Optional | True, if the bot can change the privacy settings pertaining to gifts for the business account | | can_view_gifts_and_stars | True | Optional | True, if the bot can view gifts and the amount of Telegram Stars owned by the business account | | can_convert_gifts_to_stars | True | Optional | True, if the bot can convert regular gifts owned by the business account to Telegram Stars | | can_transfer_and_upgrade_gifts | True | Optional | True, if the bot can transfer and upgrade gifts owned by the business account | | can_transfer_stars | True | Optional | True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts | | can_manage_stories | True | Optional | True, if the bot can post, edit and delete stories on behalf of the business account | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.30. BusinessConnection > Describes the connection of the bot with a business account Describes the connection of the bot with a business account. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | id | String | Always | Unique identifier of the business connection | | user | User | Always | Business account user that created the business connection | | user_chat_id | Integer | Always | Identifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. | | date | Integer | Always | Date the connection was established in Unix time | | rights | BusinessBotRights | Optional | Rights of the business bot | | is_enabled | Boolean | Always | True, if the connection is active | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.31. BusinessIntro > Contains information about the start page settings of a Telegram Business account Contains information about the start page settings of a Telegram Business account. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | title | String | Optional | Title text of the business intro | | message | String | Optional | Message text of the business intro | | sticker | Sticker | Optional | Sticker of the business intro | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.32. BusinessLocation > Contains information about the location of a Telegram Business account Contains information about the location of a Telegram Business account. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | address | String | Always | Address of the business | | location | Location | Optional | Location of the business | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.33. BusinessMessagesDeleted > This object is received when messages are deleted from a connected business account This object is received when messages are deleted from a connected business account. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | business_connection_id | String | Always | Unique identifier of the business connection | | chat | Chat | Always | Information about a chat in the business account. The bot may not have access to the chat or the corresponding user. | | message_ids | Array of Integer | Always | The list of identifiers of deleted messages in the chat of the business account | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.34. BusinessOpeningHours > Describes the opening hours of a business Describes the opening hours of a business. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | time_zone_name | String | Always | Unique name of the time zone for which the opening hours are defined | | opening_hours | Array of BusinessOpeningHoursInterval | Always | List of time intervals describing business opening hours | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.35. BusinessOpeningHoursInterval > Describes an interval of time during which a business is open Describes an interval of time during which a business is open. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | opening_minute | Integer | Always | The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60 | | closing_minute | Integer | Always | The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 \ 24 60 | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.36. CallbackGame > A placeholder, currently holds no information A placeholder, currently holds no information. Use BotFather to set up your game. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.37. CallbackQuery > This object represents an incoming callback query from a callback button in an inline keyboard This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field *message* will be present. If the button was attached to a message sent via the bot (in inline mode), the field *inline_message_id* will be present. Exactly one of the fields *data* or *game_short_name* will be present. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | id | String | Always | Unique identifier for this query | | from | User | Always | Sender | | message | MaybeInaccessibleMessage | Optional | Message sent by the bot with the callback button that originated the query | | inline_message_id | String | Optional | Identifier of the message sent via the bot in inline mode, that originated the query | | chat_instance | String | Always | Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. | | data | String | Optional | Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data. | | game_short_name | String | Optional | Short name of a Game to be returned, serves as the unique identifier for the game | > [!NOTE] > **Official Notes** > NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters). > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.38. Chat > This object represents a chat This object represents a chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | id | Integer | Always | Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. | | type | String | Always | Type of the chat, can be either "private", "group", "supergroup" or "channel" | | title | String | Optional | Title, for supergroups, channels and group chats | | username | String | Optional | Username, for private chats, supergroups and channels if available | | first_name | String | Optional | First name of the other party in a private chat | | last_name | String | Optional | Last name of the other party in a private chat | | is_forum | True | Optional | True, if the supergroup chat is a forum (has topics enabled) | | is_direct_messages | True | Optional | True, if the chat is the direct messages chat of a channel | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.39. ChatAdministratorRights > Represents the rights of an administrator in a chat Represents the rights of an administrator in a chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | is_anonymous | Boolean | Always | True, if the user's presence in the chat is hidden | | can_manage_chat | Boolean | Always | True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. | | can_delete_messages | Boolean | Always | True, if the administrator can delete messages of other users | | can_manage_video_chats | Boolean | Always | True, if the administrator can manage video chats | | can_restrict_members | Boolean | Always | True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics | | can_promote_members | Boolean | Always | True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) | | can_change_info | Boolean | Always | True, if the user is allowed to change the chat title, photo and other settings | | can_invite_users | Boolean | Always | True, if the user is allowed to invite new users to the chat | | can_post_stories | Boolean | Always | True, if the administrator can post stories to the chat | | can_edit_stories | Boolean | Always | True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive | | can_delete_stories | Boolean | Always | True, if the administrator can delete stories posted by other users | | can_post_messages | Boolean | Optional | True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | | can_edit_messages | Boolean | Optional | True, if the administrator can edit messages of other users and can pin messages; for channels only | | can_pin_messages | Boolean | Optional | True, if the user is allowed to pin messages; for groups and supergroups only | | can_manage_topics | Boolean | Optional | True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | | can_manage_direct_messages | Boolean | Optional | True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only | | can_manage_tags | Boolean | Optional | True, if the administrator can edit the tags of regular members; for groups and supergroups only | | can_send_welcome_messages | Boolean | Always | True, if the administrator can manage chat welcome messages or directly send them in the case of bots | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.40. ChatBackground > This object represents a chat background This object represents a chat background. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | BackgroundType | Always | Type of the background | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.41. ChatBoost > This object contains information about a chat boost This object contains information about a chat boost. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | boost_id | String | Always | Unique identifier of the boost | | add_date | Integer | Always | Point in time (Unix timestamp) when the chat was boosted | | expiration_date | Integer | Always | Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged | | source | ChatBoostSource | Always | Source of the added boost | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.42. ChatBoostAdded > This object represents a service message about a user boosting a chat This object represents a service message about a user boosting a chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | boost_count | Integer | Always | Number of boosts added by the user | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.43. ChatBoostRemoved > This object represents a boost removed from a chat This object represents a boost removed from a chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | chat | Chat | Always | Chat which was boosted | | boost_id | String | Always | Unique identifier of the boost | | remove_date | Integer | Always | Point in time (Unix timestamp) when the boost was removed | | source | ChatBoostSource | Always | Source of the removed boost | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.44. ChatBoostSource > This object describes the source of a chat boost This object describes the source of a chat boost. It can be one of * ChatBoostSourcePremium * ChatBoostSourceGiftCode * ChatBoostSourceGiveaway > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.45. ChatBoostSourceGiftCode > The boost was obtained by the creation of Telegram Premium gift codes to boost a chat The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | source | String | Always | Source of the boost, always "gift_code" | | user | User | Always | User for which the gift code was created | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.46. ChatBoostSourceGiveaway > The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and *prize_star_count* / 500 times for one year for Telegram Star giveaways. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | source | String | Always | Source of the boost, always "giveaway" | | giveaway_message_id | Integer | Always | Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet. | | user | User | Optional | User that won the prize in the giveaway if any; for Telegram Premium giveaways only | | prize_star_count | Integer | Optional | The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | | is_unclaimed | True | Optional | True, if the giveaway was completed, but there was no user to win the prize | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.47. ChatBoostSourcePremium > The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | source | String | Always | Source of the boost, always "premium" | | user | User | Always | User that boosted the chat | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.48. ChatBoostUpdated > This object represents a boost added to a chat or changed This object represents a boost added to a chat or changed. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | chat | Chat | Always | Chat which was boosted | | boost | ChatBoost | Always | Information about the chat boost | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.49. ChatFullInfo > This object contains full information about a chat This object contains full information about a chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | id | Integer | Always | Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. | | type | String | Always | Type of the chat, can be either "private", "group", "supergroup" or "channel" | | title | String | Optional | Title, for supergroups, channels and group chats | | username | String | Optional | Username, for private chats, supergroups and channels if available | | first_name | String | Optional | First name of the other party in a private chat | | last_name | String | Optional | Last name of the other party in a private chat | | is_forum | True | Optional | True, if the supergroup chat is a forum (has topics enabled) | | is_direct_messages | True | Optional | True, if the chat is the direct messages chat of a channel | | accent_color_id | Integer | Always | Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. | | max_reaction_count | Integer | Always | The maximum number of reactions that can be set on a message in the chat | | photo | ChatPhoto | Optional | Chat photo | | active_usernames | Array of String | Optional | If non-empty, the list of all active chat usernames; for private chats, supergroups and channels | | birthdate | Birthdate | Optional | For private chats, the date of birth of the user | | business_intro | BusinessIntro | Optional | For private chats with business accounts, the intro of the business | | business_location | BusinessLocation | Optional | For private chats with business accounts, the location of the business | | business_opening_hours | BusinessOpeningHours | Optional | For private chats with business accounts, the opening hours of the business | | personal_chat | Chat | Optional | For private chats, the personal channel of the user | | parent_chat | Chat | Optional | Information about the corresponding channel chat; for direct messages chats only | | available_reactions | Array of ReactionType | Optional | List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. | | background_custom_emoji_id | String | Optional | Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background | | profile_accent_color_id | Integer | Optional | Identifier of the accent color for the chat's profile background. See profile accent colors for more details. | | profile_background_custom_emoji_id | String | Optional | Custom emoji identifier of the emoji chosen by the chat for its profile background | | emoji_status_custom_emoji_id | String | Optional | Custom emoji identifier of the emoji status of the chat or the other party in a private chat | | emoji_status_expiration_date | Integer | Optional | Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any | | bio | String | Optional | Bio of the other party in a private chat | | has_private_forwards | True | Optional | True, if privacy settings of the other party in the private chat allows to use tg://user?id= links only in chats with the user | | has_restricted_voice_and_video_messages | True | Optional | True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat | | join_to_send_messages | True | Optional | True, if users need to join the supergroup before they can send messages | | join_by_request | True | Optional | True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators | | description | String | Optional | Description, for groups, supergroups and channel chats | | invite_link | String | Optional | Primary invite link, for groups, supergroups and channel chats | | pinned_message | Message | Optional | The most recent pinned message (by sending date) | | permissions | ChatPermissions | Optional | Default chat member permissions, for groups and supergroups | | accepted_gift_types | AcceptedGiftTypes | Always | Information about types of gifts that are accepted by the chat or by the corresponding user for private chats | | can_send_paid_media | True | Optional | True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. | | slow_mode_delay | Integer | Optional | For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds | | unrestrict_boost_count | Integer | Optional | For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions | | message_auto_delete_time | Integer | Optional | The time after which all messages sent to the chat will be automatically deleted; in seconds | | has_aggressive_anti_spam_enabled | True | Optional | True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. | | has_hidden_members | True | Optional | True, if non-administrators can only get the list of bots and administrators in the chat | | has_protected_content | True | Optional | True, if messages from the chat can't be forwarded to other chats | | has_visible_history | True | Optional | True, if new chat members will have access to old messages; available only to chat administrators | | sticker_set_name | String | Optional | For supergroups, name of the group sticker set | | can_set_sticker_set | True | Optional | True, if the bot can change the group sticker set | | custom_emoji_sticker_set_name | String | Optional | For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. | | linked_chat_id | Integer | Optional | Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. | | location | ChatLocation | Optional | For supergroups, the location to which the supergroup is connected | | rating | UserRating | Optional | For private chats, the rating of the user if any | | first_profile_audio | Audio | Optional | For private chats, the first audio added to the profile of the user | | unique_gift_colors | UniqueGiftColors | Optional | The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews | | paid_message_star_count | Integer | Optional | The number of Telegram Stars a general user has to pay to send a message to the chat | | guard_bot | User | Optional | The bot that processes join request queries in the chat. The field is only available to chat administrators. | | community | Community | Optional | The Community to which the chat belongs | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.50. ChatInviteLink > Represents an invite link for a chat Represents an invite link for a chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | invite_link | String | Always | The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with "...". | | creator | User | Always | Creator of the link | | creates_join_request | Boolean | Always | True, if users joining the chat via the link need to be approved by chat administrators | | is_primary | Boolean | Always | True, if the link is primary | | is_revoked | Boolean | Always | True, if the link is revoked | | name | String | Optional | Invite link name | | expire_date | Integer | Optional | Point in time (Unix timestamp) when the link will expire or has been expired | | member_limit | Integer | Optional | The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 | | pending_join_request_count | Integer | Optional | Number of pending join requests created using this link | | subscription_period | Integer | Optional | The number of seconds the subscription will be active for before the next payment | | subscription_price | Integer | Optional | The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.51. ChatJoinRequest > Represents a join request sent to a chat Represents a join request sent to a chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | chat | Chat | Always | Chat to which the request was sent | | from | User | Always | User that sent the join request | | user_chat_id | Integer | Always | Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user. | | date | Integer | Always | Date the request was sent in Unix time | | bio | String | Optional | Bio of the user | | invite_link | ChatInviteLink | Optional | Chat invite link that was used by the user to send the join request | | query_id | String | Optional | Identifier of the join request query; for bots assigned to process join requests only. If present, then the bot must call sendChatJoinRequestWebApp or directly call answerChatJoinRequestQuery within 10 seconds. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.52. ChatLocation > Represents a location to which a chat is connected Represents a location to which a chat is connected. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | location | Location | Always | The location to which the supergroup is connected. Can't be a live location. | | address | String | Always | Location address; 1-64 characters, as defined by the chat owner | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.53. ChatMember > This object contains information about one member of a chat This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported: * ChatMemberOwner * ChatMemberAdministrator * ChatMemberMember * ChatMemberRestricted * ChatMemberLeft * ChatMemberBanned > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.54. ChatMemberAdministrator > Represents a chat member that has some additional privileges Represents a chat member that has some additional privileges. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | status | String | Always | The member's status in the chat, always "administrator" | | user | User | Always | Information about the user | | can_be_edited | Boolean | Always | True, if the bot is allowed to edit administrator privileges of that user | | is_anonymous | Boolean | Always | True, if the user's presence in the chat is hidden | | can_manage_chat | Boolean | Always | True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege. | | can_delete_messages | Boolean | Always | True, if the administrator can delete messages of other users | | can_manage_video_chats | Boolean | Always | True, if the administrator can manage video chats | | can_restrict_members | Boolean | Always | True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics | | can_promote_members | Boolean | Always | True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user) | | can_change_info | Boolean | Always | True, if the user is allowed to change the chat title, photo and other settings | | can_invite_users | Boolean | Always | True, if the user is allowed to invite new users to the chat | | can_post_stories | Boolean | Always | True, if the administrator can post stories to the chat | | can_edit_stories | Boolean | Always | True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive | | can_delete_stories | Boolean | Always | True, if the administrator can delete stories posted by other users | | can_post_messages | Boolean | Optional | True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | | can_edit_messages | Boolean | Optional | True, if the administrator can edit messages of other users and can pin messages; for channels only | | can_pin_messages | Boolean | Optional | True, if the user is allowed to pin messages; for groups and supergroups only | | can_manage_topics | Boolean | Optional | True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | | can_manage_direct_messages | Boolean | Optional | True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only | | can_manage_tags | Boolean | Optional | True, if the administrator can edit the tags of regular members; for groups and supergroups only | | can_send_welcome_messages | Boolean | Always | True, if the administrator can manage chat welcome messages or directly send them in the case of bots | | custom_title | String | Optional | Custom title for this user | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.55. ChatMemberBanned > Represents a chat member that was banned in the chat and can't return to the chat or view chat messages Represents a chat member that was banned in the chat and can't return to the chat or view chat messages. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | status | String | Always | The member's status in the chat, always "kicked" | | user | User | Always | Information about the user | | until_date | Integer | Always | Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.56. ChatMemberLeft > Represents a chat member that isn't currently a member of the chat, but may join it themselves Represents a chat member that isn't currently a member of the chat, but may join it themselves. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | status | String | Always | The member's status in the chat, always "left" | | user | User | Always | Information about the user | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.57. ChatMemberMember > Represents a chat member that has no additional privileges or restrictions Represents a chat member that has no additional privileges or restrictions. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | status | String | Always | The member's status in the chat, always "member" | | tag | String | Optional | Tag of the member | | user | User | Always | Information about the user | | until_date | Integer | Optional | Date when the user's subscription will expire; Unix time | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.58. ChatMemberOwner > Represents a chat member that owns the chat and has all administrator privileges Represents a chat member that owns the chat and has all administrator privileges. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | status | String | Always | The member's status in the chat, always "creator" | | user | User | Always | Information about the user | | is_anonymous | Boolean | Always | True, if the user's presence in the chat is hidden | | custom_title | String | Optional | Custom title for this user | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.59. ChatMemberRestricted > Represents a chat member that is under certain restrictions in the chat Represents a chat member that is under certain restrictions in the chat. Supergroups only. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | status | String | Always | The member's status in the chat, always "restricted" | | tag | String | Optional | Tag of the member | | user | User | Always | Information about the user | | is_member | Boolean | Always | True, if the user is a member of the chat at the moment of the request | | can_send_messages | Boolean | Always | True, if the user is allowed to send text messages, rich messages, contacts, giveaways, giveaway winners, invoices, locations and venues | | can_send_audios | Boolean | Always | True, if the user is allowed to send audios | | can_send_documents | Boolean | Always | True, if the user is allowed to send documents | | can_send_photos | Boolean | Always | True, if the user is allowed to send photos | | can_send_videos | Boolean | Always | True, if the user is allowed to send videos | | can_send_video_notes | Boolean | Always | True, if the user is allowed to send video notes | | can_send_voice_notes | Boolean | Always | True, if the user is allowed to send voice notes | | can_send_polls | Boolean | Always | True, if the user is allowed to send polls and checklists | | can_send_other_messages | Boolean | Always | True, if the user is allowed to send animations, games, stickers and use inline bots | | can_add_web_page_previews | Boolean | Always | True, if the user is allowed to add web page previews to their messages | | can_react_to_messages | Boolean | Always | True, if the user is allowed to react to messages | | can_edit_tag | Boolean | Always | True, if the user is allowed to edit their own tag | | can_change_info | Boolean | Always | True, if the user is allowed to change the chat title, photo and other settings | | can_invite_users | Boolean | Always | True, if the user is allowed to invite new users to the chat | | can_pin_messages | Boolean | Always | True, if the user is allowed to pin messages | | can_manage_topics | Boolean | Always | True, if the user is allowed to create forum topics | | until_date | Integer | Always | Date when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.60. ChatMemberUpdated > This object represents changes in the status of a chat member This object represents changes in the status of a chat member. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | chat | Chat | Always | Chat the user belongs to | | from | User | Always | Performer of the action, which resulted in the change | | date | Integer | Always | Date the change was done in Unix time | | old_chat_member | ChatMember | Always | Previous information about the chat member | | new_chat_member | ChatMember | Always | New information about the chat member | | invite_link | ChatInviteLink | Optional | Chat invite link, which was used by the user to join the chat; for joining by invite link events only | | via_join_request | Boolean | Optional | True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator | | via_chat_folder_invite_link | Boolean | Optional | True, if the user joined the chat via a chat folder invite link | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.61. ChatOwnerChanged > Describes a service message about an ownership change in the chat Describes a service message about an ownership change in the chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | new_owner | User | Always | The new owner of the chat | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.62. ChatOwnerLeft > Describes a service message about the chat owner leaving the chat Describes a service message about the chat owner leaving the chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | new_owner | User | Optional | The user who will become the new owner of the chat if the previous owner does not return to the chat | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.63. ChatPermissions > Describes actions that a non-administrator user is allowed to take in a chat Describes actions that a non-administrator user is allowed to take in a chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | can_send_messages | Boolean | Optional | True, if the user is allowed to send text messages, rich messages, contacts, giveaways, giveaway winners, invoices, locations and venues | | can_send_audios | Boolean | Optional | True, if the user is allowed to send audios | | can_send_documents | Boolean | Optional | True, if the user is allowed to send documents | | can_send_photos | Boolean | Optional | True, if the user is allowed to send photos | | can_send_videos | Boolean | Optional | True, if the user is allowed to send videos | | can_send_video_notes | Boolean | Optional | True, if the user is allowed to send video notes | | can_send_voice_notes | Boolean | Optional | True, if the user is allowed to send voice notes | | can_send_polls | Boolean | Optional | True, if the user is allowed to send polls and checklists | | can_send_other_messages | Boolean | Optional | True, if the user is allowed to send animations, games, stickers and use inline bots | | can_add_web_page_previews | Boolean | Optional | True, if the user is allowed to add web page previews to their messages | | can_react_to_messages | Boolean | Optional | True, if the user is allowed to react to messages. If omitted, defaults to the value of can_send_messages. | | can_edit_tag | Boolean | Optional | True, if the user is allowed to edit their own tag. If omitted, defaults to the value of can_pin_messages. | | can_change_info | Boolean | Optional | True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups. | | can_invite_users | Boolean | Optional | True, if the user is allowed to invite new users to the chat | | can_pin_messages | Boolean | Optional | True, if the user is allowed to pin messages. Ignored in public supergroups. | | can_manage_topics | Boolean | Optional | True, if the user is allowed to create forum topics. If omitted, defaults to the value of can_pin_messages. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.64. ChatPhoto > This object represents a chat photo This object represents a chat photo. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | small_file_id | String | Always | File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed. | | small_file_unique_id | String | Always | Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | | big_file_id | String | Always | File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed. | | big_file_unique_id | String | Always | Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.65. ChatShared > This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | request_id | Integer | Always | Identifier of the request | | chat_id | Integer | Always | Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means. | | title | String | Optional | Title of the chat, if the title was requested by the bot | | username | String | Optional | Username of the chat, if the username was requested by the bot and available | | photo | Array of PhotoSize | Optional | Available sizes of the chat photo, if the photo was requested by the bot | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.66. Checklist > Describes a checklist Describes a checklist. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | title | String | Always | Title of the checklist | | title_entities | Array of MessageEntity | Optional | Special entities that appear in the checklist title | | tasks | Array of ChecklistTask | Always | List of tasks in the checklist | | others_can_add_tasks | True | Optional | True, if users other than the creator of the list can add tasks to the list | | others_can_mark_tasks_as_done | True | Optional | True, if users other than the creator of the list can mark tasks as done or not done | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.67. ChecklistTask > Describes a task in a checklist Describes a task in a checklist. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | id | Integer | Always | Unique identifier of the task | | text | String | Always | Text of the task | | text_entities | Array of MessageEntity | Optional | Special entities that appear in the task text | | completed_by_user | User | Optional | User that completed the task; omitted if the task wasn't completed by a user | | completed_by_chat | Chat | Optional | Chat that completed the task; omitted if the task wasn't completed by a chat | | completion_date | Integer | Optional | Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.68. ChecklistTasksAdded > Describes a service message about tasks added to a checklist Describes a service message about tasks added to a checklist. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | checklist_message | Message | Optional | Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply. | | tasks | Array of ChecklistTask | Always | List of tasks added to the checklist | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.69. ChecklistTasksDone > Describes a service message about checklist tasks marked as done or not done Describes a service message about checklist tasks marked as done or not done. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | checklist_message | Message | Optional | Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply. | | marked_as_done_task_ids | Array of Integer | Optional | Identifiers of the tasks that were marked as done | | marked_as_not_done_task_ids | Array of Integer | Optional | Identifiers of the tasks that were marked as not done | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.70. ChosenInlineResult > Represents a result of an inline query that was chosen by the user and sent to their chat partner Represents a result of an inline query that was chosen by the user and sent to their chat partner. **Note:** It is necessary to enable inline feedback via @BotFather in order to receive these objects in updates. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | result_id | String | Always | The unique identifier for the result that was chosen | | from | User | Always | The user that chose the result | | location | Location | Optional | Sender location, only for bots that require user location | | inline_message_id | String | Optional | Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message. | | query | String | Always | The query that was used to obtain the result | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.71. Community > Represents a community (a group of chats) Represents a community (a group of chats). #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | id | Integer | Always | Unique identifier for this community. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier. | | name | String | Always | Name of the community | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.72. CommunityChatAdded > Describes a service message about a chat or a bot being added to a community Describes a service message about a chat or a bot being added to a community. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | community | Community | Always | The new community to which the chat or the bot belongs | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.73. CommunityChatJoined > Describes a service message about a chat being joined by a user from a community Describes a service message about a chat being joined by a user from a community. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | community | Community | Always | The community from which the chat was joined | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.74. CommunityChatRemoved > Describes a service message about a chat or a bot being removed from a community Describes a service message about a chat or a bot being removed from a community. Currently holds no information. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.75. Contact > This object represents a phone contact This object represents a phone contact. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | phone_number | String | Always | Contact's phone number | | first_name | String | Always | Contact's first name | | last_name | String | Optional | Contact's last name | | user_id | Integer | Optional | Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. | | vcard | String | Optional | Additional data about the contact in the form of a vCard | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.76. CopyTextButton > This object represents an inline keyboard button that copies specified text to the clipboard This object represents an inline keyboard button that copies specified text to the clipboard. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | text | String | Always | The text to be copied to the clipboard; 1-256 characters | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.77. Dice > This object represents an animated emoji that displays a random value This object represents an animated emoji that displays a random value. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | emoji | String | Always | Emoji on which the dice throw animation is based | | value | Integer | Always | Value of the dice, 1-6 for "🎲", "🎯" and "🎳" base emoji, 1-5 for "🏀" and "⚽" base emoji, 1-64 for "🎰" base emoji | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.78. DirectMessagePriceChanged > Describes a service message about a change in the price of direct messages sent to a channel chat Describes a service message about a change in the price of direct messages sent to a channel chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | are_direct_messages_enabled | Boolean | Always | True, if direct messages are enabled for the channel chat; False otherwise | | direct_message_star_count | Integer | Optional | The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.79. DirectMessagesTopic > Describes a topic of a direct messages chat Describes a topic of a direct messages chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | topic_id | Integer | Always | Unique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. | | user | User | Optional | Information about the user that created the topic. Currently, it is always present. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.80. DisabledButton > This object represents a disabled button which does nothing This object represents a disabled button which does nothing. Currently holds no information. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.81. Document > This object represents a general file (as opposed to photos, voice messages and audio files) This object represents a general file (as opposed to photos, voice messages and audio files). #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | file_id | String | Always | Identifier for this file, which can be used to download or reuse the file | | file_unique_id | String | Always | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | | thumbnail | PhotoSize | Optional | Document thumbnail as defined by the sender | | file_name | String | Optional | Original filename as defined by the sender | | mime_type | String | Optional | MIME type of the file as defined by the sender | | file_size | Integer | Optional | File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.82. EncryptedCredentials > Describes data required for decrypting and authenticating EncryptedPassportElement Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | data | String | Always | Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication | | hash | String | Always | Base64-encoded data hash for data authentication | | secret | String | Always | Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.83. EncryptedPassportElement > Describes documents or other Telegram Passport elements shared with the bot by the user Describes documents or other Telegram Passport elements shared with the bot by the user. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Element type. One of "personal_details", "passport", "driver_license", "identity_card", "internal_passport", "address", "utility_bill", "bank_statement", "rental_agreement", "passport_registration", "temporary_registration", "phone_number", "email". | | data | String | Optional | Base64-encoded encrypted Telegram Passport element data provided by the user; available only for "personal_details", "passport", "driver_license", "identity_card", "internal_passport" and "address" types. Can be decrypted and verified using the accompanying EncryptedCredentials. | | phone_number | String | Optional | User's verified phone number; available only for "phone_number" type | | email | String | Optional | User's verified email address; available only for "email" type | | files | Array of PassportFile | Optional | Array of encrypted files with documents provided by the user; available only for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials. | | front_side | PassportFile | Optional | Encrypted file with the front side of the document, provided by the user; available only for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials. | | reverse_side | PassportFile | Optional | Encrypted file with the reverse side of the document, provided by the user; available only for "driver_license" and "identity_card". The file can be decrypted and verified using the accompanying EncryptedCredentials. | | selfie | PassportFile | Optional | Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for "passport", "driver_license", "identity_card" and "internal_passport". The file can be decrypted and verified using the accompanying EncryptedCredentials. | | translation | Array of PassportFile | Optional | Array of encrypted files with translated versions of documents provided by the user; available if requested for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. Files can be decrypted and verified using the accompanying EncryptedCredentials. | | hash | String | Always | Base64-encoded element hash for using in PassportElementErrorUnspecified | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.84. EphemeralMessageParameters > Describes the parameters of an ephemeral message sent back to a specific user without cluttering the chat for other members. Describes the parameters of an ephemeral message sent back to a specific user. Other members of the group or supergroup will not see the message. | Field | Type | Required | Description | | --- | --- | --- | --- | | receiver_user_id | Integer | Always | Identifier of the user who will receive the message. It is not guaranteed that the user will receive the message, especially if they are offline. See here for more details. | | callback_query_id | String | Optional | Identifier of the callback query which triggered the message, if any | | replace_callback_query_message | Boolean | Optional | Pass *True* if the ephemeral message must be shown in place of the original message. Must be *False* for callback queries from ephemeral messages, which must be edited using regular *editEphemeralMessage...* methods. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.85. ExternalReplyInfo > This object contains information about a message that is being replied to, which may come from another chat or forum topic This object contains information about a message that is being replied to, which may come from another chat or forum topic. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | origin | MessageOrigin | Always | Origin of the message replied to by the given message | | chat | Chat | Optional | Chat the original message belongs to. Available only if the chat is a supergroup or a channel. | | message_id | Integer | Optional | Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel. | | link_preview_options | LinkPreviewOptions | Optional | Options used for link preview generation for the original message, if it is a text message | | animation | Animation | Optional | Message is an animation, information about the animation | | audio | Audio | Optional | Message is an audio file, information about the file | | document | Document | Optional | Message is a general file, information about the file | | live_photo | LivePhoto | Optional | Message is a live photo, information about the live photo | | paid_media | PaidMediaInfo | Optional | Message contains paid media; information about the paid media | | photo | Array of PhotoSize | Optional | Message is a photo, available sizes of the photo | | sticker | Sticker | Optional | Message is a sticker, information about the sticker | | story | Story | Optional | Message is a forwarded story | | video | Video | Optional | Message is a video, information about the video | | video_note | VideoNote | Optional | Message is a video note, information about the video message | | voice | Voice | Optional | Message is a voice message, information about the file | | has_media_spoiler | True | Optional | True, if the message media is covered by a spoiler animation | | checklist | Checklist | Optional | Message is a checklist | | contact | Contact | Optional | Message is a shared contact, information about the contact | | dice | Dice | Optional | Message is a dice with random value | | game | Game | Optional | Message is a game, information about the game. More about games » | | giveaway | Giveaway | Optional | Message is a scheduled giveaway, information about the giveaway | | giveaway_winners | GiveawayWinners | Optional | A giveaway with public winners was completed | | invoice | Invoice | Optional | Message is an invoice for a payment, information about the invoice. More about payments » | | location | Location | Optional | Message is a shared location, information about the location | | poll | Poll | Optional | Message is a native poll, information about the poll | | venue | Venue | Optional | Message is a venue, information about the venue | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.86. File > This object represents a file ready to be downloaded This object represents a file ready to be downloaded. The file can be downloaded via the link `https://api.telegram.org/file/bot/`. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile. The maximum file size to download is 20 MB #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | file_id | String | Always | Identifier for this file, which can be used to download or reuse the file | | file_unique_id | String | Always | Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. | | file_size | Integer | Optional | File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. | | file_path | String | Optional | File path. Use https://api.telegram.org/file/bot/ to get the file. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.87. ForceReply > Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode. Not supported in channels and for messages sent on behalf of a user account. - Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish. - Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'. The last option is definitely more attractive. And if you use ForceReply in your bot's questions, it will receive the user's answers even if it only receives replies, commands and mentions - without any extra work for the user. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | force_reply | True | Always | Shows reply interface to the user, as if they had manually selected the bot's message and tapped 'Reply' | | input_field_placeholder | String | Optional | The placeholder to be shown in the input field when the reply is active; 1-64 characters | | selective | Boolean | Optional | Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message. | #### Example ```php {"force_reply": true, "input_field_placeholder": "Enter your name…"} ``` > [!NOTE] > **Official Notes** > Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll: > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.88. ForumTopic > This object represents a forum topic This object represents a forum topic. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | message_thread_id | Integer | Always | Unique identifier of the forum topic | | name | String | Always | Name of the topic | | icon_color | Integer | Always | Color of the topic icon in RGB format | | icon_custom_emoji_id | String | Optional | Unique identifier of the custom emoji shown as the topic icon | | is_name_implicit | True | Optional | True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.89. ForumTopicClosed > This object represents a service message about a forum topic closed in the chat This object represents a service message about a forum topic closed in the chat. Currently holds no information. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.90. ForumTopicCreated > This object represents a service message about a new forum topic created in the chat This object represents a service message about a new forum topic created in the chat. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | name | String | Always | Name of the topic | | icon_color | Integer | Always | Color of the topic icon in RGB format | | icon_custom_emoji_id | String | Optional | Unique identifier of the custom emoji shown as the topic icon | | is_name_implicit | True | Optional | True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.91. ForumTopicEdited > This object represents a service message about an edited forum topic This object represents a service message about an edited forum topic. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | name | String | Optional | New name of the topic, if it was edited | | icon_custom_emoji_id | String | Optional | New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.92. ForumTopicReopened > This object represents a service message about a forum topic reopened in the chat This object represents a service message about a forum topic reopened in the chat. Currently holds no information. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.93. Game > This object represents a game This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | title | String | Always | Title of the game | | description | String | Always | Description of the game | | photo | Array of PhotoSize | Always | Photo that will be displayed in the game message in chats | | text | String | Optional | Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters. | | text_entities | Array of MessageEntity | Optional | Special entities that appear in text, such as usernames, URLs, bot commands, etc. | | animation | Animation | Optional | Animation that will be displayed in the game message in chats. Upload via BotFather. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.94. GameHighScore > This object represents one row of the high scores table for a game This object represents one row of the high scores table for a game. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | position | Integer | Always | Position in high score table for the game | | user | User | Always | User | | score | Integer | Always | Score | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.95. GeneralForumTopicHidden > This object represents a service message about General forum topic hidden in the chat This object represents a service message about General forum topic hidden in the chat. Currently holds no information. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.96. GeneralForumTopicUnhidden > This object represents a service message about General forum topic unhidden in the chat This object represents a service message about General forum topic unhidden in the chat. Currently holds no information. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.97. Gift > This object represents a gift that can be sent by the bot This object represents a gift that can be sent by the bot. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | id | String | Always | Unique identifier of the gift | | sticker | Sticker | Always | The sticker that represents the gift | | star_count | Integer | Always | The number of Telegram Stars that must be paid to send the sticker | | upgrade_star_count | Integer | Optional | The number of Telegram Stars that must be paid to upgrade the gift to a unique one | | is_premium | True | Optional | True, if the gift can only be purchased by Telegram Premium subscribers | | has_colors | True | Optional | True, if the gift can be used (after being upgraded) to customize a user's appearance | | total_count | Integer | Optional | The total number of gifts of this type that can be sent by all users; for limited gifts only | | remaining_count | Integer | Optional | The number of remaining gifts of this type that can be sent by all users; for limited gifts only | | personal_total_count | Integer | Optional | The total number of gifts of this type that can be sent by the bot; for limited gifts only | | personal_remaining_count | Integer | Optional | The number of remaining gifts of this type that can be sent by the bot; for limited gifts only | | background | GiftBackground | Optional | Background of the gift | | unique_gift_variant_count | Integer | Optional | The total number of different unique gifts that can be obtained by upgrading the gift | | publisher_chat | Chat | Optional | Information about the chat that published the gift | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.98. GiftBackground > This object describes the background of a gift This object describes the background of a gift. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | center_color | Integer | Always | Center color of the background in RGB format | | edge_color | Integer | Always | Edge color of the background in RGB format | | text_color | Integer | Always | Text color of the background in RGB format | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.99. GiftInfo > Describes a service message about a regular gift that was sent or received Describes a service message about a regular gift that was sent or received. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | gift | Gift | Always | Information about the gift | | owned_gift_id | String | Optional | Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts | | convert_star_count | Integer | Optional | Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible | | prepaid_upgrade_star_count | Integer | Optional | Number of Telegram Stars that were prepaid for the ability to upgrade the gift | | is_upgrade_separate | True | Optional | True, if the gift's upgrade was purchased after the gift was sent | | can_be_upgraded | True | Optional | True, if the gift can be upgraded to a unique gift | | text | String | Optional | Text of the message that was added to the gift | | entities | Array of MessageEntity | Optional | Special entities that appear in the text | | is_private | True | Optional | True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them | | unique_gift_number | Integer | Optional | Unique number reserved for this gift when upgraded. See the number field in UniqueGift. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.100. Gifts > This object represent a list of gifts This object represent a list of gifts. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | gifts | Array of Gift | Always | The list of gifts | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.101. Giveaway > This object represents a message about a scheduled giveaway This object represents a message about a scheduled giveaway. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | chats | Array of Chat | Always | The list of chats which the user must join to participate in the giveaway | | winners_selection_date | Integer | Always | Point in time (Unix timestamp) when winners of the giveaway will be selected | | winner_count | Integer | Always | The number of users which are supposed to be selected as winners of the giveaway | | only_new_members | True | Optional | True, if only users who join the chats after the giveaway started should be eligible to win | | has_public_winners | True | Optional | True, if the list of giveaway winners will be visible to everyone | | prize_description | String | Optional | Description of additional giveaway prize | | country_codes | Array of String | Optional | A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways. | | prize_star_count | Integer | Optional | The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | | premium_subscription_month_count | Integer | Optional | The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.102. GiveawayCompleted > This object represents a service message about the completion of a giveaway without public winners This object represents a service message about the completion of a giveaway without public winners. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | winner_count | Integer | Always | Number of winners in the giveaway | | unclaimed_prize_count | Integer | Optional | Number of undistributed prizes | | giveaway_message | Message | Optional | Message with the giveaway that was completed, if it wasn't deleted | | is_star_giveaway | True | Optional | True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.103. GiveawayCreated > This object represents a service message about the creation of a scheduled giveaway This object represents a service message about the creation of a scheduled giveaway. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | prize_star_count | Integer | Optional | The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.104. GiveawayWinners > This object represents a message about the completion of a giveaway with public winners This object represents a message about the completion of a giveaway with public winners. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | chat | Chat | Always | The chat that created the giveaway | | giveaway_message_id | Integer | Always | Identifier of the message with the giveaway in the chat | | winners_selection_date | Integer | Always | Point in time (Unix timestamp) when winners of the giveaway were selected | | winner_count | Integer | Always | Total number of winners in the giveaway | | winners | Array of User | Always | List of up to 100 winners of the giveaway | | additional_chat_count | Integer | Optional | The number of other chats the user had to join in order to be eligible for the giveaway | | prize_star_count | Integer | Optional | The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only | | premium_subscription_month_count | Integer | Optional | The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only | | unclaimed_prize_count | Integer | Optional | Number of undistributed prizes | | only_new_members | True | Optional | True, if only users who had joined the chats after the giveaway started were eligible to win | | was_refunded | True | Optional | True, if the giveaway was canceled because the payment for it was refunded | | prize_description | String | Optional | Description of additional giveaway prize | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.105. InaccessibleMessage > This object describes a message that was deleted or is otherwise inaccessible to the bot This object describes a message that was deleted or is otherwise inaccessible to the bot. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | chat | Chat | Always | Chat the message belonged to | | message_id | Integer | Always | Unique message identifier inside the chat | | date | Integer | Always | Always 0. The field can be used to differentiate regular and inaccessible messages. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.106. InlineKeyboardButton > This object represents one button of an inline keyboard This object represents one button of an inline keyboard. Exactly one of the fields other than *text*, *icon_custom_emoji_id*, and *style* must be used to specify the type of the button. This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a business account. **NOTE:** This type of button **must** always be the first button in the first row. **NOTE:** This type of button **must** always be the first button in the first row and can only be used in invoice messages. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | text | String | Always | Label text on the button | | icon_custom_emoji_id | String | Optional | Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription. | | style | String | Optional | Style of the button. Must be one of "danger" (red), "success" (green) or "primary" (blue). If omitted, then an app-specific style is used. | | url | String | Optional | HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id= can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings. | | callback_data | String | Optional | Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes | | web_app | WebAppInfo | Optional | Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a business account. | | login_url | LoginUrl | Optional | An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget. Not supported for ephemeral messages. | | switch_inline_query | String | Optional | If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a business account. | | switch_inline_query_current_chat | String | Optional | If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted. | #### Example ```php {"text": "✅ Approve", "callback_data": "approve_42"} ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.107. InlineKeyboardMarkup > This object represents an inline keyboard that appears right next to the message it belongs to This object represents an inline keyboard that appears right next to the message it belongs to. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | inline_keyboard | Array of Array of InlineKeyboardButton | Always | Array of button rows, each represented by an Array of InlineKeyboardButton objects | | force_reply | Boolean | Optional | Pass True if the reply interface must be shown to the user, as if they had manually selected the bot's message and tapped 'Reply'. The value of the field can't be changed when the inline keyboard is edited. | #### Example ```php { "inline_keyboard": [ [ {"text": "👍 Like", "callback_data": "like_123"}, {"text": "🔗 Open Site", "url": "https://botlify.cloud"} ], [ {"text": "💳 Pay with Stars", "pay": true} ] ] } ``` > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.108. InlineQuery > This object represents an incoming inline query This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | id | String | Always | Unique identifier for this query | | from | User | Always | Sender | | query | String | Always | Text of the query (up to 256 characters) | | offset | String | Always | Offset of the results to be returned, can be controlled by the bot | | chat_type | String | Optional | Type of the chat from which the inline query was sent. Can be either "sender" for a private chat with the inline query sender, "private", "group", "supergroup", or "channel". The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat. | | location | Location | Optional | Sender location, only for bots that request user location | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.109. InlineQueryResult > This object represents one result of an inline query This object represents one result of an inline query. Telegram clients currently support results of the following 20 types: * InlineQueryResultCachedAudio * InlineQueryResultCachedDocument * InlineQueryResultCachedGif * InlineQueryResultCachedMpeg4Gif * InlineQueryResultCachedPhoto * InlineQueryResultCachedSticker * InlineQueryResultCachedVideo * InlineQueryResultCachedVoice * InlineQueryResultArticle * InlineQueryResultAudio * InlineQueryResultContact * InlineQueryResultGame * InlineQueryResultDocument * InlineQueryResultGif * InlineQueryResultLocation * InlineQueryResultMpeg4Gif * InlineQueryResultPhoto * InlineQueryResultVenue * InlineQueryResultVideo * InlineQueryResultVoice **Note:** All URLs passed in inline query results will be available to end users and therefore must be assumed to be **public**. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.110. InlineQueryResultArticle > Represents a link to an article or web page Represents a link to an article or web page. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be article | | id | String | Always | Unique identifier for this result, 1-64 Bytes | | title | String | Always | Title of the result | | input_message_content | InputMessageContent | Always | Content of the message to be sent | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | url | String | Optional | URL of the result | | description | String | Optional | Short description of the result | | thumbnail_url | String | Optional | Url of the thumbnail for the result | | thumbnail_width | Integer | Optional | Thumbnail width | | thumbnail_height | Integer | Optional | Thumbnail height | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.111. InlineQueryResultAudio > Represents a link to an MP3 audio file Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the audio. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be audio | | id | String | Always | Unique identifier for this result, 1-64 bytes | | audio_url | String | Always | A valid URL for the audio file | | title | String | Always | Title | | caption | String | Optional | Caption, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the audio caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | performer | String | Optional | Performer | | audio_duration | Integer | Optional | Audio duration in seconds | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the audio | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.112. InlineQueryResultCachedAudio > Represents a link to an MP3 audio file stored on the Telegram servers Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the audio. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be audio | | id | String | Always | Unique identifier for this result, 1-64 bytes | | audio_file_id | String | Always | A valid file identifier for the audio file | | caption | String | Optional | Caption, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the audio caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the audio | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.113. InlineQueryResultCachedDocument > Represents a link to a file stored on the Telegram servers Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the file. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be document | | id | String | Always | Unique identifier for this result, 1-64 bytes | | title | String | Always | Title for the result | | document_file_id | String | Always | A valid file identifier for the file | | description | String | Optional | Short description of the result | | caption | String | Optional | Caption of the document to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the document caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the file | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.114. InlineQueryResultCachedGif > Represents a link to an animated GIF file stored on the Telegram servers Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with specified content instead of the animation. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be gif | | id | String | Always | Unique identifier for this result, 1-64 bytes | | gif_file_id | String | Always | A valid file identifier for the GIF file | | title | String | Optional | Title for the result | | caption | String | Optional | Caption of the GIF file to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the GIF animation | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.115. InlineQueryResultCachedMpeg4Gif > Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the animation. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be mpeg4_gif | | id | String | Always | Unique identifier for this result, 1-64 bytes | | mpeg4_file_id | String | Always | A valid file identifier for the MPEG4 file | | title | String | Optional | Title for the result | | caption | String | Optional | Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the video animation | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.116. InlineQueryResultCachedPhoto > Represents a link to a photo stored on the Telegram servers Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the photo. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be photo | | id | String | Always | Unique identifier for this result, 1-64 bytes | | photo_file_id | String | Always | A valid file identifier of the photo | | title | String | Optional | Title for the result | | description | String | Optional | Short description of the result | | caption | String | Optional | Caption of the photo to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the photo caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the photo | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.117. InlineQueryResultCachedSticker > Represents a link to a sticker stored on the Telegram servers Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the sticker. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be sticker | | id | String | Always | Unique identifier for this result, 1-64 bytes | | sticker_file_id | String | Always | A valid file identifier of the sticker | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the sticker | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.118. InlineQueryResultCachedVideo > Represents a link to a video file stored on the Telegram servers Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the video. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be video | | id | String | Always | Unique identifier for this result, 1-64 bytes | | video_file_id | String | Always | A valid file identifier for the video file | | title | String | Always | Title for the result | | description | String | Optional | Short description of the result | | caption | String | Optional | Caption of the video to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the video caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the video | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.119. InlineQueryResultCachedVoice > Represents a link to a voice message stored on the Telegram servers Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the voice message. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be voice | | id | String | Always | Unique identifier for this result, 1-64 bytes | | voice_file_id | String | Always | A valid file identifier for the voice message | | title | String | Always | Voice message title | | caption | String | Optional | Caption, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the voice message caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the voice message | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.120. InlineQueryResultContact > Represents a contact with a phone number Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the contact. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be contact | | id | String | Always | Unique identifier for this result, 1-64 Bytes | | phone_number | String | Always | Contact's phone number | | first_name | String | Always | Contact's first name | | last_name | String | Optional | Contact's last name | | vcard | String | Optional | Additional data about the contact in the form of a vCard, 0-2048 bytes | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the contact | | thumbnail_url | String | Optional | Url of the thumbnail for the result | | thumbnail_width | Integer | Optional | Thumbnail width | | thumbnail_height | Integer | Optional | Thumbnail height | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.121. InlineQueryResultDocument > Represents a link to a file Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the file. Currently, only **.PDF** and **.ZIP** files can be sent using this method. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be document | | id | String | Always | Unique identifier for this result, 1-64 bytes | | title | String | Always | Title for the result | | caption | String | Optional | Caption of the document to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the document caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | document_url | String | Always | A valid URL for the file | | mime_type | String | Always | MIME type of the content of the file, either "application/pdf" or "application/zip" | | description | String | Optional | Short description of the result | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the file | | thumbnail_url | String | Optional | URL of the thumbnail (JPEG only) for the file | | thumbnail_width | Integer | Optional | Thumbnail width | | thumbnail_height | Integer | Optional | Thumbnail height | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.122. InlineQueryResultGame > Represents a Game. Represents a Game. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be game | | id | String | Always | Unique identifier for this result, 1-64 bytes | | game_short_name | String | Always | Short name of the game | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.123. InlineQueryResultGif > Represents a link to an animated GIF file Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the animation. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be gif | | id | String | Always | Unique identifier for this result, 1-64 bytes | | gif_url | String | Always | A valid URL for the GIF file | | gif_width | Integer | Optional | Width of the GIF | | gif_height | Integer | Optional | Height of the GIF | | gif_duration | Integer | Optional | Duration of the GIF in seconds | | thumbnail_url | String | Always | URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result | | thumbnail_mime_type | String | Optional | MIME type of the thumbnail, must be one of "image/jpeg", "image/gif", or "video/mp4". Defaults to "image/jpeg". | | title | String | Optional | Title for the result | | caption | String | Optional | Caption of the GIF file to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the GIF animation | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.124. InlineQueryResultLocation > Represents a location on a map Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the location. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be location | | id | String | Always | Unique identifier for this result, 1-64 Bytes | | latitude | Float | Always | Location latitude in degrees | | longitude | Float | Always | Location longitude in degrees | | title | String | Always | Location title | | horizontal_accuracy | Float | Optional | The radius of uncertainty for the location, measured in meters; 0-1500 | | live_period | Integer | Optional | Period in seconds during which the location can be updated, must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely | | heading | Integer | Optional | For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | | proximity_alert_radius | Integer | Optional | For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the location | | thumbnail_url | String | Optional | Url of the thumbnail for the result | | thumbnail_width | Integer | Optional | Thumbnail width | | thumbnail_height | Integer | Optional | Thumbnail height | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.125. InlineQueryResultMpeg4Gif > Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the animation. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be mpeg4_gif | | id | String | Always | Unique identifier for this result, 1-64 bytes | | mpeg4_url | String | Always | A valid URL for the MPEG4 file | | mpeg4_width | Integer | Optional | Video width | | mpeg4_height | Integer | Optional | Video height | | mpeg4_duration | Integer | Optional | Video duration in seconds | | thumbnail_url | String | Always | URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result | | thumbnail_mime_type | String | Optional | MIME type of the thumbnail, must be one of "image/jpeg", "image/gif", or "video/mp4". Defaults to "image/jpeg". | | title | String | Optional | Title for the result | | caption | String | Optional | Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the video animation | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.126. InlineQueryResultPhoto > Represents a link to a photo Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the photo. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be photo | | id | String | Always | Unique identifier for this result, 1-64 bytes | | photo_url | String | Always | A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB. | | thumbnail_url | String | Always | URL of the thumbnail for the photo | | photo_width | Integer | Optional | Width of the photo | | photo_height | Integer | Optional | Height of the photo | | title | String | Optional | Title for the result | | description | String | Optional | Short description of the result | | caption | String | Optional | Caption of the photo to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the photo caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the photo | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.127. InlineQueryResultsButton > This object represents a button to be shown above inline query results This object represents a button to be shown above inline query results. You **must** use exactly one of the optional fields. *Example:* An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a *switch_inline* button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | text | String | Always | Label text on the button | | web_app | WebAppInfo | Optional | Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App. | | start_parameter | String | Optional | Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.128. InlineQueryResultVenue > Represents a venue. By default, the venue will be sent by the user Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the venue. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be venue | | id | String | Always | Unique identifier for this result, 1-64 Bytes | | latitude | Float | Always | Latitude of the venue location in degrees | | longitude | Float | Always | Longitude of the venue location in degrees | | title | String | Always | Title of the venue | | address | String | Always | Address of the venue | | foursquare_id | String | Optional | Foursquare identifier of the venue if known | | foursquare_type | String | Optional | Foursquare type of the venue, if known. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".) | | google_place_id | String | Optional | Google Places identifier of the venue | | google_place_type | String | Optional | Google Places type of the venue. (See supported types.) | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the venue | | thumbnail_url | String | Optional | Url of the thumbnail for the result | | thumbnail_width | Integer | Optional | Thumbnail width | | thumbnail_height | Integer | Optional | Thumbnail height | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.129. InlineQueryResultVideo > Represents a link to a page containing an embedded video player or a video file Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the video. If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you **must** replace its content using *input_message_content*. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be video | | id | String | Always | Unique identifier for this result, 1-64 bytes | | video_url | String | Always | A valid URL for the embedded video player or video file | | mime_type | String | Always | MIME type of the content of the video URL, "text/html" or "video/mp4" | | thumbnail_url | String | Always | URL of the thumbnail (JPEG only) for the video | | title | String | Always | Title for the result | | caption | String | Optional | Caption of the video to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the video caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | video_width | Integer | Optional | Video width | | video_height | Integer | Optional | Video height | | video_duration | Integer | Optional | Video duration in seconds | | description | String | Optional | Short description of the result | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video). | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.130. InlineQueryResultVoice > Represents a link to a voice recording in an .OGG container encoded with OPUS Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use *input_message_content* to send a message with the specified content instead of the the voice message. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the result, must be voice | | id | String | Always | Unique identifier for this result, 1-64 bytes | | voice_url | String | Always | A valid URL for the voice recording | | title | String | Always | Recording title | | caption | String | Optional | Caption, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the voice message caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | voice_duration | Integer | Optional | Recording duration in seconds | | reply_markup | InlineKeyboardMarkup | Optional | Inline keyboard attached to the message | | input_message_content | InputMessageContent | Optional | Content of the message to be sent instead of the voice recording | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.131. InputChecklist > Describes a checklist to create Describes a checklist to create. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | title | String | Always | Title of the checklist; 1-255 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the title. See formatting options for more details. | | title_entities | Array of MessageEntity | Optional | List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are allowed. | | tasks | Array of InputChecklistTask | Always | List of 1-30 tasks in the checklist | | others_can_add_tasks | Boolean | Optional | Pass True if other users can add tasks to the checklist | | others_can_mark_tasks_as_done | Boolean | Optional | Pass True if other users can mark tasks as done or not done in the checklist | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.132. InputChecklistTask > Describes a task to add to a checklist Describes a task to add to a checklist. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | id | Integer | Always | Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist | | text | String | Always | Text of the task; 1-100 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the text. See formatting options for more details. | | text_entities | Array of MessageEntity | Optional | List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are allowed. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.133. InputContactMessageContent > Represents the content of a contact message to be sent as the result of an inline query Represents the content of a contact message to be sent as the result of an inline query. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | phone_number | String | Always | Contact's phone number | | first_name | String | Always | Contact's first name | | last_name | String | Optional | Contact's last name | | vcard | String | Optional | Additional data about the contact in the form of a vCard, 0-2048 bytes | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.134. InputFile > This object represents the contents of a file to be uploaded This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.135. InputInvoiceMessageContent > Represents the content of an invoice message to be sent as the result of an inline query Represents the content of an invoice message to be sent as the result of an inline query. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | title | String | Always | Product name, 1-32 characters | | description | String | Always | Product description, 1-255 characters | | payload | String | Always | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. | | provider_token | String | Optional | Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. | | currency | String | Always | Three-letter ISO 4217 currency code, see more on currencies. Pass "XTR" for payments in Telegram Stars. | | prices | Array of LabeledPrice | Always | Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars. | | max_tip_amount | Integer | Optional | The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars. | | suggested_tip_amounts | Array of Integer | Optional | A JSON-serialized Array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. | | provider_data | String | Optional | A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider. | | photo_url | String | Optional | URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. | | photo_size | Integer | Optional | Photo size in bytes | | photo_width | Integer | Optional | Photo width | | photo_height | Integer | Optional | Photo height | | need_name | Boolean | Optional | Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars. | | need_phone_number | Boolean | Optional | Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars. | | need_email | Boolean | Optional | Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars. | | need_shipping_address | Boolean | Optional | Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars. | | send_phone_number_to_provider | Boolean | Optional | Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars. | | send_email_to_provider | Boolean | Optional | Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars. | | is_flexible | Boolean | Optional | Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.136. InputLocationMessageContent > Represents the content of a location message to be sent as the result of an inline query Represents the content of a location message to be sent as the result of an inline query. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | latitude | Float | Always | Latitude of the location in degrees | | longitude | Float | Always | Longitude of the location in degrees | | horizontal_accuracy | Float | Optional | The radius of uncertainty for the location, measured in meters; 0-1500 | | live_period | Integer | Optional | Period in seconds during which the location can be updated, must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely | | heading | Integer | Optional | For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | | proximity_alert_radius | Integer | Optional | For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.137. InputMedia > This object represents the content of a media message to be sent This object represents the content of a media message to be sent. It should be one of * InputMediaAnimation * InputMediaAudio * InputMediaDocument * InputMediaLivePhoto * InputMediaPhoto * InputMediaVideo > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.138. InputMediaAnimation > Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be animation | | media | String | Always | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | | thumbnail | String | Optional | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » | | caption | String | Optional | Caption of the animation to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the animation caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | width | Integer | Optional | Animation width | | height | Integer | Optional | Animation height | | duration | Integer | Optional | Animation duration in seconds | | has_spoiler | Boolean | Optional | Pass True if the animation needs to be covered with a spoiler animation | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.139. InputMediaAudio > Represents an audio file to be treated as music to be sent Represents an audio file to be treated as music to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be audio | | media | String | Always | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | | thumbnail | String | Optional | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » | | caption | String | Optional | Caption of the audio to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the audio caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | duration | Integer | Optional | Duration of the audio in seconds | | performer | String | Optional | Performer of the audio | | title | String | Optional | Title of the audio | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.140. InputMediaDocument > Represents a general file to be sent Represents a general file to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be document | | media | String | Always | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | | thumbnail | String | Optional | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » | | caption | String | Optional | Caption of the document to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the document caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | disable_content_type_detection | Boolean | Optional | Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.141. InputMediaLink > Represents an HTTP link to be sent Represents an HTTP link to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be link | | url | String | Always | HTTP URL of the link | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.142. InputMediaLivePhoto > Represents a live photo to be sent Represents a live photo to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be live_photo | | media | String | Always | Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files ». Sending live photos by a URL is currently unsupported. | | photo | String | Always | The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files ». Sending live photos by a URL is currently unsupported. | | caption | String | Optional | Caption of the live photo to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the live photo caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | has_spoiler | Boolean | Optional | Pass True if the live photo needs to be covered with a spoiler animation | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.143. InputMediaLocation > Represents a location to be sent Represents a location to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be location | | latitude | Float | Always | Latitude of the location | | longitude | Float | Always | Longitude of the location | | horizontal_accuracy | Float | Optional | The radius of uncertainty for the location, measured in meters; 0-1500 | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.144. InputMediaPhoto > Represents a photo to be sent Represents a photo to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be photo | | media | String | Always | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | | caption | String | Optional | Caption of the photo to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the photo caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | has_spoiler | Boolean | Optional | Pass True if the photo needs to be covered with a spoiler animation | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.145. InputMediaSticker > Represents a sticker file to be sent Represents a sticker file to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be sticker | | media | String | Always | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a .WEBP sticker from the Internet, or pass "attach://" to upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data under name. More information on Sending Files » | | emoji | String | Optional | Emoji associated with the sticker; only for just uploaded stickers | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.146. InputMediaVenue > Represents a venue to be sent Represents a venue to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be venue | | latitude | Float | Always | Latitude of the location | | longitude | Float | Always | Longitude of the location | | title | String | Always | Name of the venue | | address | String | Always | Address of the venue | | foursquare_id | String | Optional | Foursquare identifier of the venue | | foursquare_type | String | Optional | Foursquare type of the venue, if known. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".) | | google_place_id | String | Optional | Google Places identifier of the venue | | google_place_type | String | Optional | Google Places type of the venue. (See supported types.) | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.147. InputMediaVideo > Represents a video to be sent Represents a video to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be video | | media | String | Always | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | | thumbnail | String | Optional | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » | | cover | String | Optional | Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | | start_timestamp | Integer | Optional | Start timestamp for the video in the message | | caption | String | Optional | Caption of the video to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the video caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | show_caption_above_media | Boolean | Optional | Pass True if the caption must be shown above the message media | | width | Integer | Optional | Video width | | height | Integer | Optional | Video height | | duration | Integer | Optional | Video duration in seconds | | supports_streaming | Boolean | Optional | Pass True if the uploaded video is suitable for streaming | | has_spoiler | Boolean | Optional | Pass True if the video needs to be covered with a spoiler animation | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.148. InputMediaVoiceNote > Represents a voice message file to be sent Represents a voice message file to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be voice_note | | media | String | Always | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | | caption | String | Optional | Caption of the voice message to be sent, 0-1024 characters after entities parsing | | parse_mode | String | Optional | Mode for parsing entities in the voice message caption. See formatting options for more details. | | caption_entities | Array of MessageEntity | Optional | List of special entities that appear in the caption, which can be specified instead of parse_mode | | duration | Integer | Optional | Duration of the voice message in seconds | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.149. InputMessageContent > This object represents the content of a message to be sent as a result of an inline query This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following types: * InputTextMessageContent * InputRichMessageContent * InputLocationMessageContent * InputVenueMessageContent * InputContactMessageContent * InputInvoiceMessageContent > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.150. InputPaidMedia > This object describes the paid media to be sent This object describes the paid media to be sent. Currently, it can be one of * InputPaidMediaLivePhoto * InputPaidMediaPhoto * InputPaidMediaVideo > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.151. InputPaidMediaLivePhoto > The paid media to send is a live photo The paid media to send is a live photo. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be live_photo | | media | String | Always | Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files ». Sending live photos by a URL is currently unsupported. | | photo | String | Always | The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files ». Sending live photos by a URL is currently unsupported. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.152. InputPaidMediaPhoto > The paid media to send is a photo The paid media to send is a photo. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be photo | | media | String | Always | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.153. InputPaidMediaVideo > The paid media to send is a video The paid media to send is a video. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the media, must be video | | media | String | Always | File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | | thumbnail | String | Optional | Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://" if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files » | | cover | String | Optional | Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://" to upload a new one using multipart/form-data under name. More information on Sending Files » | | start_timestamp | Integer | Optional | Start timestamp for the video in the message | | width | Integer | Optional | Video width | | height | Integer | Optional | Video height | | duration | Integer | Optional | Video duration in seconds | | supports_streaming | Boolean | Optional | Pass True if the uploaded video is suitable for streaming | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.154. InputPollMedia > This object represents the content of a poll description or a quiz explanation to be sent This object represents the content of a poll description or a quiz explanation to be sent. It should be one of * InputMediaAnimation * InputMediaAudio * InputMediaDocument * InputMediaLivePhoto * InputMediaLocation * InputMediaPhoto * InputMediaVenue * InputMediaVideo > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.155. InputPollOption > This object contains information about one answer option in a poll to be sent This object contains information about one answer option in a poll to be sent. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | text | String | Always | Option text, 1-100 characters | | text_parse_mode | String | Optional | Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed. | | text_entities | Array of MessageEntity | Optional | A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode. | | media | InputPollOptionMedia | Optional | Media added to the poll option | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.156. InputPollOptionMedia > This object represents the content of a poll option to be sent This object represents the content of a poll option to be sent. It should be one of * InputMediaAnimation * InputMediaLink * InputMediaLivePhoto * InputMediaLocation * InputMediaPhoto * InputMediaSticker * InputMediaVenue * InputMediaVideo > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.157. InputProfilePhoto > This object describes a profile photo to set This object describes a profile photo to set. Currently, it can be one of * InputProfilePhotoStatic * InputProfilePhotoAnimated > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.158. InputProfilePhotoAnimated > An animated profile photo in the MPEG4 format An animated profile photo in the MPEG4 format. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the profile photo, must be animated | | animation | String | Always | The animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass "attach://" if the photo was uploaded using multipart/form-data under . More information on Sending Files » | | main_frame_timestamp | Float | Optional | Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0. | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.159. InputProfilePhotoStatic > A static profile photo in the .JPG format A static profile photo in the .JPG format. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the profile photo, must be static | | photo | String | Always | The static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass "attach://" if the photo was uploaded using multipart/form-data under . More information on Sending Files » | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.160. Rich Messages: Complete Guide > Build fully formatted Telegram messages with blocks, HTML or Markdown: InputRichMessage, the block catalog, inline RichText styling, media layouts and limits. **Rich Messages** are fully formatted Telegram messages built from *blocks* — paragraphs, headings, lists, tables, collages, slideshows, quotations, media and more. They go far beyond plain `parse_mode` text: one message can mix media, structured layout, and inline text styling, similar to an HTML page. - Send them with [sendRichMessage](/sendrichmessage) (drafts with [sendRichMessageDraft](/sendrichmessagedraft)). - A sent rich message is returned as a [RichMessage](/richmessage) object containing its `blocks`. - Rich messages can also be edited ephemerally with [editEphemeralMessageText](/editephemeralmessagetext), [editEphemeralMessageMedia](/editephemeralmessagemedia) and related methods. #### Two Ways to Build a Rich Message The [InputRichMessage](/inputrichmessage) object supports three interchangeable content modes: | Field | Type | Description | | --- | --- | --- | | blocks | Array of InputRichBlock | Structured content as a list of block objects — full control over layout | | html | String | Content described with rich-message HTML formatting | | markdown | String | Content described with rich-message Markdown formatting | | media | Array of InputRichMessageMedia | Media used by tg://photo?id=, tg://video?id=, tg://document?id= and tg://audio?id= links | | is_rtl | Boolean | Show the message right-to-left | | skip_entity_detection | Boolean | Disable automatic detection of URLs, mentions, hashtags, etc. | #### Quick Start (HTML & Markdown Mode) For simple rich content, pass an HTML or Markdown string directly — Telegram renders it into blocks automatically: ```php ``` #### Structured Blocks Mode For precise layout, compose the message from typed blocks. Every block carries a `type` field; each type is documented on its own page in the list below. A simple example with one text paragraph containing bold inline text: ```php { "blocks": [ { "type": "paragraph", "text": { "type": "bold", "text": "Hello from Botlify Cloud!" } } ] } ``` #### Block Catalog Layout blocks (each page documents the exact fields): | Group | Blocks | | --- | --- | | Text | RichBlockParagraph, RichBlockSectionHeading, RichBlockDivider, RichBlockFooter | | Quotations | RichBlockBlockQuotation, RichBlockExpandableBlockQuotation, RichBlockPullQuotation, RichBlockThinking | | Lists & Tables | RichBlockList, RichBlockListItem, RichBlockTable, RichBlockTableCell | | Media Layouts | RichBlockCollage, RichBlockSlideshow, RichBlockPhoto, RichBlockVideo, RichBlockAudio, RichBlockVoiceNote, RichBlockDocument, RichBlockAnimation, RichBlockMap | | Interactive | RichBlockButtons, RichMessageButton, RichBlockAnchor, RichBlockDetails | #### Inline Text Styling (RichText) Inside text blocks, the [RichText](/richtext) family styles spans of text: [bold](/richtextbold), [italic](/richtextitalic), [underline](/richtextunderline), [strikethrough](/richtextstrikethrough), [spoiler](/richtextspoiler), [code](/richtextcode), [subscript](/richtextsubscript), [superscript](/richtextsuperscript), [datetime](/richtextdatetime), [custom emoji](/richtextcustomemoji), [math expressions](/richtextmathematicalexpression), and auto-detected entities like [URLs](/richtexturl), [mentions](/richtextmention), [hashtags](/richtexthashtag), [emails](/richtextemailaddress), [phone numbers](/richtextphonenumber), [bot commands](/richtextbotcommand), [cashtags](/richtextcashtag) and [bank card numbers](/richtextbankcardnumber). #### Limits Rich messages have dedicated size and content limits. See the official [Rich Message Limits](https://core.telegram.org/bots/api#rich-message-limits) section, and the [RichMessage](/richmessage) / [RichBlock](/richblock) reference pages for the returned objects. > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.161. inputrichblock > This object represents a block in a rich formatted message to be sent This object represents a block in a rich formatted message to be sent. Currently, it can be any of the following types: * InputRichBlockParagraph * InputRichBlockSectionHeading * InputRichBlockPreformatted * InputRichBlockFooter * InputRichBlockDivider * InputRichBlockMathematicalExpression * InputRichBlockAnchor * InputRichBlockList * InputRichBlockBlockQuotation * InputRichBlockExpandableBlockQuotation * InputRichBlockPullQuotation * InputRichBlockCollage * InputRichBlockSlideshow * InputRichBlockTable * InputRichBlockDetails * InputRichBlockMap * InputRichBlockButtons * InputRichBlockAnimation * InputRichBlockAudio * InputRichBlockDocument * InputRichBlockPhoto * InputRichBlockVideo * InputRichBlockVoiceNote * InputRichBlockThinking > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.162. inputrichblockanchor > A block with an anchor, corresponding to the HTML tag with the attribute name A block with an anchor, corresponding to the HTML tag `` with the attribute `name`. #### Fields | Field | Type | Required | Description | | --- | --- | --- | --- | | type | String | Always | Type of the block, always "anchor" | | name | String | Always | The name of the anchor | > [!TIP] > **Botlify Cloud Runtime** > Credentials are auto-injected in .env — always load them with getenv(): BOT_TOKEN, ADMIN_CHAT_ID, BOT_USERNAME. Main database: database.db (SQLite, WAL mode). Runtime errors: error.log. Quick test: send to $ADMIN_CHAT_ID. Full details: Runtime Reference. --- ### 13.163. inputrichblockanimation > A block with an animation, corresponding to the HTML tag