documentation banner

俊樹のE5subot使用教程

👋 Welcome to Toshiki's E5SubBot documentation!

0-关于&FAQ&注意事项

我中文很差哦这是第一次用中文写教程/开发文档还请多多包含
机器人部署在Vultr Cloud上配置参数如下 Cloud Compute+Intel High Performance+Debian 11 x64+50G NVMe+1 vCPU2 GB Memory3 TB Bandwidth 一个月14.4$的Singapore IP服务器上(可能为了一个机器人没必要这么高配置嘛不差钱)
机器人基于iyear/E5SubBot使用Go Lang重写后端数据库使用mysql中的user表单记录如下数据条如果担心隐私泄漏问题欢迎自己部署哦~ 项目位于andatoshiki/toshiki-e5subot 在release页面下载对应自己平台的版本自我部署哦 (当然拿到如下内容也干不了什么事最多把你帐号ban出机器人而且开发和部署文档咕咕我最懒啦 >.<)

@andatoshiki_e5subot数据库概览

机器人不保证帐号可以一直续订成功哦(所以续订失败不许来PM凶我呜呜) 但是一般情况下都是可以哒如下图~

续订成功邮件

会读取授权的outlook账号邮箱邮件API 但不会保存任何信息仅仅是调用API从而达到续订的目的微软在文档中给出的续订API支持类型为 Microsoft Teams, Microsoft Graph, Office/Sharepoint Add-ins, Sharepoint Framework, Power Apps 在这里我们使用的是Microsoft Graph包含的Outlook的mail.read API~
本机器人的管理员为@andatoshiki以及@chenskiro(我的宝贝老婆)
本机器人调用API的时间间隔为cron 1 */1 * * *翻译成人话就是每小时一次
本机器人面向帐号的API调用的并发数为20调/次如果机器人抽风请PM我注明来意哦~(我喜欢有礼貌的小萝莉:D)
每个人最多可以绑定五个E5帐号为了防止恶意注入绑定错误最高可以达到15次如果超过就不可以绑定了哦看我心情可以改到20次如果您有需要欢迎PM我!
本机器人在GitHub @andatoshiki/toshiki-e5subot 通过GNU General Public License v3.0开源如果您有自己的开源或者更好地修改办本请务必严格按照开源协议开放源代码和二进制编译文件哦~

1-如何使用机器人命令

/start: 欢迎光临俊樹のE5subot!
/my: 命令可以查看已经绑定的帐号信息机器人会在聊天窗口回复您已绑定帐号的client_id和client_secret以及别名
/bind: 命令以开始绑定帐号您会被提供链接重定向到本文档页面以查看教程
/unbind: 命令解除绑定您在机器人提供的帐号同时清空数据库和相关帐号有关的数据表单
/export: 命令导出您已经绑定过的帐号信息为JSON文件格式方便日后快速导入到机器人(功能开发中)
/help: 命令查看机器人的帮助信息哦 (你是笨蛋嘛:p)
/task: 命令可以手动完成以此调用API的任务仅限机器人的小主人@andatoshiki和@chenskiro使用呐~
/log: 命令可以调出当前的机器人的日志文件也是只有小主人可以使用哦

2-机器人使用图文教程演示

2-1-使用前准备(可选觉得麻烦可以直接跳过)

由于微软为了防止用户恶意应用注册获取client_id和client_secret 所以将apps.dev.microsoft.com的应用自主注册通道关闭具体内容可以浏览主页banner横幅如下

Application registrations portal is no longer available to register and manage converged applications. We recommend that you manage your existing applications and register new applications by using the App registrations (now Generally Available) experience in the Azure portal.

所以您需要在正式使用机器人之前手动在Azure Active Directory Portal注册client_id 和 client_secret哦~毕竟自己注册的东西自己用的最安心嘛对不对>.< 注册之前首先需要满足下以下条件哦是加分向可以不做选择哦

在注册之前建议打开浏览器的隐私浏览窗口(Incognito Tab) 不然您如果之前有在浏览器登录过别的微软帐号可能会导致冲突哦~
查看您的E5帐号数据中心(Datacenter/DC)地址切换对应代理访问Azure Portal获得最好的体验如果您忘记了自己的数据中心在哪里可以参考以下步骤哦~ (不必要但是建议)

Azure Portal登录页面

在隐私窗口中打开Azure Portal页面登录您的E5管理员帐号进入Azure面板

Azure面板

点击左上角汉堡菜单打开侧栏按照箭头和框出的位置选择Azure Active Directory

Azure Active Directory

进入Azure Active Directory点击选择Properties(属性)面板

E5帐号Datacenter位置展示

在Properties面板您就可以看到您的开发帐号的基础信息啦~在Country or region/Data location的区域您就可以看到您帐号的具体国家位置和数据中心位置啦~像我的帐号就是United States datacenter美国数据中心:P
接下来愉快的切换美国IP的代理让我们开始愉快的注册client_id和client_secret叭~

2-2-注册client_id以及client_secret

选择App Registration

同样在Azure Active Directory界面找到App registration应用注册进入对应页面

点击新注册New Registration注册新应用

进入App registration页面后点击New registration注册新应用

注册新应用

按照截屏中的步骤和箭头一步步来哦应用名称可以随便填写 Supported account types(受支持的账户类型)选择任何组织目录(任何 Azure AD 目录 - 多租户)中的帐户和个人 Microsoft 帐户(例如，Skype、 Xbox) 重定向URL选择Web平台填入http://localhost/toshiki-e5subot 一定一定要写这个哦不然等一下是不可以获取localhost url的~ 最后点击注册

获取client_id

注册完成应用后会自动重定向到本页面图中的Application(client) ID应用程序(客户端) ID即使对应的client_id 记得拿个小本子记好哦~之后会用到哒

获取第一步

获取client_secret第一步

接下来点击侧边栏中的Certificates & secrets(证书和密码)选择New client secret(新客户端密码)创建新客户端密码

设置client_secret

点击New client secret会有一个自动弹出的窗口让您设置client secret Description(描述)可以随便填写 过期时间最多只能两年哦(以前是可以永久的但是因为微软考虑到安全隐患问题改成两年了:x 其实无伤大雅两年后重新申请client_secret重新在机器人绑定帐号就可以啦~) 详细的安全隐患问题可以参考微软发布的[如下](https://devblogs.microsoft.com/microsoft365dev/client-secret-expiration-now-limited-to-a-maximum-of-two-years/#:~:text=Client Secret expiration now limited to a maximum,Microsoft identity platform team February 9th%2C 2022 3)文章