直接使用SDK

bot:id:123# 机器人idtoken:456# 机器人tokensecret:789# 机器人secret

importbot_apifrombot_api.modelsimportArk,Embedfrombot_api.utilsimportyaml_utiltoken=yaml_util.read('config.yaml')bot=bot_api.BotApp(token['bot']['id'],token['bot']['token'],token['bot']['secret'],is_sandbox=True,debug=True,api_return_pydantic=True,ignore_at_self=False,# 过滤消息正文中艾特Bot自身的内容, 默认为Falseinters=[bot_api.Intents.GUILDS,bot_api.Intents.AT_MESSAGES,bot_api.Intents.GUILD_MEMBERS])# 事件订阅@bot.receiver(bot_api.structs.Codes.SeverCode.BotGroupAtMessage)# 填入对应的参数实现处理对应事件defget_at_message(chain:bot_api.structs.Message):# 注册一个艾特消息处理器bot.logger(f"收到来自频道:{chain.guild_id} 子频道:{chain.channel_id} "f"内用户:{chain.author.username}({chain.author.id}) 的消息:{chain.content} ({chain.id})")if"你好"inchain.content:bot.api_send_message(chain.channel_id,chain.id,"hello world!")elif"test"inchain.content:bot.api_send_message(chain.channel_id,chain.id,"chieri在哟~")elif"/echo"inchain.content:reply=chain.content[chain.content.find("/echo")+len("/echo"):].strip()bot.api_send_message(chain.channel_id,chain.id,reply)elif"/embed"inchain.content:# 发送embedsend_embed=Embed("标题", ["文本1","文本2","文本3"],image_url=None)bot.api_send_message(chain.channel_id,chain.id,embed=send_embed)elif"/ark"inchain.content:# 发送ark消息, 需要Ark权限send_ark=Ark.LinkWithText("描述","提示信息", [["纯文本1"], ["纯文本2"], ["链接文本1","http://baidu.com"]])bot.api_send_message(chain.channel_id,chain.id,ark=send_ark)bot.start()# 启动bot

关于部分事件官方已改为被动消息说明

使用：即将要回复的消息ID（msg_id）替换为以上事件代号即可

这里以添加表情表态为例：bot.api_send_message(channel_id,msg_id='MESSAGE_REACTION_ADD',content='ok')

自行组合消息

bot.api_send_message(chain.channel_id,chain.id,"这是消息","http://您的图片")

bot.api_send_message(chain.channel_id,chain.id,others_parameter={"content":"这是消息","image":"https://您的图片"})

Ark消息说明

引用:

frombot_api.modelsimportArk,Embed

发送Embed消息

send_embed=Embed("标题", ["文本1","文本2","文本3"],image_url="http://你的图片")"image_url"参数可选,若没有图片,则不填bot.api_send_message(channel_id,message_id,embed=send_embed)

发送Ark消息

send_ark=Ark.LinkWithText("描述","提示信息",                            [["纯文本1"], ["纯文本2"], ["链接文本1","http://baidu.com"], ["链接文本2","http://google.com"]])bot.api_send_message(channel_id,message_id,ark=send_ark)

目前支持的事件/API

事件

@bot.receiver(bot_api.structs.Codes.SeverCode.MESSAGE_REACTION_ADD)# 填入事件代号defget_at_message(event:bot_api.structs.MessageReaction):# 函数参数类型为上表对应的传入参数pass

API

api_send_message()# 发送频道消息api_create_dms()# 创建私信会话api_send_private_message()# 发送私聊消息api_reply_message()# 回复消息(频道/私聊)api_mute_guild()# 全频道禁言api_mute_member()# 指定用户禁言api_get_self_guilds()# 获取Bot加入的频道列表api_get_self_info()# 获取Bot自身信息api_get_message()# 获取指定消息api_get_guild_channel_list()# 获取频道内子频道列表api_get_channel_info()# 获取子频道信息api_get_guild_user_info()# 获取频道用户信息api_get_guild_info()# 获取频道信息api_get_schedule_list()# 获取子频道日程列表api_get_schedule()# 获取单个日程信息api_schedule_create()# 创建日程api_schedule_change()# 修改日程api_schedule_delete()# 删除日程api_message_recall()# 撤回消息api_guild_roles_list_get()# 获取频道身份组列表api_guild_role_create()# 创建频道身份组api_guild_role_change()# 修改频道身份组api_guild_role_remove()# 删除频道身份组api_guild_role_member_add()# 增加频道身份组成员api_guild_role_member_remove()# 移除频道身份组成员api_announces_create()# 创建频道公告api_announces_remove()# 删除频道公告api_permissions_get_channel()# 获取指定子频道的权限api_permissions_change_channel()# 修改指定子频道的权限api_permissions_get_channel_group()# 获取指定子频道身份组的权限api_permissions_change_channel_group()# 修改指定子频道身份组的权限api_audio_control()# 音频控制api_get_api_permission()# 获取频道可用权限列表api_demand_api_permission()# 创建频道 API 接口权限授权链接api_add_pins()# 添加精华消息api_remove_pins()# 删除精华消息api_get_pins()# 获取精华消息api_send_message_reactions()# 发送表情表态api_send_message_guide()# 发送消息设置引导api_get_guild_message_freq()# 获取频道消息频率设置api_pv_get_member_list()# 仅私域机器人可用 - 取频道成员列表api_pv_kick_member()# 仅私域机器人可用 - 踢出指定成员api_pv_create_channel()# 仅私域机器人可用 - 创建子频道api_pv_change_channel()# 仅私域机器人可用 - 修改子频道信息api_pv_delete_channel()# 仅私域机器人可用 - 删除子频道

作为HTTP API使用

importbot_apiimportserverbot=bot_api.BotApp(123456,"你的bot token","你的bot secret",is_sandbox=True,debug=True,api_return_pydantic=True,inters=[bot_api.Intents.GUILDS,bot_api.Intents.AT_MESSAGES,bot_api.Intents.GUILD_MEMBERS])# 事件订阅app=server.BotServer(bot,ip_call="127.0.0.1",port_call=11415,ip_listen="127.0.0.1",port_listen=1988,allow_push=False)# 开始注册事件, 可以选择需要的进行注册app.reg_bot_at_message()# 艾特消息事件app.reg_guild_member_add()# 成员增加事件app.reg_guild_member_remove()# 成员减少事件# 以下事件与onebot差别较大app.reg_guild_create()# Bot加入频道事件app.reg_guild_update()# 频道信息更新事件app.reg_guild_delete()# Bot离开频道/频道被解散事件app.reg_channel_create()# 子频道创建事件app.reg_channel_update()# 子频道信息更新事件app.reg_channel_delete()# 子频道删除事件@app.bot.receiver(bot_api.structs.Codes.SeverCode.image_to_url)# 注册一个图片转url方法defimg_to_url(img_path:str):# 用处: 发送图片时, 使用图片cq码[CQ:image,file=]或[CQ:image,url=]# 装饰器作用为: 解析cq码中图片的路径(网络图片则下载到本地), 将绝对路径传给本函数, 自行操作后, 返回图片url, sdk将使用此url发送图片# 若不注册此方法, 则无法发送图片。print(img_path)return"https://你的图片url"# 注册事件结束app.listening_server_start()# HTTP API 服务器启动app.bot.start()# Bot启动

目前实现的CQ码

目前实现的API(基本同onebot):

目前实现的API(与onebot不同)

获取自身信息

获取自身加入频道列表

获取频道信息

获取子频道信息

获取子频道列表

获取指定消息

目前实现的Event(基本同onebot)

收到艾特消息

成员增加事件

成员减少事件

目前实现的Event(与onebot差别较大)

Bot加入频道事件

频道信息更新事件

机器人离开频道/频道被解散事件

子频道创建事件

子频道信息更新事件

子频道被删除事件