Developer documentation

Telegram developer documentation: API, TDLib, Bot API and MTProto

Explore Telegram development with GetTGAPI: API ID and Hash, user authorization, ERROR troubleshooting, TDLib and bot development, with guides and official references.

GetTGAPI editorial teamUpdated 2026 / 10 / 18

GETTGAPI / DOCUMENTATION

Start with what you are building

62 documents covering clients, bots, payments and protocols.

Methods & types

Search documentationTopic

62 documents found

Credentials & login

How to get Telegram API ID and API Hash: the official process
Apply for your Telegram api_id and api_hash through the official portal. Follow verification, app details and result checks, or ask GetTGAPI support about ERROR.
Telegram authorization and codes: client login versus API application
Understand official authorization terminology, delivery-state limits and the difference between client login and obtaining API ID through the developer portal.
Telegram website login, OIDC and Passport
Distinguish website sign-in, Telegram client authorization and identity-document sharing, with verified callbacks and tokens.
Telegram two-step verification, QR login and passkeys
Separate two-step password checks, QR confirmation and passkey eligibility when designing a Telegram login flow.

Client foundations

Telegram API initialization, layers and client configuration
Understand connection initialization, API layers, runtime limits and a practical upgrade sequence for Telegram clients.
Telegram data-center migration and sessions
Handle DC addresses, migration responses, authorization transfer and temporary keys without confusing connection failures with invalid credentials.
Telegram deep links, action bars and Web events
Route Telegram links by type and validate action-bar capabilities and WebView event origins.
Telegram peers, access_hash and min objects
Understand peer identity, access hashes and reduced objects, and keep account-scoped caches consistent.
Telegram push notifications and client performance
Distinguish push wakeups, message synchronization and read receipts for reliable notification delivery.
Telegram RPC error handling: FLOOD_WAIT and portal ERROR
Read official RPC error categories and GetTGAPI diagnostic guidance to distinguish API errors, HTTP responses, result parsing and developer-portal failures.
Telegram updates: ordering, differences and reconnection
Understand update ordering and difference recovery, with a practical design for avoiding lost messages and duplicate actions.

Messages & conversations

Telegram AI editing, transcription and message translation
Distinguish AI rewriting, audio transcription and translation while preserving originals and handling pending results.
Telegram folders, Saved Messages and frequent peers
Distinguish dialog filters, archives, saved dialogs and frequent-peer ratings when building navigation.
Telegram text entities, mentions and drafts
Handle UTF-16 offsets, emoji, mentions and synchronized drafts without corrupting message formatting.
Telegram message pagination, search and caching
Distinguish message cursors, search filters and cache hashes to prevent duplicate pages and premature history termination.
Telegram polls, quizzes and collaborative checklists
Handle poll option identities, result updates, checklist items and collaboration permissions.
Telegram scheduled and pinned messages
Distinguish scheduled and delivered message identifiers and retrieve complete pinned-message lists.
Telegram stories, read state and live location
Distinguish story eligibility, history reads, content reads, view metrics and live-location sharing.

Media & calls

Telegram emoji, stickers, GIFs and reactions
Distinguish Unicode emoji, custom emoji, stickers, GIFs, effects and reactions in a performant picker.
Telegram uploads, downloads and file_reference
Understand chunked transfer, media data centers, temporary uploads and refreshing expired file references.
Telegram voice, video and group calls
Separate signaling, media engines and encryption across one-to-one calls, livestreams and conferences.

Groups & channels

Telegram groups, channels, forums and channel messages
Distinguish basic groups, supergroups, broadcast channels, forum topics and direct channel messages.
Telegram invites, join requests and channel comments
Distinguish public usernames and private invites, and map channel comments to their linked discussion threads.
Telegram moderation, permissions and admin logs
Understand admin capabilities, member restrictions, role labels and native antispam with auditable moderation.

Accounts & privacy

Telegram data export, history import and account deletion
Distinguish export, import, logout and account deletion with scoped confirmation and verifiable completion.
Telegram privacy, contacts and blocklists
Understand phone-lookup restrictions, privacy rules and blocklist scope without misclassifying unavailable accounts.
Telegram profiles, avatars, themes and notification sounds
Handle profile updates, avatars, palettes, wallpapers, themes, emoji status and notification sounds consistently.
Telegram verification indicators, age checks and restrictions
Distinguish third-party verification from platform badges and honor configured content restrictions.

