Telegram API

我们为开发者提供三类 API。Bot API 可让你轻松创建以 Telegram 消息为界面的程序。Telegram API 与 TDLib 可用于构建你自己的定制客户端。两类 API 均可免费使用。此外,Gateway API 允许任何企业、应用或网站在 Telegram 上发送验证码以替代传统短信。

你也可以在网站中集成 Telegram 小部件

欢迎设计师为 Telegram 创作 动态贴纸与表情自定义主题


Bot API

通过此 API 可将机器人接入我们的系统。Telegram 机器人 是无需额外手机号即可创建的特殊账号,可作为你服务器上运行代码的接口。

使用 Bot API 无需了解 MTProto 加密协议,我们的中间服务器会代为完成与 Telegram API 的加密与通信。你只需通过简单的 HTTPS 接口与服务器通信即可。

了解更多 Bot API 请点击此处 »

机器人开发者还可使用 支付 API 接受全球 Telegram 用户的 付款


TDLib – 构建你自己的 Telegram

即使需要深度定制,也无需从零开发。可使用我们的 Telegram Database Library(简称 TDLib),帮助第三方开发者快速构建高速、安全、功能丰富的 Telegram 应用。

TDLib 负责 网络实现加密本地数据存储 等细节,让你把精力集中在设计、交互与动效上。

TDLib 支持 Telegram 全部特性,可在 Android、iOS、Windows、macOS、Linux 等平台使用。库为开源,并兼容 多种编程语言

了解更多 TDLib 请点击此处 »


Gateway API

Telegram Gateway API 允许任何企业、应用或网站 通过 Telegram 发送验证码以替代传统短信 ,在 降低成本 的同时提升验证码的安全性送达速度,触达 Telegram 的月活用户。用户将在 Telegram 内的专用对话中即时收到验证码消息。

Telegram Gateway API 可免费试用,了解更多 »


Telegram API

本 API 用于构建您自己的 Telegram 客户端,对希望在我们平台上开发 Telegram 应用的开发者完全开放。可参考现有 Telegram 应用的开源代码了解实现方式,并记得在系统中注册您的应用。

入门

创建应用

如何获取应用标识并创建新的 Telegram 应用。

用户授权

如何注册用户手机号以开始使用 API。

两步验证

用户开启两步验证后如何登录其账号及修改密码。

扫码登录

二维码登录流程。

错误处理

如何正确处理 API 返回的错误。

多数据中心

如何连接最近的 DC 接入点以提升 API 交互速度,及开发客户端时的注意事项。

处理更新

如何订阅并正确处理更新。

处理 PUSH 通知

如何订阅并正确处理。

频道、超级群组、巨型群组与基础群组

如何区分与处理频道、超级群组、巨型群组和基础群组。

论坛

Telegram 支持创建多话题论坛。

向频道发送私信

Telegram 支持向频道发送私信,也可用于推荐(含付费)频道帖子。

频道统计

Telegram 为频道与超级群组提供详细统计。

调用方法

调用方法时的额外选项。

上传与下载文件

如何正确传输大批量数据。

分页

如何从大量对象列表中获取结果。

客户端配置

MTProto API 提供多种客户端配置参数,可通过相应方法获取。

安全

秘密聊天与端到端加密

端到端加密消息。

安全指南

客户端应用中必须完成的重要检查。

完美前向保密

临时授权密钥与永久密钥的绑定。

语音与视频通话的端到端加密

端到端加密通话。

优化

客户端优化

提升 API 交互效率的方法。

API 方法

可用方法列表

可用高级方法列表。

API TL 结构JSON 格式

API 中使用的类型与方法的文本及 JSON 表示。

Layer 更新日志

各版本结构的详细更新说明。

其他文档

使用 MTProto API 开发机器人

如何通过 MTProto API 开发与使用机器人。

Bot API 会话 ID

Bot API 会话 ID 是由用户、群组、频道与秘密聊天 ID 派生的唯一 64 位会话 ID,在各类会话中保持唯一。

