Your browser version is too low, some content may not display properly, please download the latest version!

创建机器人

在Potato客户端中搜索@BotFather,然后完成下面的步骤:

  • 打开BotFather聊天框,输入 /newbot 命令。
  • 输入机器人的昵称。
  • 输入机器人唯一的用户名。
  • 收到创建成功消息及token时表示创建完成

机器人token

每个机器人在创建时都会获得一个唯一的token来标志身份。 例如 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11, 机器人所有的接口调用都必须带上token, 请妥善保管。 参考创建机器人获取token。

所有机器人接口调用必须通过HTTPS,格式如下所示: https://api.rct2008.com:8443/<bot_token>/METHOD_NAME 例如机器人获取自身信息: https://api.rct2008.com:8443/123456909:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/getMe

我们支持GET和POST HTTP方法。API请求中传递参数的三种方式:

  • URL query string
  • Application/json (最常用的json格式传递请求参数)
  • Multipart/form-data (表单仅在上传文件时使用)

响应返回一个JSON对象,该对象始终有一个布尔字段“ok”和可能携带一个关于结果描述String字段“result”。 如果“ok”等于true,则请求成功,返回的数据在“result”字段中。 如果请求失败,则“ok”等于false,返回一个整数“error_code”字段,表示请求的错误码和返回一个“result”字段,包含错误描述。

  • API中的所有接口名都区分大小写
  • 所有请求必须使用UTF-8编码

机器人如何接收消息

  • 有新消息发送到bot时, 机器人有两种方式获取消息:
  • 主动模式: 机器人需要不停的的主动去调用getUpdates接口来获取消息,成功请求后,将收到一个包含消息更新列表的json对象。
  • 被动模式: 机器人需要调用一次setWebhook接口,设置好回调地址。当有新消息时,Potato服务器会向机器人设置的地址POST消息,机器人同样收到一个包含消息更新列表的json对象

发给机器人的消息会在服务器上缓存一段时间,当机器人处理了消息立即删除,超过1个小时未处理也将清除。

获取更新时发出请求

如果您使用的是webhooks,可以在获取到内容的同时向机器人发送API请求。指定要调用的方法并使用application/json或application/x-www-form-urlencoded或multipart/form-data类型来传递参数,请求成功后将得到相应结果。

获取消息更新

Potato机器人目前支持两种互斥的方式来为您的机器人接收消息更新:一种是使用getUpdates方法,另一种是使用webhooks方法。机器人的消息先会存储在Potato服务器上,直到机器人开发者以任何一种方式收到它们为止(但它们的保存时间不会超过24小时)。无论选择哪个选项,都会收到JSON序列化的Update对象。

Update

机器人收到的消息结构体如下。 有四种消息类型,普通消息, 编辑消息, 内联查询消息,按钮回调消息, 每次只会收到其中一种类型的消息。

参数类型说明
update_idInteger当前收取的消息的ID,每收取一次消息,ID值从1开始递增
messageMessage可选。 最常见的消息 — 文本, 图片, 贴图,视频等。
edited_messageMessage可选。 被编辑过的消息。
inline_queryInlineQuery可选。 内联查询消息,例如在聊天框使用@gif或者@pic时机器人收到的消息
callback_queryCallbackQuery可选。 当点击机器人生成的 内联按钮时收到的消息。
langStringPotato客户端语言, 'en' 表示英文版 'zh'表示简体中文版。
os_typeStringPotato客户端类型 例如pc代表电脑端等。

getUpdates

请求URL

  • https://api.rct2008.com:8443/<bot_token>/getUpdates

请求方式

  • GET

接口描述

  • 机器人调用此接口主动拉取消息也叫长轮旬(wiki)。 返回 Update 结构的数组。
返回参数

返回 Update 结构的数组

返回结果

{ "ok": true, "result": [ { "update_id": 1, "message": { "message_id": 57, "chat": { "id": 11370003, "type": 2, "title": "group1" }, "from": { "id": 22800001, "first_name": "David", "last_name": "Smith", "username": "" }, "text": "123", "date": 1544440630 }, "inline_query": null, "lang": "en" } ] }

注意

  • 当给机器人设置了 webhook 则getUpdates接口将失效

setWebhook

请求URL

  • https://api.rct2008.com:8443/<bot_token>/setWebhook

请求方式

  • POST

接口描述

  • 调用这个接口来设置一个地址来接收来自Potato服务的消息。 当机器人有新消息时,Potato服务器会向机器人设置的地址发送POST请求,消息为Update。为确保请求可以成功,服务器有重试机制,如果多次向webhook地址发消息失败,机器人会放弃请求。
  • 为确保webhook请求是来自Potato,我们推荐使用安全的地址, 例如 https://www.example.com/<bot_token> 因为没人知道你的机器人token,可以确定请求来自Potato。
请求参数
参数是否必填类型说明
urlYesString接收消息的http地址
certificateOptionalInputFile or String不填表示使用http不使用https。如果使用https,填写数字证书的文件id,预先已经上传到Potato服务器。 或者表单提交 multipart/form-data 数字证书文件
请求示例

{ "url": "https://127.0.0.1/web-mobile", "certificate": "00050000321djau921030213" }

注意

  1. 如果设置了webhook机器人的getUpdates接口将失效。
  2. 如果使用自签名的证书,必须通过certificate参数上传公钥。 通过文件的方式上传,发送文件ID不生效。

delWebhook

请求URL

  • https://api.rct2008.com:8443/<bot_token>/delWebhook

请求方式

  • GET

接口描述

  • 如果您决定切换回getUpdates方式接收消息,请使用此方法删除webhook地址。

Getting Information

getMe

请求URL

  • https://api.rct2008.com:8443/<bot_token>/getMe

请求方式

  • GET

接口描述

  • 一种测试机器人token是否有效的简单方法, 不需要参数。 以User对象的形式返回该机器人的基本信息。
返回结果

{ "ok": true, "result": { "id": 10100427, "first_name": "ll_bot", "last_name": "", "username": "ll_bot" } }

返回参数
参数说明
id机器人的唯一ID
first_name机器人的名称
last_name为null。 机器人忽略此参数。
username机器人的用户名,全局唯一

getFile

请求URL

  • https://api.rct2008.com:8443/<bot_token>/getFile

请求方式

  • POST