Payments & business

Telegram Business and connected bots
Understand business settings, automated replies and connected-bot permissions with isolated customer contexts.
Telegram gifts, auctions and collectibles
Distinguish gifts, collectibles, auction state and Fragment usernames with accurate ownership and transaction handling.
Telegram paid media, paid messages and suggested posts
Distinguish content purchases, message fees and suggested posts, including confirmation, unlocking and protection.
Telegram Premium, boosts and giveaways
Use current capabilities and configuration for Premium features, boost levels, giveaways and recommendations.
Telegram Stars balances, payments and subscriptions
Understand client-side Stars balances, payment results, refunds and subscriptions without conflating purchase cost and withdrawable revenue.
Telegram statistics, sponsored content and fact-checks
Understand statistics permissions, sponsored-message presentation, revenue and fact-check metadata.

Bot development

Telegram AI bots, guest mode and bot-to-bot communication
Understand streaming drafts, guest bots and bot-to-bot eligibility while preventing duplicate replies and loops.
Telegram Bot development and capability selection
Start with BotFather and tokens, then choose commands, buttons, Mini Apps or human support for your workflow.
Telegram Bot commands, buttons, menus and profile
Distinguish command menus and message buttons, handle callbacks, refresh profiles and preserve bot-management permissions.
Telegram Bot payments: Stars, orders and refunds
Choose the correct payment flow, verify successful_payment before fulfillment and retain charge identity for refunds.
Telegram Bot webhooks, long polling and deployment
Choose long polling, webhooks or Telegram Serverless, with clear certificate, acknowledgment and retry boundaries.
Telegram inline bots and HTML5 games
Understand inline queries, shared results, game callbacks and score submission while keeping tokens server-side.

Mini Apps

Telegram Mini Apps: authentication, UI and launch paths
Understand server-side validation, main and attachment entry points, safe areas and referral programs.

MTProto & security

MTProto authorization keys and transports
Understand key exchange, byte order, framing and TCP/WebSocket transport without reusing example secrets.
MTProto 2.0 structure and reading path
Navigate schemas, encrypted messages and transport layers while separating current MTProto from deprecated version 1.0.
MTProto service messages, acknowledgments and recovery
Understand RPC correlation, acknowledgments, salts and resends without confusing response cancellation with undoing an action.
TDLib group-call encryption and state verification
Understand the TDLib state chain, shared keys, signatures and emoji verification with explicit trust boundaries.
Telegram secret chats, rekeying and message order
Understand secret-chat boundaries, sequence checks and rekeying without mistaking HTTPS or ordinary bot chats for end-to-end encryption.
Telegram TL language, types and serialization
Read TL constructors, methods, flags, vectors and serialization before generating client bindings.

TDLib & platforms

TDLib Android build guide
Prepare the SDK, NDK and OpenSSL, choose Java or JSON, and build TDLib for Android ABIs.
TDLib builds for iOS and Apple platforms
Build OpenSSL, TDLib and an XCFramework for iOS, macOS, watchOS, tvOS and visionOS.
TDLib C++ ClientManager requests and resources
Understand client IDs, nonzero request IDs, asynchronous responses and resource management in ClientManager.
TDLib C++ integration and examples
Install TDLib with CMake, configure Td_DIR, build C++ examples and provide runtime libraries.
TDLib C# and .NET integration
Build the TDLib .NET interface with C++/CLI and check x86/x64, vcpkg dependencies and the example project.
TDLib JSON interface and multiple clients
Use the pinned TDLib header to understand td_send, td_receive, correlation, integer encoding and pointer lifetimes.
TDLib language and platform examples
Find TDLib bindings, build instructions and source examples for Python, JavaScript, Go, Java, C++, Swift, Dart and more, with official references on GetTGAPI.
TDLib overview and builds
Learn about TDLib features, C++17 build requirements, CMake commands, Java/.NET bindings and JSON compatibility, with official sources on GetTGAPI.
TDLib Python and Java development guide
Prepare shared libraries, call tdjson from Python, build Java JNI and JSON examples, and troubleshoot dependency errors with this TDLib development guide.
TDLib requests, state, options and notifications
Handle asynchronous requests, updates, options and notification groups with reliable history and UI state.
TDLib Swift development example
Install TDLib into the example directory, build the Swift macOS project in Xcode and locate the JSON reference.
TDLib UWP development guide
Build a Universal Windows Platform SDK, Visual Studio extension or NuGet package and run the C# example.
TDLib WebAssembly build guide
Use Emscripten to build TDLib for browsers, prepare OpenSSL and produce the tdweb package.
Integrating tdweb in a browser
Create TdClient, send requests, handle updates and understand JSON fields, int64, bytes and @extra.