本页说明如何将 MTProto 会话 ID 与 Bot API 会话 ID 相互转换。

命令

机器人可提供一组命令,供用户在私聊或群聊中使用。

按钮

用户可通过按钮内联按钮与机器人交互,可在任意对话的消息中直接使用。

菜单按钮

机器人可设置输入框旁菜单按钮的展示与行为。

内联查询

用户可通过内联查询与机器人交互,在任意对话的输入框中即可使用。

游戏

机器人可提供 HTML5 游戏,供用户单人游玩或在群组与私聊中对战;以及如何在 MTProto API 中处理游戏。

小程序

机器人可提供交互式 HTML5 小程序,用于替代任意网页

推广计划

开发者可为自己的 小程序 开设推广计划,让内容创作者、其他小程序开发者任意 Telegram 用户参与推广并从中获得佣金。

附件菜单

机器人可在附件菜单中添加入口,提供易用、通用的小程序。

动态

用户与频道可通过 API 方便地发布与查看 动态

相似频道与机器人

API 提供获取主题相似的公开频道与机器人列表的方法,依据订阅用户的相似度进行筛选。

强调色

用户与频道可更改个人页与消息的强调色和背景图案。

隐私设置

用户可设置细粒度隐私选项,控制哪些用户能以何种方式与其互动。

搜索与筛选

在对话中搜索消息时可使用详细筛选条件,服务端可按文本甚至消息类型过滤,图形客户端常用此实现聊天相册、头像墙等功能。

投票

支持在对话与频道中发送投票与测验,可由大量用户参与。

清单

高级用户可在任意对话中创建协作清单,用于任务跟踪与团队协作,或管理购物与待办。

反应

用户可使用指定表情对任意消息添加反应,并触发 Lottie 动画。

消息动效

可为发送的消息添加动效。

表情分类

贴纸、自定义表情与 GIF 选择界面应提供分类列表,便于按表情或其他条件快速筛选。

表情状态

用户可将表情或 自定义表情 设为状态,显示在对话与资料中的名称旁。

邀请链接与加群申请

频道、基础群组与超级群组可有公开用户名或私密邀请链接;私密链接可配合按用户审核的加群申请使用。

频道、超级群组与群组的管理员、封禁与默认权限

如何在频道、群组与超级群组中处理管理员权限、细粒度封禁与全局权限。

讨论组

群组可作为 讨论组频道 关联,供用户讨论帖子。

频道评论与消息主题

通过消息主题,可对 频道帖子 或普通 群组消息 进行评论。

管理员日志

超级群组与频道均提供 管理员日志,记录近期相关操作,如管理员修改群组/频道设置、踢人与封禁等。

置顶消息

可将多条消息置顶于指定对话顶部。

提及

支持在消息中提及其他用户,并可快速跳转查看这些提及。

定时消息

支持定时发送消息。

实时位置

支持在对话中发送用户实时位置,并可设置接近提醒。

会话数据库

如何在 API 中处理会话信息。

最小构造器

群组更新中的 userchannel 构造器有时不包含完整用户信息,此处说明如何处理。

注销账号

如何注销 Telegram 账号。

导入消息

支持从其他聊天应用导入消息与媒体。

Telegram Passport

如何通过 MTProto API 直接使用 Telegram Passport

Telegram 支付

如何通过 MTProto API 直接使用 Telegram 支付。

第三方核验

为提升透明度,官方认可的第三方服务可为用户账号与对话分配额外核验标识,以防范诈骗减少不实信息

消息实体与样式文本

如何使用消息实体生成带样式的文本。

GIF

客户端支持展示 GIF。

贴纸

客户端支持展示动态、静态与视频贴纸。

自定义表情

支持在消息中直接使用自定义动态、静态与视频表情。

动态表情

图形客户端应将表情转换为对应的动态版本。

骰子动画

支持发送 动态骰子 表情。

消息草稿

如何处理消息草稿。

文件夹