接口描述

  • 使用此方法可获得有关文件的基本信息,并准备将其下载。 目前,机器人可以下载最大100MB的文件。 成功后,将返回一个File对象。 可以通过https://api.rct2008.com:8443/<bot_token>/<file_path>链接下载文件 。
请求参数
参数是否必填类型说明
file_idYesString将要获取文件信息的文件ID
请求示例

{ "file_id": "000001009814fcd09659fdcd80bf5224" }

返回参数
参数类型说明
urlString文件的下载地址
返回结果

{ "ok": true, "result": { "url": "https://api.rct2008.com:8443/files/10000000:p6KKlJ7JWa6XKEj7cJ6/0000fcd09659fdcd80bf5224.mp3" } }


Send A Message

sendTextMessage

请求URL

  • https://api.rct2008.com:8443/<bot_token>/sendTextMessage

请求方式

  • POST

接口描述

  • 发送消息接口,可以向用户,群组,频道发送消息,发送成功,则返回消息的ID。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
textYesString将要发送的消息
reply_to_message_idOptionalInteger如果是回复消息, 则表示原始消息的ID
markdownOptionalBoolean是否使用markdown语法来渲染, Entities 将根据文本字段自动生成。 详细信息请参考 Rich Text
reply_markupOptionalReplyMarkup自定义键盘。包括 内联按钮键盘按钮删除键盘 ,回复键盘
请求示例

{ "chat_type":1, "chat_id":20216742, "text":"aaqwerwqerwqerwerqwrqwerqwerqrqwerqwerwerqa", "markdown" : true, "reply_markup":{ "type": 4, "inline_keyboard": [ { "buttons": [ { "text": "Button1", "callback_data": "123" }, { "text": "Button2", "callback_data": "abcde" } ] }, { "buttons": [ { "text": "Button3", "callback_data": "22222" }, { "text": "Button4", "callback_data": "333" } ] } ] } }

返回参数
参数类型说明
message_idInteger消息ID
返回结果

{ "ok": true, "result": { "message_id": 27315 } }

Formatting options

  • 机器人支持几种基本的markdown语法。包括字体加粗、倾斜、链接、代码段。
  • 注意当您在Potato客户端打开一个链接时,客户端会弹出一个警告窗来提时您是否确认要打开链接。
  • 关于markdown的详细内容请参考富文本

forwardMessage

请求URL

  • https://api.rct2008.com:8443/<bot_token>/forwardMessage

请求方式

  • POST

接口描述

  • 转发机器人或用户消息。 调用成功将返回消息的ID。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
from_chat_typeYesChatType源会话类型
from_chat_idYesInteger原始消息ID
message_idYesInteger将要被转发的消息的ID
请求示例

{ "chat_type": 1, "chat_id": 8000012, "from_chat_type": 1, "from_chat_id": 8000042, "message_id": 523621234 }

返回参数
参数类型说明
message_idint消息ID
返回结果

{ "ok": true, "result": { "message_id": 27315 } }


answerCallbackQuery

请求URL

  • https://api.rct2008.com:8443/<bot_token>/answerCallbackQuery

请求方式

  • POST

接口描述

  • 当用户点击内联按钮时调用此方法来进行回复。 回复的内容将会以气泡弹窗的形式显示在客户端,如果按钮是链接,则以警告弹窗的形式显示在客户端。
请求参数
参数是否必填类型说明
inline_message_idYesString将要回复的内联消息的ID
textYesString通知文本。 如果未指定,则不会向用户显示任何内容, 0 - 200 个字符
show_alertOptionalBoolean如果为true,则客户端将显示警报,而不是聊天屏幕顶部的通知。 默认是 false
urlOptionalString只用作游戏链接,可忽略
cache_timeOptionalInteger回调查询的结果可以在客户端缓存的最长时间(以秒为单位)
请求示例

{ "inline_message_id": "521521325217527362323", "text": "Alert", "show_alert": true }

返回结果

{ "ok": true, "result": null }


sendLocation

请求URL

  • https://api.rct2008.com:8443/<bot_token>/sendLocation

请求方式

  • POST

接口描述

  • 使用此接口向用户发送地理位置,调用成功,返回消息ID
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
latitudeYesFloat纬度
longitudeYesFloat经度
reply_to_message_idOptionalInteger如果是回复消息, 则表示原始消息的ID
reply_markupOptionalReplyMarkup自定义键盘。包括 内联按钮键盘按钮删除键盘 ,回复键盘
请求示例

{ "chat_type": 1, "chat_id": 8000023, "latitude": 212.03, "longitude": 54.12 }

返回参数
参数类型说明
message_idInteger消息ID
返回结果

{ "ok": true, "result": { "message_id": 27315 } }


sendVenue

请求URL

  • https://api.rct2008.com:8443/<bot_token>/sendVenue

请求方式

  • POST

接口描述

  • 发送详细的地理位置,调用成功返回消息ID。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
latitudeYesFloat纬度
longitudeYesFloat经度
titleYesString标题
addressYesString详细地址
foursquare_idOptionalStringFoursquare ID
reply_to_message_idOptionalInteger如果是回复消息, 则表示原始消息的ID
reply_markupOptionalReplyMarkup自定义键盘。包括 内联按钮键盘按钮删除键盘 ,回复键盘
请求示例

{ "chat_type": 1, "chat_id": 8000023, "latitude": 33.6, "longitude": -111.9, "title": "Musical Instrument Museum", "address": "Phoenix,Arizona" }

返回参数
参数类型说明
message_idInteger消息ID
返回结果

{ "ok": true, "result": { "message_id": 27315 } }


sendPhoto

请求URL

  • https://api.rct2008.com:8443/<bot_token>/sendPhoto

请求方式

  • POST

接口描述

  • 发送图片接口。 目前可以发送的最大图片不能超过3M,支持 JPEG/PNG/BMP/WEBP 等格式。调用成功,返回图片ID和消息ID。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
photoYesInputFile or String将要发送的图片。 两种方式 1传入文件ID发送已经存在于服务器上的图片。 2通过表单上传图片文件
captionOptionalString图片标题 (0-200 字符)
reply_to_message_idOptionalInteger如果是回复消息, 则表示原始消息的ID
reply_markupOptionalReplyMarkup自定义键盘。包括 内联按钮键盘按钮删除键盘 ,回复键盘
请求示例

{ "chat_type": 1, "chat_id": 8000012, "photo": "00000220aa47fca4bf5dfd5b49d552b9" }

