Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telegram Getting Updates API

Methods for receiving incoming updates from Telegram

Telegram Getting Updates API is one of 10 APIs that Telegram publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Getting Updates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a GitHub repository, authentication docs, and a changelog.

This API exposes 4 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 9.5.

Requests are made against a single base URL, https://api.telegram.org/bot{token}.

4 operations 4 paths 8 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
9.5
Base URL
https://api.telegram.org/bot{token}
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Telegram Getting Updates API declares 1 security scheme for authenticating requests. An API key is passed in the path as token (BotToken). By default, every request must be authenticated.

  • BotToken — Bot authentication token obtained from @BotFather (embedded in URL path)

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Getting Updates 4

Methods for receiving incoming updates from Telegram

POST
/getUpdates
Get Updates
getUpdates body → 200
POST
/setWebhook
Set Webhook
setWebhook body → 200
POST
/deleteWebhook
Delete Webhook
deleteWebhook body → 200
POST
/getWebhookInfo
Get Webhook Info
getWebhookInfo → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Chat (9 properties), WebhookInfo (8 properties), User (7 properties), Message (6 properties). Each schema is shown below with its type and property counts.

UpdatesResponse
object
2 properties
User
object
7 properties 3 required
Chat
object
9 properties 2 required
BooleanResponse
object
2 properties
WebhookInfoResponse
object
2 properties
Message
object
6 properties 3 required
WebhookInfo
object
8 properties 3 required
Update
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telegram-getting-updates-api-openapi.yml Raw ↑

Other APIs Telegram publishes across the network.

Telegram TDLib (Telegram Database Library)
Telegram Bot Info API
Telegram Chat Management API
Telegram Invites API
Telegram Member Management API
Telegram Message Editing API
Telegram Messaging API
Telegram Payments API
Telegram Stickers API