Telegram website screenshot

Telegram

Telegram is a cloud-based instant messaging and voice-over-IP service that provides a comprehensive Bot API for developers to build bots, automate workflows, send notifications, and create interactive experiences on the Telegram platform. The platform supports text messages, media sharing, payments, inline keyboards, inline queries, webhooks, and live location sharing.

2 APIs 0 Features
BotsChatMessagingNotificationsPaymentsTelegram

APIs

Telegram Bot API

The Telegram Bot API is an HTTP-based interface for building bots on Telegram. Bots are small programs that run inside Telegram and can do virtually anything — teach, play, sear...

Telegram TDLib (Telegram Database Library)

TDLib is a cross-platform, fully functional Telegram client library for third-party developers. TDLib takes care of all network implementation details, encryption and local data...

Collections

GraphQL

Telegram GraphQL Schema

A conceptual GraphQL schema for the Telegram Bot API, derived from the official

GRAPHQL

Pricing Plans

Telegram Plans Pricing

3 plans

PLANS

Rate Limits

Telegram Rate Limits

5 limits

RATE LIMITS

FinOps

Semantic Vocabularies

Telegram Context

12 classes · 31 properties

JSON-LD

API Governance Rules

Telegram API Rules

13 rules · 5 errors 6 warnings 2 info

SPECTRAL

JSON Structure

Telegram Message Structure

0 properties

JSON STRUCTURE

Example Payloads

Telegram Get Updates Example

2 fields

EXAMPLE

Telegram Send Poll Example

2 fields

EXAMPLE

Resources

🔗
LinkedIn
LinkedIn
🔑
Authentication
Authentication
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
🌐
DeveloperPortal
DeveloperPortal
🟢
StatusPage
StatusPage
📰
Blog
Blog
👥
GitHub
GitHub

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Telegram Bot API
  version: '9.5'
request:
  auth:
    type: apikey
    key: token
    value: '{{token}}'
    placement: query
items:
- info:
    name: Bot Info
    type: folder
  items:
  - info:
      name: Get Bot Info
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/getMe
    docs: A simple method for testing your bot authentication token. Returns basic information about the bot in the form of
      a User object.
  - info:
      name: Get User Profile Photos
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/getUserProfilePhotos
      body:
        type: json
        data: '{}'
    docs: Get a list of profile pictures for a user.
  - info:
      name: Get File
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/getFile
      body:
        type: json
        data: '{}'
    docs: Get basic info about a file and prepare it for downloading.
  - info:
      name: Set My Commands
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/setMyCommands
      body:
        type: json
        data: '{}'
    docs: Change the list of the bot commands.
  - info:
      name: Get My Commands
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/getMyCommands
      body:
        type: json
        data: '{}'
    docs: Get the current list of the bot commands.
- info:
    name: Getting Updates
    type: folder
  items:
  - info:
      name: Get Updates
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/getUpdates
      body:
        type: json
        data: '{}'
    docs: 'Receive incoming updates using long polling. Returns an array of Update objects. Notes: this method will not work
      if an outgoing webhook is set up.'
  - info:
      name: Set Webhook
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/setWebhook
      body:
        type: json
        data: '{}'
    docs: Specify a URL and receive incoming updates via an outgoing webhook.
  - info:
      name: Delete Webhook
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/deleteWebhook
      body:
        type: json
        data: '{}'
    docs: Remove webhook integration.
  - info:
      name: Get Webhook Info
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/getWebhookInfo
    docs: Get current webhook status.
- info:
    name: Messaging
    type: folder
  items:
  - info:
      name: Send Message
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendMessage
      body:
        type: json
        data: '{}'
    docs: Send text messages.
  - info:
      name: Forward Message
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/forwardMessage
      body:
        type: json
        data: '{}'
    docs: Forward messages of any kind.
  - info:
      name: Copy Message
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/copyMessage
      body:
        type: json
        data: '{}'
    docs: Copy messages of any kind without the forward marker.
  - info:
      name: Send Photo
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendPhoto
      body:
        type: json
        data: '{}'
    docs: Send photos.
  - info:
      name: Send Document
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendDocument
      body:
        type: json
        data: '{}'
    docs: Send general files.
  - info:
      name: Send Audio
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendAudio
      body:
        type: json
        data: '{}'
    docs: Send audio files as a playable music track.
  - info:
      name: Send Video
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendVideo
      body:
        type: json
        data: '{}'
    docs: Send video files.
  - info:
      name: Send Voice
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendVoice
      body:
        type: json
        data: '{}'
    docs: Send audio files as a voice message.
  - info:
      name: Send Location
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendLocation
      body:
        type: json
        data: '{}'
    docs: Send a point on the map.
  - info:
      name: Send Contact
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendContact
      body:
        type: json
        data: '{}'
    docs: Send phone contacts.
  - info:
      name: Send Poll
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendPoll
      body:
        type: json
        data: '{}'
    docs: Send a native poll.
  - info:
      name: Send Dice
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendDice
      body:
        type: json
        data: '{}'
    docs: Send an animated emoji that will display a random value.
  - info:
      name: Answer Callback Query
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/answerCallbackQuery
      body:
        type: json
        data: '{}'
    docs: Send answers to callback queries sent from inline keyboards.