返回参数
参数类型说明
message_idInteger消息ID
file_idString图片的ID
返回结果

{ "ok": true, "result": { "message_id": 27315, "file_id": "00050000321djau921030213" } }


sendDocument

请求URL

  • https://api.rct2008.com:8443/<bot_token>/sendDocument

请求方式

  • POST

接口描述

  • 发送文件, 目前可以发送的最大图片不能超过100M。调用成功返回文件ID和消息ID
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
documentYesInputFile or String将要发送的文件。 两种方式 1传入文件ID发送已经存在于服务器上的图片。 2通过表单上传文件
captionOptionalString文件标题 (0-200 字符)
reply_to_message_idOptionalInteger如果是回复消息, 则表示原始消息的ID
reply_markupOptionalReplyMarkup自定义键盘。包括 内联按钮键盘按钮删除键盘 ,回复键盘
请求示例

{ "chat_type": 1, "chat_id": 8000012, "document": "aaadeaamadf6knpuata7w2sceqpdjrpq" }

返回参数
参数类型说明
message_idInteger消息ID
file_idString文件ID
返回结果

{ "ok": true, "result": { "message_id": 27315, "file_id": "00050000321djau921030213" } }


sendVideo

请求URL

  • https://api.rct2008.com:8443/<bot_token>/sendVideo

请求方式

  • POST

接口描述

  • 发送视频, Potato客户支持MP4视频(其他格式也可以作为文档)发送)。 成功后,将返回发送的消息。 目前可以发送最大50 MB的视频文件,以后可能会更改此限制。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
videoYesInputFile or String将要发送的视频 。 两种方式 1传入文件ID发送已经存在于服务器上的视频。 2通过表单上传视频文件
durationOptionalInteger视频时长以秒为单位,如果填写则展示填写的值,如果不填写则自动识别视频时长来展示
thumbOptionalInputFile or String视频预览图,可以是文件ID或者表单上传的图片文件。如果不填则自动视频视频的第一帧
widthOptionalInteger视频宽度,建议填写视频实际宽度,否则PC端拉伸客户端时,视频会变型
heightOptionalInteger视频高度,建议填写视频实际高度,否则PC端拉伸客户端时,视频会变型
captionOptionalString视频标题 (0-200 字符)
reply_to_message_idOptionalInteger如果是回复消息, 则表示原始消息的ID
reply_markupOptionalReplyMarkup自定义键盘。包括 内联按钮键盘按钮删除键盘 ,回复键盘
请求示例

{ "chat_type": 1, "chat_id": 8000012, "video": "000002229ad7056e1e5ddc6018da56dc" }

返回参数
参数类型说明
message_idInteger消息ID
file_idString视频ID
返回结果

{ "ok": true, "result": { "message_id": 27315, "file_id": "000002229ad7056e1e5ddc6018da56dc" } }


sendAudio

请求URL

  • https://api.rct2008.com:8443/<bot_token>/sendAudio

请求方式

  • POST

接口描述

  • 发送音频文件,如果想在Potato客户端播放器中显示音频,则格式必须是MP3或者M4A, 目前最大支持发送50M的音频文件。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
audioYesInputFile or String将要发送的音频 。 两种方式 1传入文件ID来发送已经存在于服务器上的音频。 2通过表单上传音频文件
captionOptionalInteger音频标题 (0-200 characters)
durationOptionalInteger音频时长,以秒为单位
performerOptionalString演奏者
titleOptionalInteger曲目名称
thumbOptionalInputFile or String音频专辑缩略图,可以是文件ID或者表单上传的图片文件,图片最大不超过3M
reply_to_message_idOptionalInteger如果是回复消息, 则表示原始消息的ID
reply_markupOptionalReplyMarkup自定义键盘。包括 内联按钮键盘按钮删除键盘 ,回复键盘
请求示例

{ "chat_type": 1, "chat_id": 8000012, "audio": "000002229ad7056e1e5ddc6018da56dc" }

返回参数
参数类型说明
message_idInteger消息ID
file_idString文件ID
返回结果

{ "ok": true, "result": { "message_id": 27315, "file_id": "000002229ad7056e1e5ddc6018da56dc" } }


Edit A Message

editMessageText

请求URL

  • https://api.rct2008.com:8443/<bot_token>/editMessageText

请求方式

  • POST

接口描述

  • 编辑机器人发送的消息,成功返回 true。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
textYesString将用来替换成的新信息
message_idYesInteger将被修改的消息的ID
markdownOptionalBoolean是否使用markdown语法来渲染, Entities 将根据文本字段自动生成。 详细信息请参考 Rich Text
reply_markupOptionalReplyMarkup自定义键盘。包括 内联按钮键盘按钮删除键盘 ,回复键盘
请求示例

{ "chat_type":1, "chat_id":20000009, "message_id": 16, "text":"abcde", "markdown" : true, "reply_markup":{ "type": 2, "resize_keyboard": true, "single_use": false, "selective": false, "keyboard": [ { "buttons": [ { "text": "new Button1" }, { "text": "new Button2" } ] }, { "buttons": [ { "text": "new Button3" }, { "text": "new Button4" } ] } ] } }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }


editMessageCaption

请求URL

  • https://api.rct2008.com:8443/<bot_token>/editMessageCaption

请求方式

  • POST

接口描述

  • 编辑机器人发送的消息,成功返回 true。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
message_idYesInteger将被修改的消息的ID
captionYesString消息的标题
reply_markupOptionalReplyMarkup自定义键盘。包括 内联按钮键盘按钮删除键盘 ,回复键盘
请求示例

{ "chat_type":1, "chat_id":20000009, "message_id": 16, "caption" : "new text", "reply_markup":{ "type": 4, "inline_keyboard": [ { "buttons": [ { "text": "new Button1", "callback_data": "123" }, { "text": "new Button2", "callback_data": "" } ] }, { "buttons": [ { "text": "new Button3", "callback_data": "" }, { "text": "new Button4", "callback_data": "" } ] } ] } }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }


deleteMessage

请求URL

  • https://api.rct2008.com:8443/<bot_token>/deleteMessage
请求方式
  • POST

接口描述

  • 调用此接口删除一条消息,包括通知类的服务消息,接口使用需要注意一下几点:
  • 私聊 机器人只能删除机器人自己发送的消息
  • 群组频道 如果机器人是管理员,则可以删除任何消息,如果不是管理员,则只能删除它自己发送的消息。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
