Skip to content

客户端(Client)

获取机器人信息

参数名类型是否必填描述

机器人上线

  • setOnline():Promise<boolean>
参数名类型是否必填描述

机器人下线

  • setOffline():Promise<boolean>
参数名类型是否必填描述

获取在线状态

  • getOnlineStatus():Promise<{online:boolean,online_os:string[]}>
参数名类型是否必填描述

获取机器人加入的服务器列表

参数名类型是否必填描述

获取指定服务器详情

参数名类型是否必填描述
guild_idstringtrue服务器id

获取指定服务器频道列表

参数名类型是否必填描述
guild_idstringtrue服务器id

获取指定服务器成员列表

  • getGuildUserList(guild_id,channel_id?):Promise<User.Info[]>
参数名类型是否必填描述
guild_idstringtrue服务器id
channel_idstringfalse频道id,传入则获取指定频道成员列表

获取黑名单成员列表

参数名类型是否必填描述
guild_idstringtrue服务器id

发送私聊消息

  • sendPrivateMsg(user_id,message,quote):Promise<Message.Ret>
参数名类型是否必填描述
user_idstringtrue用户id
messageSendabletrue消息内容
quoteQuoteablefalse引用内容

发送频道消息

  • sendChannelMsg(channel_id,message,quote):Promise<Message.Ret>
参数名类型是否必填描述
channel_idstringtrue频道id
messageSendabletrue消息内容
quoteQuoteablefalse引用内容

获取私聊消息

  • getPrivateMsg(channel_id,message_id):Promise<Message>
参数名类型是否必填描述
user_idstringtrue用户id
message_idstringtrue消息id

获取频道消息

  • getChannelMsg(channel_id,message_id):Promise<Message>
参数名类型是否必填描述
channel_idstringtrue频道id
message_idstringtrue消息id

撤回私聊消息

  • recallPrivateMsg(channel_id,message_id):Promise<Message>
参数名类型是否必填描述
user_idstringtrue用户id
message_idstringtrue消息id

撤回频道消息

  • recallChannelMsg(channel_id,message_id):Promise<Message>
参数名类型是否必填描述
channel_idstringtrue频道id
message_idstringtrue消息id

获取私聊聊天历史

  • getPrivateChatHistory(channel_id,message_id):Promise<Message[]>
参数名类型是否必填描述
user_idstringtrue用户id
message_idstringfalse消息id

获取频道聊天历史

  • getChannelChatHistory(channel_id,message_id):Promise<Message[]>
参数名类型是否必填描述
channel_idstringtrue频道id
message_idstringfalse消息id