README

描述

用于处理Telegram Bot API 的库。

要求

• PHP >= 8.0
• ext-curl
• ext-json

安装

composer require mnlnk/telegram-bot-api

示例

use Manuylenko\Telegram\Bot\Api\Api;
use Manuylenko\Telegram\Bot\Api\Entities\InputFile;


// ..

$token = '0123456789:AAFYmpDWKXs_qc-2Let7p2VaHIC-cLrXLtE';

$api = new Api($token);

// Отправка текстового сообщения
$api->sendMessage('@channelname', 'Привет, мир!');

// Отправка видео
$api->sendVideo('@channelname', 'https://veshok.com/dw/load.php?id=37188');

// Отправка документа 
$api->sendDocument('@channelname', InputFile::make('C:\Some\File.zip'));

可用方法列表

更新

• getUpdates() - 获取传入更新的数组。
• getWebhookInfo() - 获取当前Webhook状态的详细信息。
• setWebhook() - 设置Webhook。
• deleteWebhook() - 删除Webhook。

聊天

• getChat() - 获取聊天的基本信息。
• getUserChatBoosts() - 获取用户添加到聊天的列表中的所有助推。
• sendChatAction() - 通知用户，在机器人端正在发生某些操作。
• pinChatMessage() - 将消息添加到聊天中固定的消息列表。
• unpinChatMessage() - 解除聊天中固定的消息。
• unpinAllChatMessages() - 清空聊天中所有固定的消息列表。
• exportChatInviteLink() - 创建新的聊天邀请链接。
• revokeChatInviteLink() - 撤销由机器人创建的邀请链接。
• createChatInviteLink() - 创建额外的聊天邀请链接。
• editChatInviteLink() - 编辑额外的聊天邀请链接。
• createChatSubscriptionInviteLink() - 创建频道订阅邀请链接。
• editChatSubscriptionInviteLink() - 编辑频道订阅邀请链接。
• approveChatJoinRequest() - 同意用户加入聊天的请求。
• declineChatJoinRequest() - 拒绝用户加入聊天的请求。
• leaveChat() - 从群组、超级群组或频道中退出。

聊天用户

• getChatMemberCount() - 获取聊天中的用户数量。
• getChatMember() - 获取特定聊天成员的信息。
• getChatAdministrators() - 获取聊天中所有管理员列表。
• restrictChatMember() - 在超级群组中限制用户。
• promoteChatMember() - 修改超级群或频道中用户的权限。
• banChatMember() - 将用户从群组、超级群或频道中封锁并删除。
• unbanChatMember() - 解锁并恢复之前被删除的超级群或频道中的用户。
• banChatSenderChat() - 在超级群或频道中封锁频道。
• unbanChatSenderChat() - 解锁超级群或频道中的频道。

聊天参数

• getChatMenuButton() - 获取当前机器人按钮菜单的值。
• setChatTitle() - 设置聊天标题。
• setChatPhoto() - 设置聊天照片。
• setChatDescription() - 设置群组、超级群或频道的描述。
• setChatPermissions() - 为所有成员设置默认权限。
• setChatAdministratorCustomTitle() - 为超级群中的管理员设置用户自定义标题（称号）。
• setChatMenuButton() - 设置机器人按钮菜单或默认按钮菜单。
• deleteChatPhoto() - 删除聊天照片。

论坛

• createForumTopic() - 创建论坛主题。
• editForumTopic() - 编辑论坛主题。
• closeForumTopic() - 关闭论坛主题。
• reopenForumTopic() - 再次打开之前关闭的论坛主题。
• deleteForumTopic() - 删除论坛主题。
• unpinAllForumTopicMessages() - 清空论坛主题中所有固定消息的列表。
• editGeneralForumTopic() - 编辑“主要”论坛主题的名称。
• closeGeneralForumTopic() - 关闭已打开的“主要”论坛主题。
• reopenGeneralForumTopic() - 再次打开之前关闭的“主要”论坛主题。
• hideGeneralForumTopic() - 隐藏“主要”论坛主题。
• unhideGeneralForumTopic() - 显示隐藏的“主要”论坛主题。
• unpinAllGeneralForumTopicMessages() - 清空“主要”论坛主题中所有固定消息的列表。
• getForumTopicIconStickers() - 获取用于作为论坛主题图标的贴纸数组。

消息