message_idYesInteger将要删除的消息的ID
请求示例

{ "chat_type": 1, "chat_id": 8000012, "message_id": 27315634 }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }


Available methods

leaveChat

请求URL

  • https://api.rct2008.com:8443/<bot_token>/leaveChat

请求方式

  • POST

接口描述

  • 调用此接口可以让机器人主动离开群组或频道, 如果离群成功则返回true。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
请求示例

{ "chat_type": 2, "chat_id": 8000012 }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

getChat

请求URL

  • https://api.rct2008.com:8443/<bot_token>/getChat

请求方式

  • POST

接口描述

  • 获取会话的详细信息,可以是单聊,群组或频道, 调用成功返回一个 Chat 对象。
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
请求示例

{ "chat_type": 2, "chat_id": 8000012 }

返回参数
参数类型说明
okBoolean是否请求成功
chatChat会话的详细信息
返回结果

{ "ok": true, "result": { "id": 11190291, "type": 2, "title": "grpnaga" } }

getChatMembersCount

请求URL

  • https://api.rct2008.com:8443/<bot_token>/getChatMembersCount

请求方式

  • POST

接口描述

  • 获取群成员人数
请求参数
参数是否必填类型说明
chat_typeYesChatType会话类型
chat_idYesInteger会话ID
请求示例

{ "chat_type": 3, "chat_id": 8000012 }

返回参数
参数类型说明
okInteger是否请求成功
countInteger群人数
返回结果

{ "ok": true, "result": { "count": 4 } }

getChatAdministrators

请求URL

  • https://api.rct2008.com:8443/<bot_token>/getChatAdministrators

请求方式

  • POST

接口描述

  • 获取群管理员列表。成功将返回一个ChatMember对象数组,包含有关所有群组管理员的信息。如果目标群组或频道中未添加管理员,则仅返回创建者。
请求方式
参数是否必填类型说明
chat_typeChatType会话类型
chat_idInteger会话ID
请求示例

{ "chat_type": 3, "chat_id": 8000012 }

返回参数
参数类型说明
okInteger是否请求成功
chat_memberChatMemberChatMember对象数组,包含有关所有群组管理员的信息
返回结果

{ "ok": true, "result": [ { "user": { "id": 20239276, "first_name": "ray", "last_name": "ray", "username": "" }, "status": "creator" }, { "user": { "id": 10100091, "first_name": "ABCD", "last_name": "", "username": "ABCD" }, "status": "administrator", "can_change_info": true, "can_post_messages": true, "can_edit_messages": true, "can_delete_messages": true, "can_invite_users": true, "can_restrict_members": true, "can_pin_messages": true, "can_promote_members": true } ] }

setChatTitle

请求URL
  • https://api.rct2008.com:8443/<bot_token>/setChatTitle
接口描述
  • 更改群标题。私人聊组无权限更改。机器人必须是群组中的管理员并且赋予相应的管理员权限才能正常调用。
  • 注意:在常规聊组中,仅当目标组中的"所有成员都是管理员"设置关闭时,此接口才有效。
请求方式
  • POST
请求参数
参数是否必填类型说明
chat_typeChatType会话类型
chat_idInteger会话ID
titleString群标题,1-255个字符
请求示例

{ "chat_type": 2, "chat_id": 8000012, "title": "plane" }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

setChatDescription

请求URL

  • https://api.rct2008.com:8443/<bot_token>/setChatDescription

请求方式

  • POST

接口描述

  • 更改群组或频道简介。机器人必须是群组或频道中的管理员并且赋予相应的管理员权限才能正常调用。
请求参数
参数是否必填类型说明
chat_typeChatType会话类型
chat_idInteger会话ID
descriptionString群组或频道简介,0-255个字符
请求示例

{ "chat_type": 3, "chat_id": 8000012, "description": "plane" }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

setJoinGroups

请求URL

  • https://api.rct2008.com:8443/<bot_token>/setJoinGroups

请求方式

  • POST

接口描述

  • 设置个人机器人是否允许添加到群组。
请求参数
参数是否必填类型说明
enableBooleanTrue,允许机器人添加到群组
请求示例

{ "enable":true }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

pinChatMessage

请求URL

  • https://api.rct2008.com:8443/<bot_token>/pinChatMessage
请求方式
  • POST

接口描述

  • 置顶超级群或频道消息。 机器人必须是超级群组管理员且具有置顶消息权限或频道管理员且具有编辑消息权限才能正常调用。
请求参数
参数是否必填类型说明
chat_typeChatType会话类型
chat_idInteger会话ID
message_idInteger置顶消息ID
disable_notificationBooleanTrue,不向所有聊天成员发送有关置顶消息的通知。通道中始终禁用通知。
请求示例

{ "chat_type": 3, "chat_id": 8000012, "message_id": 6234, "disable_notification": false }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

unpinChatMessage

请求URL

  • https://api.rct2008.com:8443/<bot_token>/unpinChatMessage
请求方式
  • POST

接口描述

  • 取消超级群或频道置顶消息。 机器人必须是超级群组管理员且具有置顶消息权限或频道管理员且具有编辑消息权限才能正常调用。
请求参数
参数是否必填类型说明
chat_typeChatType会话类型
chat_idInteger会话ID
请求示例

{ "chat_type": 3, "chat_id": 8000012 }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

kickChatMember

请求URL

  • https://api.rct2008.com:8443/<bot_token>/kickChatMember
请求方式
  • POST

接口描述

  • 踢出超级群或频道普通成员。踢出用户将加入群或频道黑名单列表。机器人必须是群组或频道中的管理员并且赋予相应的管理员权限才能正常调用。
  • 在常规组中,仅当目标组中的"所有成员都是管理员"设置关闭时才能正常调用。
请求参数
参数是否必填类型说明
chat_typeChatType会话类型
chat_idInteger会话ID
user_idInteger用户会话ID
请求示例

{ "chat_type": 3, "chat_id": 8000012, "user_id": 80000001 }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

kickNotBan

请求URL

  • https://api.rct2008.com:8443/<bot_token>/kickNotBan
请求方式
  • POST

接口描述

  • 踢出超级群或频道普通成员。踢出用户可重新加入原群组或频道。机器人必须是群组或频道中的管理员并且赋予相应的管理员权限才能正常调用。