API reference

Telegram API reference: method and type index
Search Telegram API, TDLib and Bot API methods and types on GetTGAPI, then open the matching official signatures and parameter references.

Choose a reference before you build

GetTGAPI (gettgapi.com) organizes Telegram documentation around practical development tasks: API credentials, account authorization, error handling and TDLib integration. This independently maintained hub cites official sources on each page. Use the directory above to choose a topic, or search for a function name in the method and type index.

Looking for “Telegram apiid”, “get api_id / api_hash” or “Telegram API application ERROR”? Start with the API ID and Hash application guide, then the portal ERROR guide if needed. Installing a library, authorizing an account and creating a developer application are separate tasks.

Start with these topics

Your task	Guide	What it covers
Obtain your own API ID and API Hash	Developer-portal application process	Application steps and requirements
Distinguish verification and client authorization	User authorization and code delivery	Code types and authorization flows
Identify where an ERROR originates	RPC errors and portal ERROR	Error categories and troubleshooting
Understand TDLib and its build requirements	TDLib overview, builds and JSON	Features, dependencies and interfaces
Find an integration by language	TDLib language and platform examples	Language bindings and source examples
Run a Python or Java example	Python, Java, JNI and libraries	Shared libraries, builds and execution

Use the language control to switch between Chinese and English. Each page includes official sources and a review date. TDLib pages also provide the source files and license for the referenced version.

Coverage and versions

The directory covers credentials and authorization, messages, media, communities, privacy, business features, bots, Mini Apps, MTProto and TDLib. All 62 documents have Chinese and English pages. Eleven preserve the complete referenced TDLib document; the others provide task-oriented explanations with official references.

The method and type index contains a separate 6,481 named entries linking to pinned source definitions or official Bot API sections. These entries are not counted as articles. Check the original reference for parameter details, restrictions and permissions; the guides do not replace the complete official manuals, and historical protocols are not a default implementation for new projects.

Terminology: keep these concepts separate

Term / identifier	Meaning in this hub	Common confusion
API ID / api_id / apiid	Application ID	Not a phone number or website order number
API Hash / api_hash / apihash	Application Hash	Not a one-time verification code
Bot Token	Bot credential	Not interchangeable with ID / Hash
authorization	Account authorization in client contexts	Not purchasing a GetTGAPI access code
access code	GetTGAPI application allowance	Not a Telegram API credential
update	An incoming event in API contexts	Not necessarily a software upgrade
binding / wrapper	A language binding or convenience layer	Not an independent Telegram service
shared library	A dynamically loaded library	Its architecture must match the calling program
JSON interface	An interface boundary	Binary compatibility differs from API-method compatibility

Reading and usage notes

Check the official sources, applicable revision and review date in the source panel.
Compare identifiers, parameters, conditions and units with the pinned original. A title alone does not establish applicability.
Preserve command spelling and replace placeholders. Never substitute a website access code for API Hash.
To report an error, contact support with the article URL, section and source evidence. Do not send codes, session files or a complete API Hash.

When you need application assistance

GetTGAPI sells developer-portal assistance; Telegram API itself is free. You can follow the official application process yourself. For portal ERROR or workflow questions, visit gettgapi.com/en/help#contact. If you already have an access code, use gettgapi.com/en/redeem. Documentation remains free to read, and assistance does not promise to remove Telegram restrictions.