对话文件夹的使用。

常用会话评分

已开启常用会话 的评分表示该会话在对应 分类(如常聊用户、常用机器人、内联机器人、常看频道等)中的相关度。

文件引用

如何处理文件引用。

Telegram 一键登录

处理 Telegram 一键登录的 URL 授权请求。

壁纸

如何设置与使用聊天背景。

通知铃声

如何设置聊天通知铃声。

语音转文字

如何将语音消息转成文字。

消息翻译

支持翻译对话消息,Telegram 高级版 用户还可开启实时对话翻译。

内置反垃圾系统

达到一定成员数的超级群组管理员可启用 Telegram 自有反垃圾算法的强力模式,开启自动化反垃圾的“激进”模式。

收藏品

用户可通过 用户名 方便他人联系或找到其公开群组与频道;客户端也可为账号、超级群组与频道绑定多个 Fragment » 收藏用户名Fragment » 还支持购买可用于注册 Telegram 的手机号收藏品。

Telegram 高级版

Telegram 高级版为可选订阅服务,可解锁更多客户端与 API 专属功能,并支持应用持续开发。这是 Telegram 可持续变现的一部分——由用户驱动,而非广告主或股东。从而保持独立并优先服务用户。

Telegram 商务

用户可将账号升级为商务账号,使用营业时间、位置、快捷回复、自动消息、自定义启动页、聊天机器人等商务功能。

目前所有 Telegram 商务功能对 Telegram 高级版 订阅用户免费开放。

Telegram Stars

Telegram Stars 为虚拟物品,用户可用其在 Telegram 生态内的机器人与小程序中购买数字商品与服务、向创作者赠送礼物等。

订阅

机器人与频道可创建订阅,定期向用户收取一定数量的 Telegram Stars 以提供内容与服务。

礼物

用户可向好友发送礼物。收到礼物的一方可在资料页展示,或兑换为 Telegram Stars »。Stars 可用于支持创作者、在小程序中购买服务等。

付费媒体

创作者可在频道发布付费图片或视频并收取 Stars,订阅者需向作者付费解锁后才能查看。

付费消息

向已开启 Star 消息 » 的用户、超级群组或频道发消息时,可使用 Telegram Stars 按条支付。

推荐帖子

频道管理员可使用推荐帖子进行变现。

频道与超级群组助力

Telegram 高级版 用户可通过为频道助力,为其解锁发布 动态 等额外功能。

抽奖与礼物

频道 管理员可发起抽奖,随机向订阅者发放 Telegram 高级版 订阅及其他礼物,以换取 助力

操作栏

在私聊或秘密聊天中与用户互动时,有时需在对话顶部显示操作栏,提供快捷按钮或与该用户相关的提示。

收藏夹

收藏夹对话用于保存消息与媒体,相当于个人云存储,可随时转发或发送内容到该对话。

个人资料

Telegram 提供丰富的个人资料自定义选项。

主题

应用支持生成、分享与同步主题。

赞助消息

若应用会展示 Telegram 频道 内容,必须支持频道中的官方赞助消息

频道与机器人广告收入

Telegram 提供业内分成比例最高的激励之一,频道与机器人所有者可获得其频道与机器人中展示广告收入的 50%

本页说明如何提现频道与机器人广告收入及查看详细收入统计。

事实核查

客户端支持展示由独立核查机构为消息添加的事实核查信息。

联系人

在 API 中处理联系人。

黑名单

黑名单相关操作。

附近的人与对话

如何实现基于地理位置的功能,如地理聊天与附近用户。

年龄验证

部分地区要求对受限内容进行年龄验证,Telegram 通过特定机器人的 主小程序 实现。

网页事件

在与 HTML5 游戏及支付网关网页交互时,Telegram 应用需提供相应的 JS API。

深度链接

客户端必须通过注册系统级处理程序,处理消息、链接实体及其他应用中出现的 tg://t.me 深度链接。

数据导出

用户可通过导出 API 导出其全部数据。