请求参数
参数是否必填类型说明
chat_typeChatType会话类型
chat_idInteger会话ID
user_idInteger用户会话ID
请求示例

{ "chat_type": 3, "chat_id": 8000012, "user_id": 80000001 }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

sendChatAction

请求URL

  • https://api.rct2008.com:8443/<bot_token>/sendChatAction
请求方式
  • POST

接口描述

  • 发送机器人消息状态(状态设置为5秒)。
  • 示例: StickerBot 需要一些时间来处理请求并上传图像。机器人无需发送"正在检索图像,请稍候…"的文本消息,而可以将action=upload_photo一起使用,用户将看到机器人的"正在发送图片"状态。
  • 建议在机器人的响应需要大量时间才能到达时使用此方法。
请求参数
参数是否必填类型说明
chat_typeChatType会话类型
chat_idInteger会话ID
actionString状态类型。"typing"正在输入、"upload_photo"正在发送图片、"record_video"正在录制视频、 "upload_video"正在上传视频、"record_audio"正在录制语音、"upload_audio"正在发送语音、"upload_document"正在发送文件、"game_play"游戏中、"record_round"正在录制视频消息、"upload_round"正在发送视频消息。
请求示例

{ "chat_type": 2, "chat_id": 8000012, "action":"upload_document" }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

getGroups

请求URL

  • https://api.rct2008.com:8443/<bot_token>/getGroups

请求方式

  • GET

接口描述

  • 获取机器人所在群组/频道。
返回参数
参数类型说明
okBoolean是否请求成功
GroupsString[]普通群
SuperGroupsString[]超级群
ChannelsString[]频道
返回结果

{ "ok": true, "result": { "Groups": [ { "PeerID": 10945523, "PeerName": "普通群" } ], "SuperGroups": [ { "PeerID": 11705614, "PeerName": "超级群" } ], "SuperGroups": [ { "PeerID": 11775614, "PeerName": "频道" } ] } }

getGroupBlackList

请求URL

  • https://api.rct2008.com:8443/<bot_token>/getGroupBlackList
请求方式
  • POST

接口描述

  • 获取超组中的黑名单列表。成功返回User列表。机器人必须是群组或频道中的管理员并且赋予相应的管理员权限才能正常调用。
请求参数
参数是否必填类型说明
chat_idInteger会话ID
offsetInteger偏移量
limitInteger数量(1-10),默认100。
请求示例

{

"chat_id": 11241496

}

返回参数
参数类型说明
okBoolean是否请求成功
resultarray黑名单列表User
返回结果

{ "ok": true, "result": [ { "user": { "id": 20241232, "first_name": "James", "last_name": "", "username": "james" }, "kicked_by": 11240103 } ] }

editGroupBlackList

请求URL

  • https://api.rct2008.com:8443/<bot_token>/editGroupBlackList
请求方式
  • POST

接口描述

  • 管理超级组中的黑名单,机器人可以禁止用户或取消禁止用户。机器人必须是群组或频道中的管理员并且赋予相应的管理员权限才能正常调用。
请求参数
参数是否必填类型说明
chat_idInteger会话ID
user_idInteger用户会话ID
actionInteger操作:1加入黑名单,2解除黑名单
请求示例

{ "action": 1, "chat_id": 11241496, "user_id": 20241232 }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

lipBlock

请求URL

  • https://api.rct2008.com:8443/<bot_token>/lipBlock
请求方式
  • POST

接口描述

  • 禁止用户在群组发送消息。机器人必须是群组或频道中的管理员并且赋予相应的管理员权限才能正常调用。
请求参数
参数是否必填类型说明
group_idInteger会话ID
user_idInteger用户会话ID
请求示例

{ "group_id": 11241496, "user_id": 20241232 }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

lipUnBlock

请求URL

  • https://api.rct2008.com:8443/<bot_token>/lipUnBlock
请求方式
  • POST

接口描述

  • 解禁用户在群组发送消息限制。机器人必须是群组或频道中的管理员并且赋予相应的管理员权限才能正常调用。
请求参数
参数是否必填类型说明
group_idInteger会话ID
user_idInteger用户会话ID
请求示例

{ "group_id": 11241496, "user_id": 20241232 }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

getUserProfilePhoto

请求URL

  • https://api.rct2008.com:8443/<bot_token>/getUserProfilePhoto
请求方式
  • POST

接口描述

  • 获取用户头像信息。
请求参数
参数是否必填类型说明
user_idInteger用户会话ID
请求示例

{ "user_id":20216682 }

返回参数
参数类型说明
okBoolean是否请求成功
resultarray用户头像信息
返回结果

{ "ok": true, "result": [ { "file_id": "00b00224aba34dcc825e7cdaa70003dc", "file_size": 22191, "width": 160, "height": 160 }, { "file_id": "00b00224aba3c6cd825ee2daa700d1dc", "file_size": 75297, "width": 320, "height": 320 }, { "file_id": "00b00224aba31dce825e68daa700d8dc", "file_size": 249302, "width": 640, "height": 640 }, { "file_id": "00b00224aba316cf825e00daa7001edc", "file_size": 385720, "width": 820, "height": 820 } ] }

restrictChatMember

请求URL

  • https://api.rct2008.com:8443/<bot_token>/restrictChatMember
请求方式
  • POST

接口描述

  • 设置群组内普通用户权限。机器人必须是群组或频道中的管理员并且赋予相应的管理员权限才能正常调用。
请求参数
参数是否必填类型说明
chat_idInteger会话ID
user_idInteger用户会话ID
permissionsChatPermissions用户权限
until_datetime用户限制取消的日期,Unix时间
请求示例

{ "chat_id": 11241950, "user_id": 20241232, "permissions": { "can_send_messages": true, "can_send_media_messages": false, "can_add_web_page_previews": true }, "until_date": 1737281111 }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }

promoteChatMember

请求URL

  • https://api.rct2008.com:8443/<bot_token>/promoteChatMember
请求方式
  • POST

接口描述

  • 升级或降级超群组中管理员权限,默认值为True。机器人必须是群组或频道中的管理员并且赋予相应的管理员权限才能正常调用。