• sendMessage() - 发送文本消息。
• sendAudio() - 发送音频文件。
• sendAnimation() - 发送动画。
• sendVideo() - 发送视频。
• sendContact() - 发送电话联系。
• sendDice() - 发送骰子。
• sendDocument() - 发送文档（文件）。
• sendPaidMedia() - 在聊天频道中发送付费媒体。
• sendMediaGroup() - 以相册的形式发送一组照片或视频。
• sendPhoto() - 发送照片。
• sendVideoNote() - 发送视频备注。
• sendVoice() - 发送语音备注。
• sendVenue() - 发送会面地点。
• sendLocation() - 发送位置。
• sendPoll() - 发送投票。
• forwardMessage() - 转发消息。
• forwardMessages() - 转发多条消息。
• copyMessage() - 复制消息。
• copyMessages() - 复制多条消息。

消息编辑

• editMessageText() - 编辑文本或游戏消息。
• editMessageCaption() - 编辑消息签名。
• editMessageMedia() - 编辑多媒体消息。
• editMessageReplyMarkup() - 编辑消息键盘。
• editMessageLiveLocation() - 编辑实时位置消息。
• stopMessageLiveLocation() - 停止更新实时位置消息。
• stopPoll() - 停止之前发送的投票。
• deleteMessage() - 删除消息。
• deleteMessages() - 同时删除多条消息。

反应

• setMessageReaction() - 修改消息选择的反应。

游戏

• sendGame() - 发送游戏。
• getGameHighScores() - 获取排行榜数据。
• setGameScore() - 设置游戏用户分数。

贴纸

• sendSticker() - 发送贴纸。
• getStickerSet() - 获取贴纸集。
• getCustomEmojiStickers() - 获取用户自定义表情贴纸信息。
• uploadStickerFile() - 将贴纸文件上传到服务器。
• createNewStickerSet() - 创建新的贴纸集。
• addStickerToSet() - 将贴纸添加到贴纸集。
• setStickerPositionInSet() - 设置贴纸在贴纸集中的位置。
• setStickerSetThumbnail() - 设置贴纸集的缩略图。
• setChatStickerSet() - 设置群组或超群的贴纸集。
• setCustomEmojiStickerSetThumbnail() - 设置带有表情的用户自定义贴纸集缩略图。
• setStickerSetTitle() - 设置创建的贴纸集名称。
• setStickerEmojiList() - 设置与贴纸相关的表情列表。
• setStickerKeywords() - 设置与贴纸相关的搜索关键词。
• setStickerMaskPosition() - 设置贴纸蒙版的定位。
• replaceStickerInSet() - 将贴纸集中的现有贴纸替换为新贴纸。
• deleteStickerFromSet() - 从贴纸集中删除贴纸。
• deleteStickerSet() - 删除由机器人创建的贴纸集。
• deleteChatStickerSet() - 删除群组或超群的贴纸集。

查询

• answerCallbackQuery() - 发送对回调查询的响应。
• answerInlineQuery() - 发送对内置查询的响应。
• answerWebAppQuery() - 发送与网页应用程序交互的消息。

支付

• sendInvoice() - 发送支付账单。
• createInvoiceLink() - 创建账单链接。
• answerPreCheckoutQuery() - 发送对预结账查询的响应。
• answerShippingQuery() - 发送对配送查询的响应。
• getStarTransactions() - 获取按时间顺序排列的 Telegram Star 交易。
• refundStarPayment() - 将成功支付退回到Telegram Stars。

机器人配置

• getMe() - 获取机器人的基本信息。
• getMyName() - 获取当前机器人的名称。
• getMyShortDescription() - 获取机器人的简短描述。
• getMyDescription() - 获取机器人的描述。
• getMyCommands() - 获取机器人的命令列表。
• getMyDefaultAdministratorRights() - 获取机器人默认管理员权限。
• setMyName() - 修改机器人的名称。
• setMyShortDescription() - 修改机器人的简短描述，该描述显示在机器人个人资料页面。
• setMyDescription() - 修改机器人的描述，该描述显示在与机器人对话的聊天中（如果聊天为空）。
• setMyCommands() - 设置机器人的命令列表。
• setMyDefaultAdministratorRights() - 设置机器人请求的默认管理员权限。
• deleteMyCommands() - 删除机器人的命令列表。
• getBusinessConnection() - 获取机器人与业务账号的连接信息。

Telegram Passport

• setPassportDataErrors() - 通知用户Telegram Passport元素中出现的错误。

其他

• getFile() - 获取文件的基本信息并准备下载。
• getFileUrl() - (#) 获取文件的URL链接。
• getUserProfilePhotos() - 获取用户所有个人资料图片的列表。
• close() - 在将机器人实例从一个本地服务器移动到另一个服务器之前关闭机器人。
• logOut() - 机器人在本地启动前从API云服务器退出。

带有(#)符号的方法在服务器原生API中不存在，但在当前库中实现。