- info:
    name: Message Editing
    type: folder
  items:
  - info:
      name: Edit Message Text
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/editMessageText
      body:
        type: json
        data: '{}'
    docs: Edit text and game messages.
  - info:
      name: Edit Message Caption
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/editMessageCaption
      body:
        type: json
        data: '{}'
    docs: Edit captions of messages.
  - info:
      name: Delete Message
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/deleteMessage
      body:
        type: json
        data: '{}'
    docs: Delete a message, including service messages.
- info:
    name: Chat Management
    type: folder
  items:
  - info:
      name: Get Chat
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/getChat
      body:
        type: json
        data: '{}'
    docs: Get up-to-date information about the chat.
  - info:
      name: Get Chat Administrators
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/getChatAdministrators
      body:
        type: json
        data: '{}'
    docs: Get a list of administrators in a chat.
  - info:
      name: Get Chat Member Count
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/getChatMemberCount
      body:
        type: json
        data: '{}'
    docs: Get the number of members in a chat.
  - info:
      name: Get Chat Member
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/getChatMember
      body:
        type: json
        data: '{}'
    docs: Get information about a member of a chat.
  - info:
      name: Leave Chat
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/leaveChat
      body:
        type: json
        data: '{}'
    docs: Use this method for your bot to leave a group, supergroup or channel.
  - info:
      name: Set Chat Photo
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/setChatPhoto
      body:
        type: multipart-form
        data:
        - name: chat_id
          type: text
          value: ''
        - name: photo
          type: text
          value: ''
    docs: Set a new profile photo for the chat.
  - info:
      name: Delete Chat Photo
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/deleteChatPhoto
      body:
        type: json
        data: '{}'
    docs: Delete a chat photo.
  - info:
      name: Set Chat Title
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/setChatTitle
      body:
        type: json
        data: '{}'
    docs: Change the title of a chat.
  - info:
      name: Set Chat Description
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/setChatDescription
      body:
        type: json
        data: '{}'
    docs: Change the description of a group, a supergroup or a channel.
  - info:
      name: Pin Chat Message
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/pinChatMessage
      body:
        type: json
        data: '{}'
    docs: Add a message to the list of pinned messages in a chat.
  - info:
      name: Unpin Chat Message
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/unpinChatMessage
      body:
        type: json
        data: '{}'
    docs: Remove a message from the list of pinned messages in a chat.
- info:
    name: Member Management
    type: folder
  items:
  - info:
      name: Ban Chat Member
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/banChatMember
      body:
        type: json
        data: '{}'
    docs: Ban a user in a group, a supergroup or a channel.
  - info:
      name: Unban Chat Member
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/unbanChatMember
      body:
        type: json
        data: '{}'
    docs: Unban a previously banned user in a supergroup or channel.
  - info:
      name: Restrict Chat Member
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/restrictChatMember
      body:
        type: json
        data: '{}'
    docs: Restrict a user in a supergroup.
  - info:
      name: Promote Chat Member
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/promoteChatMember
      body:
        type: json
        data: '{}'
    docs: Promote or demote a user in a supergroup or a channel.
  - info:
      name: Set Chat Administrator Custom Title
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/setChatAdministratorCustomTitle
      body:
        type: json
        data: '{}'
    docs: Set a custom title for an administrator in a supergroup promoted by the bot.
  - info:
      name: Approve Chat Join Request
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/approveChatJoinRequest
      body:
        type: json
        data: '{}'
    docs: Approve a chat join request.
  - info:
      name: Decline Chat Join Request
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/declineChatJoinRequest
      body:
        type: json
        data: '{}'
    docs: Decline a chat join request.
- info:
    name: Invites
    type: folder
  items:
  - info:
      name: Export Chat Invite Link
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/exportChatInviteLink
      body:
        type: json
        data: '{}'
    docs: Generate a new primary invite link for a chat.
  - info:
      name: Create Chat Invite Link
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/createChatInviteLink
      body:
        type: json
        data: '{}'
    docs: Create an additional invite link for a chat.
  - info:
      name: Revoke Chat Invite Link
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/revokeChatInviteLink
      body:
        type: json
        data: '{}'
    docs: Revoke an invite link created by the bot.
- info:
    name: Payments
    type: folder
  items:
  - info:
      name: Send Invoice
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/sendInvoice
      body:
        type: json
        data: '{}'
    docs: Send invoices.
  - info:
      name: Answer Shipping Query
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/answerShippingQuery
      body:
        type: json
        data: '{}'
    docs: Reply to shipping queries.
  - info:
      name: Answer Pre-Checkout Query
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/answerPreCheckoutQuery
      body:
        type: json
        data: '{}'
    docs: Respond to pre-checkout queries.
- info:
    name: Stickers
    type: folder
  items:
  - info:
      name: Create New Sticker Set
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/createNewStickerSet
      body:
        type: json
        data: '{}'
    docs: Create a new sticker set owned by a user.
  - info:
      name: Add Sticker to Set
      type: http
    http:
      method: POST
      url: https://api.telegram.org/bot{token}/addStickerToSet
      body:
        type: json
        data: '{}'
    docs: Add a new sticker to a set created by the bot.
bundled: true