请求参数
参数是否必填类型说明
chat_idInteger会话ID
user_idInteger用户会话ID
can_change_infoBoolean是否允许修改群组信息
can_post_messagesBoolean是否允许创建帖子,仅频道
can_edit_messagesBoolean是否允许编辑其他用户消息
can_delete_messagesBoolean是否允许删除其他用户消息
can_invite_usersBoolean 是否允许邀请新用户进群/频道
can_restrict_membersBoolean是否允许封禁用户
can_pin_messagesBoolean是否允许置顶消息
can_promote_membersBoolean是否允许添加新管理员
请求示例

{ "chat_id": 11241950, "user_id": 20241232, "can_change_info": true, "can_post_messages": true, "can_edit_messages": true, "can_delete_messages": true, "can_invite_users": true, "can_restrict_members": true, "can_pin_messages": true, "can_promote_members": true }

返回参数
参数类型说明
okBoolean是否请求成功
返回结果

{ "ok": true }


游戏

说明

  • 更多小程序内容请关注@app

setGameScore

请求URL

  • https://api.rct2008.com:8443/<bot_token>/setGameScore

请求方式

  • POST

接口描述

  • 设置游戏中指定用户的分数。 成功后,如果该消息是由漫游器发送的,则返回已编辑的消息,否则返回True。如果新分数不超过用户在聊天中的当前分数并且强制为False,则返回错误。
请求参数
参数是否必填类型说明
chat_typeChatType会话类型
chat_idInteger会话ID
user_idInteger用户会话ID
scoreInteger新分数,必须为非负数
message_idInteger消息ID
forceBooleanTrue允许降低高分,当纠正错误或禁止作弊者时,这很有用
请求示例

{ "message_id":204, "user_id":22800001, "chat_type":1, "chat_id":22800001, "bot_id":10006000, "score":70 }

返回参数
参数类型说明
message_idInteger消息ID
返回结果

{ "ok": true, "result": { "message_id": 27315 } }

getGameHighScores

请求URL

  • https://api.rct2008.com:8443/<bot_token>/getGameHighScores

请求方式

  • POST

接口描述

  • 获取指定用户及其在游戏中的几个邻居的分数列表数据。
请求参数
参数是否必填类型说明
chat_typeChatType会话类型
chat_idInteger会话ID
user_idInteger用户会话ID
message_idInteger消息ID,发送的游戏消息的标识符。单击开始按钮时,可以从服务器的CallbackQuery中获取它。
请求示例

{ "message_id":204, "user_id":22800001, "chat_type":3, "chat_id":10856320, "bot_id":10060216, "score":70 }

返回参数
参数类型说明
message_idInteger消息ID
返回结果

{ "ok": true, "result": { "message_id": 27315 } }


内联模式

  • 以下方法和对象使您的机器人可以以内联模式工作。
  • 更多详细信息,请参见我们的内联机器人简介。
  • 要启用此模式,请先将在BotFather中使用/setinline命令开启该功能。

InlineQuery

接口描述

  • 内联查询,当用户使用机器人内联查询时将收到该消息推送。
参数类型是否必填说明
idString会话ID
fromUser会话来源用户
locationLocation用户位置,仅适用于请求用户位置的机器人
queryString查询消息(最多512个字符)
offsetString要返回的结果的偏移量,可以由机器人控制

answerInlineQuery

请求URL

  • https://api.rct2008.com:8443/<bot_token>/answerInlineQuery

请求方式

  • POST
接口描述
  • 回复内联消息查询结果,每次查询的结果不得超过50个。
请求参数
参数类型是否必填说明
inline_query_idString内联查询ID
resultsArray of InlineQueryResultjson序列化后的查询结果
is_personalBoolean如果结果仅在发送查询的用户的服务器端缓存,则传递True。默认情况下,结果可能会返回给发送相同查询的任何用户
next_offsetString传递给客户端应在下一次查询中发送的偏移量。如果没有更多结果或不支持分页,则传递一个空字符串。偏移长度不能超过64个字节。
switch_pm_textString客户端将显示带有指定文本的按钮,该按钮会将用户切换到与机器人的私人聊天,并向机器人发送带有参数switch_pm_parameter的启动消息
switch_pm_parameterString用户按下切换按钮时发送给机器人的/start消息的参数(1-64个字符,仅允许AZ,az,0-9,_和-)

InlineQueryResult

接口描述

内联查询的一个结果。 Potato当前支持以下6种类型的结果:

InlineQueryResultArticle

接口描述

  • 文章类型。
参数类型是否必填说明
typeString固定article
idString文章唯一ID,1-64字节
titleString文章标题
input_message_contentInputMessageContent要发送的文章内容
reply_markupInlineKeyboardMarkup自定义键盘Inline keyboard
urlString文章URL
hide_urlBoolean查询文章结果中是否显示URL
descriptionString查询文章结果描述
thumb_urlString查询文章结果缩略图URL
thumb_widthInteger缩略图宽度
thumb_heightInteger缩略图高度

InlineQueryResultWebsite

接口描述

  • 网址类型。
参数类型是否必填说明
typeString固定website
idString网址唯一ID,1-64字节
titleString网址标题
input_message_contentInputMessageContent要发送的网址内容
urlString网址URL
reply_markupInlineKeyboardMarkup自定义键盘Inline keyboard
descriptionString查询网址结果描述
thumb_urlString查询网址结果缩略图URL

InlineQueryResultGif

接口描述
  • GIF文件类型。
参数类型是否必填说明
typeString固定gif
idStringGIF唯一ID,1-64字节
gif_urlStringGIF URL,文件大小不超过1MB
gif_widthIntegerGIF宽度
gif_heightIntegerGIF高度
gif_durationIntegerGIF持续时长
thumb_urlStringGIF缩略图URL(jpeg或gif)
titleString查询GIF结果标题
captionString要发送的GIF说明,0-1024字节
reply_markupInlineKeyboardMarkup自定义键盘Inline keyboard

InlineQueryResultPhoto

接口描述
  • 图片文件类型。
参数类型是否必填说明
typeString固定photo
idString图片唯一ID,1-64字节
photo_urlString图片URL,必须是jpeg格式,文件大小不超过5MB
thumb_urlString图片缩略图URL
photo_widthInteger图片宽度
photo_heightInteger图片高度
titleString查询图片结果标题
descriptionString查询图片结果描述
captionString要发送的图片说明,0-1024字节
reply_markupInlineKeyboardMarkup自定义键盘Inline keyboard

InlineQueryResultVideo

接口描述
  • 视频文件类型,如果InlineQueryResultVideo消息包含嵌入式视频(例如YouTube),则必须使用input_message_content替换其内容。
参数类型是否必填说明
typeString固定video
idString视频唯一ID,1-64字节
video_urlString视频文件file_id或视频文件URL,文件大小不超过5MB
mime_typeString视频链接类型"text/html"或"视频文件类型video/mp4"。如果是"text/html"类型,字段input_message_content为必填项
thumb_urlString视频缩略图URL
titleString查询视频结果标题
captionString要发送的视频说明,0-1024字节
video_widthInteger视频文件高度,默认686px
video_heightInteger视频文件宽度,默认386px
input_message_contentInputMessageContent要发送的视频说明,0-1024字节
reply_markupInlineKeyboardMarkup自定义键盘Inline keyboard

InlineQueryResultCachedPhoto

接口描述

  • Potato服务器上存储的图片类型。
参数类型是否必填说明
typeString固定photo
idString图片唯一ID,1-64字节
photo_file_idString图片FID
titleString查询图片结果标题
descriptionString查询图片结果描述
captionString图片简介,0-1024字节
parse_modeString描述以富文本格式显示,固定Markdown
reply_markupInlineKeyboardMarkup自定义键盘Inline keyboard
input_message_contentInputMessageContent要发送的图片说明,0-1024字节

基本数据类型

Chat Type

  • Potato三种基本会话。
枚举值说明
1PeerUser用户私聊会话
2PeerChat普通群会话
3ChannelChat超级群/频道会话

Entity Type

枚举值说明
1EntityBold加粗
2EntityItalic斜体
3EntityCode代码高亮
4EntityURL超链接
5EntityTextURL文本链接
6EntityMention@
7EntityMentionName@用户名
8EntityEMail邮件高亮
9EntityBotCommand机器人指令

User

  • 用户基本信息。
参数是否必填类型说明
idInteger用户ID
first_nameString用户的名字
last_nameString用户的姓氏
usernameString用户名

Sample code

{ "id": 1000, "first_name": "David", "last_name": "Smith", "username": "username" }


Chat

  • 用户群组内基本信息。
参数类型是否必填说明
idInteger用户ID
typeChatType会话类型
titleString群标题
invite_linkString邀请链接
usernameString用户名
all_members_are_administratorsBoolean所有人都是管理员
descriptionString群简介
pinned_messageMessage消息置顶
Sample code

{ "id": 1000, "type": 3, "title": "超级群" }

ChatPermissions

  • 群组内用户权限。
参数类型是否必填说明
can_send_messagesBoolean 发送文本消息
can_send_media_messages Boolean发送多媒体消息
can_send_other_messagesBoolean 发送贴纸和GIF
can_add_web_page_previewsBoolean显示链接预览

Entity

  • 富文本结构。
参数是否必填类型说明
typeEntity type富文本类型
user_idInteger用户ID
offsetInteger富文本偏移量
lengthInteger富文本偏移长度
urlString网址

ReplyMarkup

  • 自定义自定义键盘: ForceReplyType,ReplyKeyboardMarkupType,ReplyKeyboardRemoveType和InlineKeyboardMarkup。

ForceReplyType

  • 显示回复界面。
参数类型是否必填说明
typeReplyMarkupType固定1(ForceReplyType),用户手动选择了机器人消息并点击了"回复"按钮的效果
selectiveBoolean默认"False",只能由特定用户查看:1. 消息中@的用户; 2. 如果上一条消息是答复,则只有原消息发送者可见

ReplyKeyboardMarkup

  • 自定义输入框键盘。
参数类型是否必填说明
typeReplyMarkupType固定2(ReplyKeyboardMarkupType),替换输入法键盘
keyboardArray of KeyboardButtonRow自定义键盘
resize_keyboardBoolean默认"False",自适应键盘高度
single_useBoolean默认"False",使用后隐藏自定义键盘
selectiveBoolean默认"False",只能由特定用户查看:1. 消息中@的用户; 2. 如果上一条消息是答复,则只有原消息发送者可见

ReplyKeyboardRemove

  • 删除当前自定义键盘。
参数类型是否必填说明
typeReplyMarkupType固定3(InlineKeyboardMarkupType),用于删除以存在的自定义键盘
selectiveBoolean默认"False",只能由特定用户查看:1. 消息中@的用户; 2. 如果上一条消息是答复,则只有原消息发送者可见

InlineKeyboardMarkup

  • 自定义消息内键盘。
参数类型是否必填说明
typeReplyMarkupType固定4(InlineKeyboardMarkupType),显示在聊天内容中
inline_keyboardArray of Array of InlineKeyboardButton自定义键盘

按钮

ReplyMarkup Type

枚举值说明
1ForceReplyType显示回复界面
2ReplyKeyboardMarkupType自定义输入框键盘
3ReplyKeyboardRemoveType删除当前自定义键盘
4InlineKeyboardMarkupType自定义消息内键盘

KeyboardButtonRow

  • 输入框自定义键盘按钮列表。
参数类型是否必填说明
buttonsArray of KeyboardButton输入框自定义键盘按钮列表

KeyboardButton

  • 输入框键盘上的自定义按钮。
参数类型是否必填说明
textString按钮上显示的标签文本
request_contactBoolean默认"False",是否单击后发送您自己的名片
request_locationBoolean默认"False",是否单击后发送自己的地理位置

InlineKeyboardButtonRow

  • 消息内自定义键盘按钮列表。
参数类型是否必填说明
buttonsArray of InlineKeyboardButton消息内自定义键盘按钮列表

InlineKeyboardButton

  • 消息内自定义键盘按钮。
参数类型是否必填说明
textString按钮上显示的标签文本
urlString默认为null,HTTP网址
callback_dataString默认null,回调发送数据
switch_inline_queryString默认null,切换内联查询数据。要求用户选择一个对话框,然后选择@robot并发送此数据
switch_inline_query_current_chatString默认null,切换内联查询数据。在当前对话框@robot中发送该数据

InputMessageContent

  • 内联查询结果要发送的消息的内容,Potato目前支持以下1种类型。
参数类型是否必填说明
message_textString要发送的消息的内容,1-4096字节

Location

参数类型是否必填说明
longitudeFloat经度
latitudeFloat纬度

Venue

参数类型是否必填说明
longitudeFloat经度
latitudeFloat纬度
titleString标题
addressString地址
foursquare_idString地理位置ID

PhotoSize

参数类型是否必填说明
file_idString文件ID
widthInteger图片宽度
heightInteger图片高度
file_sizeInteger图片文件大小

Audio

参数类型是否必填说明
file_idString文件ID
durationInteger音频播放时长
performerString音频作者
titleString音频标题
mime_typeString音频类型
file_sizeInteger音频文件大小

Document

参数类型是否必填说明
file_idString文件ID
thumbPhotoSize文件缩略图
file_nameString文件名
mime_typeString文件类型
file_sizeInteger文件类型

Video

参数类型是否必填说明
file_idString文件ID
widthInteger视频宽度
heightInteger视频高度
durationInteger视频播放时长
thumbPhotoSize视频缩略图
mime_typeString视频类型
file_sizeInteger视频文件大小

Voice

参数类型是否必填说明
file_idString文件ID
durationInteger语音播放时长
mime_typeString语音类型
file_sizeInteger语音文件大小

Contact

参数类型是否必填说明
phone_numberString联系电话
first_nameString联系人名字
last_nameString联系人姓
user_idInteger用户ID

MessageAction

参数类型是否必填说明
new_group_membersArray of User加入群组
left_group_memberUser离开群组
new_group_titleString修改群标题
migrate_from_chat_idInteger超级群ID
migrate_to_chat_idInteger超级群ID

CallbackQuery

参数类型是否必填说明
inline_message_idString回调查询会话ID
message_idInteger消息ID
chatChat消息会话信息
fromUser消息来源信息
dataString查询数据
dateIntegerUnix时间

Message

参数类型是否必填说明
message_idInteger消息ID
chatChat消息会话信息
fromUser消息来源信息
forward_fromUser消息转发来源信息
forward_from_chatChat消息转发会话信息
forward_dateInteger转发消息Unix时间
textString消息
entitiesArray of Entity富文本信息
reply_to_messageMessage回复消息
dateInteger消息Unix时间
edit_dateInteger编辑Unix时间
locationLocation地理位置
venueVenue详细地址名片
photoArray of PhotoSize图片文件
audioAudio音频文件
documentDocument文档文件
videoVideo视频文件
voiceVoice语音文件
contactContact名片
captionString文件描述
actionMessageAction动作消息

Update

参数类型是否必填说明
update_idInteger更新ID
messageMessage消息体
edited_messageMessage编辑消息体
callback_queryCallbackQuery回调查询消息体
Inline_queryInlineQuery内联查询消息体
langString客户端语言类型

ChatMember

参数类型是否必填说明
userUser用户信息
statusString成员在群组中的状态
until_dateInteger用户取消限制Unix日期
can_be_editedBoolean管理员权限,是否允许编辑其他用户权限
can_change_infoBoolean管理员权限, 是否允许修改群组信息
can_post_messagesBoolean管理员权限, 是否允许在频道发布消息
can_edit_messagesBoolean管理员权限, 是否允许在频道编辑其他用户消息或置顶消息
can_delete_messagesBoolean管理员权限, 是否允许删除信息
can_invite_usersBoolean管理员权限, 是否允许添加用户
can_restrict_membersBoolean管理员权限, 是否允许封禁用户
can_pin_messagesBoolean管理员权限, 是否允许置顶消息
can_promote_membersBoolean 管理员权限, 是否允许添加新管理员
can_send_messages Boolean是否允许发送消息
can_send_media_messagesBoolean是否允许发送多媒体消息
can_send_other_messagesBoolean是否允许发送贴纸和GIF
can_add_web_page_previewsBoolean是否可显示链接预览

ChatPermissions

  • 非管理员用户权限。
参数类型是否必填说明
can_send_messagesBoolean是否允许发送消息
can_send_media_messagesBoolean是否允许发送多媒体消息
can_send_other_messagesBoolean是否允许发送贴纸和GIF
can_add_web_page_previewsBoolean是否可显示链接预览
can_change_infoBoolean是否允许修改群组信息
can_invite_usersBoolean是否允许添加用户
can_pin_messagesBoolean是否允许置顶消息

富文本

简介

  • 使用类MarkDown语法,在Potato发送富文本消息。

斜体

  • 使用"*"或"_"之间用定义需要被斜体的文本,例如:

*this is italics* _this is italics_

加粗

  • 使用"**"或"__"之间用定义需要被加粗的文本,例如:

**This is bold font** __This is also bold font__

斜体加粗

  • 使用"***"或"___"之间用定义需要被斜体加粗的文本,例如:

***italics and bold*** ___italics and bold___

代码高亮

  • 使用"`"标记一段代码,将突出显示该代码,例如:

`printf("Hello World!");`

文本链接

  • 使用"<>"标记一段文本链接,例如:

<https://www.google.com/>

邮件

  • 使用"<>"标记电子邮件地址,例如:

<username@mail.com>

超链接

  • 使用"[]()"在方括号中为网站URL描述,在括号中为网站URL,例如:

[https://www.google.com/](https://www.google.com/) [Tap here to open Google website](https://www.google.com/)

机器人指令

  • 使用"[/](cmd)"在方括号\/后为机器人指令描述,例如:

[/new_bot](cmd)

使用用户名提及

  • 使用"[](@)"在方括号中为用户名,例如:

[@username](@)

使用用户ID提及

  • 使用"[](@ uid)"在方括号中为用户描述,在括号中@ 后为用户ID,例如:

[@username](@ 100500)


错误码

状态码类型
1001服务器错误
1002无效token
1003未知的命令
1004参数错误
1005数据格式错误
1006无权限
1007api请求频率超出限制
1008无权限给目标用户发送消息
1009上传的文件太大
1010消息中含非法字符
1011富文本超过了长度限制
1012自定义键盘超过了长度限制
1013文件不存在
1014请求消息体太大
1015机器人不在群组内
1016群组不存在
1017不支持的聊天类型
3002被拉入黑名单
3003用户不存在
3004无权限
3005群组不存在或已升级
3006用户不在群组内
3007对象类型错误
3008频繁消息
3009重复请求
3010无权限获取群成员
3011检查多媒体错误
3012消息不存在
3013获取转发消息失败
3014消息太长
3015消息存储失败
3016无置顶消息
4048群慢速模式受限
4049慢速模式批量转发受限
4050慢速模式组图受限