@alemonjs/qq-bot 2.1.0-alpha.19 → 2.1.0-alpha.20

package/lib/sdk/api.d.ts

@@ -1,68 +1,22 @@
-import * as axios from 'axios';
-import { AxiosRequestConfig } from 'axios';
+import { type AxiosRequestConfig } from 'axios';
 import { ApiRequestData, FileType } from './typing.js';
-
-declare class QQBotAPI {
-    /**
-     * 得到鉴权
-     * @param app_id
-     * @param clientSecret
-     * @returns
-     */
-    getAuthentication(app_id: string, clientSecret: string): Promise<axios.AxiosResponse<any, any>>;
-    /**
-     * group
-     * @param config
-     * @returns
-     */
+export declare const BOTS_API_RUL = "https://bots.qq.com";
+export declare const API_URL_SANDBOX = "https://sandbox.api.sgroup.qq.com";
+export declare const API_URL = "https://api.sgroup.qq.com";
+export declare class QQBotAPI {
+    getAuthentication(app_id: string, clientSecret: string): Promise<import("axios").AxiosResponse<any, any>>;
     groupService(options: AxiosRequestConfig): Promise<any>;
-    /**
-     * guild
-     * @param opstion
-     * @returns
-     */
     guildServer(opstion: AxiosRequestConfig): Promise<any>;
-    /**
-     * 得到鉴权
-     * @returns
-     */
     gateway(): Promise<any>;
-    /**
-     * 发送私聊消息
-     * @param openid
-     * @param content
-     * @param msg_id
-     * @returns
-     *   0 文本  1 图文 2 md 3 ark 4 embed
-     */
     usersOpenMessages(openid: string, data: ApiRequestData): Promise<{
         id: string;
         timestamp: number;
     }>;
-    /**
-     * 得到消息序列
-     * @param MessageId
-     * @returns
-     */
     getMessageSeq(MessageId: string): number;
-    /**
-     * 发送群聊消息
-     * @param group_openid
-     * @param data
-     * @returns
-     */
     groupOpenMessages(group_openid: string, data: ApiRequestData): Promise<{
         id: string;
         timestamp: number;
     }>;
-    /**
-     * 发送私聊富媒体文件
-     * @param openid
-     * @param data
-     * @returns
-     *  1 图文 2 视频 3 语言 4 文件
-     * 图片：png/jpg，视频：mp4，语音：silk
-     */
     postRichMediaByUser(openid: string, data: {
         srv_send_msg?: boolean;
         file_type: FileType;
@@ -73,14 +27,6 @@ declare class QQBotAPI {
         file_info: string;
         ttl: number;
     }>;
-    /**
-     * 发送群里文件
-     * @param openid
-     * @param data
-     * @returns
-     *  1 图文 2 视频 3 语言 4 文件
-     * 图片：png/jpg，视频：mp4，语音：silk
-     */
     postRichMediaByGroup(openid: string, data: {
         srv_send_msg?: boolean;
         file_type: FileType;
@@ -91,32 +37,8 @@ declare class QQBotAPI {
         file_info: string;
         ttl: number;
     }>;
-    /**
-     *
-     * @param openid
-     * @param message_id
-     * @returns
-     */
     userMessageDelete(openid: string, message_id: string): Promise<any>;
-    /**
-     *
-     * @param group_openid
-     * @param message_id
-     * @returns
-     */
     grouMessageDelte(group_openid: string, message_id: string): Promise<any>;
-    /**
-     * ************
-     * 消息-图片接口
-     * ***********
-     */
-    /**
-     *
-     * @param channel_id
-     * @param message
-     * @param image
-     * @returns
-     */
     channelsMessages(channel_id: string, message: {
         content?: string;
         embed?: any;
@@ -127,12 +49,6 @@ declare class QQBotAPI {
         event_id?: string;
         markdown?: any;
     }, image?: Buffer): Promise<any>;
-    /**
-     * 私聊发送
-     * @param id 私信传频道id,公信传子频道id
-     * @param message {消息编号,图片,内容}
-     * @returns
-     */
     dmsMessages(guild_id: string, message: {
         content?: string;
         embed?: any;
@@ -143,60 +59,15 @@ declare class QQBotAPI {
         event_id?: string;
         markdown?: any;
     }, image?: Buffer): Promise<any>;
-    /**
-     * ********
-     * 用户api
-     * *******
-     */
-    /**
-     * 获取用户详情
-     * @param message
-     * @returns
-     */
     usersMe(): Promise<any>;
-    /**
-     * 获取用户频道列表
-     * @param message
-     * @returns
-     */
     usersMeGuilds(params: {
         before: string;
         after: string;
         limit: number;
     }): Promise<any>;
-    /**
-     * **********
-     * 频道api
-     * **********
-     */
-    /**
-     * 获取频道详细
-     * @param guild_id
-     * @returns
-     */
     guilds(guild_id: string): Promise<any>;
-    /**
-     * ************
-     * 子频道api
-     * ***********
-     */
-    /**
-     * 获取子频道列表
-     * @param guild_id
-     * @returns
-     */
     guildsChannels(guild_id: string): Promise<any>;
-    /**
-     * 获取子频道详情
-     * @param channel_id
-     * @returns
-     */
     channels(channel_id: string): Promise<any>;
-    /**
-     * 创建子频道
-     * @param guild_id
-     * @returns
-     */
     guildsChannelsCreate(guild_id: string, data: {
         name: string;
         type: number;
@@ -208,11 +79,6 @@ declare class QQBotAPI {
         speak_permission: number;
         application_id: string;
     }): Promise<any>;
-    /**
-     * 创建子频道
-     * @param channel_id
-     * @returns
-     */
     guildsChannelsUpdate(channel_id: string, data: {
         name: string;
         position: number;
@@ -220,12 +86,6 @@ declare class QQBotAPI {
         private_type: number;
         speak_permission: number;
     }): Promise<any>;
-    /**
-     * 删除子频道
-     * @param channel_id
-     * @param data
-     * @returns
-     */
     guildsChannelsdelete(channel_id: string, data: {
         name: string;
         position: number;
@@ -233,312 +93,63 @@ declare class QQBotAPI {
         private_type: number;
         speak_permission: number;
     }): Promise<any>;
-    /**
-     * 获取在线成员数
-     * @param channel_id
-     * @returns
-     */
     channelsChannelOnlineNums(channel_id: string): Promise<any>;
-    /**
-     * *********
-     * 成员api
-     * *********
-     */
-    /**
-     * 获取频道成员列表
-     * @param guild_id
-     * @returns
-     */
     guildsMembers(guild_id: string, params: {
         after: string;
         limit: number;
     }): Promise<any>;
-    /**
-     * 获取频道身份组成员列表
-     * @param guild_id
-     * @param role_id
-     * @param params
-     * @returns
-     */
     guildsRolesMembers(guild_id: string, role_id: string, params: {
         start_index: string;
         limit: number;
     }): Promise<any>;
-    /**
-     * 获取成员详情
-     * @param guild_id
-     * @param user_id
-     * @returns
-     */
     guildsMembersMessage(guild_id: string, user_id: string): Promise<any>;
-    /**
-     * 删除频道成员
-     * @param guild_id
-     * @param user_id
-     * @returns
-     */
     guildsMembersDelete(guild_id: string, user_id: string): Promise<any>;
-    /**
-     * 获取指定消息
-     * @param channel_id
-     * @param message_id
-     * @returns
-     */
     channelsMessagesById(channel_id: string, message_id: string): Promise<any>;
-    /**
-     * 撤回消息
-     * @param channel_id
-     * @param message_id
-     * @param hidetip
-     * @returns
-     */
     channelsMessagesDelete(channel_id: string, message_id: string, hidetip?: boolean): Promise<any>;
-    /**
-     * ***********
-     * 频道身份api
-     * ***********
-     */
-    /**
-     * 获取频道身份组列表
-     * @param guild_id 频道id
-     * @returns
-     */
     guildsRoles(guild_id: string): Promise<any>;
-    /**
-     * 创建频道身份组
-     * @param guild_id 频道id
-     * @param {object} data 参数
-     * @param {object?} data.name 身份组名称
-     * @param {object?} data.color ARGB 的 HEX 十六进制颜色值转换后的十进制数值
-     * @param {object?} data.hoist 在成员列表中单独展示: 0-否, 1-是
-     * @returns
-     */
     guildsRolesPost(guild_id: string, data: {
         name?: string;
         color?: number;
         hoist?: 0 | 1;
     }): Promise<any>;
-    /**
-     * 修改频道身份组
-     * @param guild_id 频道id
-     * @param {object} data 参数
-     * @param {object?} data.name 身份组名称
-     * @param {object?} data.color ARGB 的 HEX 十六进制颜色值转换后的十进制数值
-     * @param {object?} data.hoist 在成员列表中单独展示: 0-否, 1-是
-     * @returns
-     */
     guildsRolesPatch(guild_id: string, role_id: string, data: {
         name?: string;
         color?: number;
         hoist?: 0 | 1;
     }): Promise<any>;
-    /**
-     * 删除频道身份组
-     * @param guild_id 频道id
-     * @param role_id 身份组id
-     */
     guildsRolesDelete(guild_id: string, role_id: string): Promise<any>;
-    /**
-     * 将成员添加到频道身份组
-     * @param guild_id 频道id
-     * @param channel_id 子频道id
-     * @param user_id 用户id
-     * @param role_id 身份组id
-     * @returns
-     */
     guildsRolesMembersPut(guild_id: string, channel_id: string, user_id: string, role_id: string): Promise<any>;
-    /**
-     * 将成员从频道身份组移除
-     * @param guild_id 频道id
-     * @param channel_id 子频道id
-     * @param user_id 用户id
-     * @param role_id 身份组id
-     * @returns
-     */
     guildsRolesMembersDelete(guild_id: string, channel_id: string, user_id: string, role_id: string): Promise<any>;
-    /**
-     * **********
-     * 子频道权限api
-     * **********
-     */
-    /**
-     * 获取子频道用户权限
-     * @param channel_id 子频道id
-     * @param user_id 用户id
-     */
     channelsPermissions(channel_id: string, user_id: string): Promise<any>;
-    /**
-     * 修改子频道用户权限
-     * @param channel_id 子频道id
-     * @param user_id 用户id
-     * @param 参数包括add和remove两个字段分别表示授予的权限以及删除的权限。要授予用户权限即把add对应位置 1，删除用户权限即把remove对应位置 1。当两个字段同一位都为 1，表现为删除权限。
-     */
     channelsPermissionsPut(channel_id: string, user_id: string, add: string, remove: string): Promise<any>;
-    /**
-     * *******
-     * 消息api
-     * ********
-     */
-    /**
-     * ************
-     * 消息频率api
-     * **********
-     */
-    /**
-     * 查询频道消息频率限制
-     * @param guild_id 频道id
-     * @returns
-     */
     guildsMessageSetting(guild_id: string): Promise<any>;
-    /**
-     * ***********
-     * 私信api
-     * **********
-     */
-    /**
-     * 创建私信会话
-     * @param recipient_id 接收者 id
-     * @param source_guild_id 源频道 id
-     * @returns
-     */
     usersMeDms(): Promise<any>;
-    /**
-     * 撤回私信
-     * @param guild_id
-     * @param data
-     * @returns
-     */
     dmsMessageDelete(guild_id: string, message_id: string, hidetip?: boolean): Promise<any>;
-    /**
-     * *********
-     * 禁言api
-     * *******
-     */
-    /**
-     * 全体禁言（非管理员）
-     * @param guild_id 频道id
-     * @param data { mute_end_timestamp:禁言结束时间戳, mute_seconds:禁言时长 } 两个参数必须传一个 优先级 mute_end_timestamp > mute_seconds
-     * 将mute_end_timestamp或mute_seconds传值为字符串'0'，则表示解除全体禁言
-     */
     guildsMuteAll(guild_id: string, data: {
         mute_end_timestamp?: string;
         mute_seconds?: string;
     }): Promise<any>;
-    /**
-     * 频道指定成员禁言
-     * @param guild_id 频道id
-     * @param user_id 用户id
-     * @param data { mute_end_timestamp:禁言结束时间戳, mute_seconds:禁言时长 } 两个参数必须传一个 优先级 mute_end_timestamp > mute_seconds
-     * 将mute_end_timestamp或mute_seconds传值为字符串'0'，则表示解除禁言
-     * @returns
-     */
     guildsMemberMute(guild_id: string, user_id: string, data: {
         mute_end_timestamp?: string;
         mute_seconds?: string;
     }): Promise<any>;
-    /**
-     * 频道批量禁言
-     * @param guild_id 频道id
-     * @param data { mute_end_timestamp:禁言结束时间戳, mute_seconds:禁言时长, user_ids:用户id数组 } 两个参数必须传一个 优先级 mute_end_timestamp > mute_seconds
-     * 将mute_end_timestamp或mute_seconds传值为字符串'0'，则表示解除禁言
-     */
     guildsMute(guild_id: string, data: {
         mute_end_timestamp?: string;
         mute_seconds?: string;
         user_ids: string[];
     }): Promise<any>;
-    /**
-     * *******
-     * 公告api
-     * *******
-     */
-    /**
-     * 创建频道公告
-     * 公告类型分为 消息类型的频道公告 和 推荐子频道类型的频道公告
-     * 详见 https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/content/announces/post_guild_announces.html#%E5%8A%9F%E8%83%BD%E6%8F%8F%E8%BF%B0
-     * @param guild_id 频道id
-     * @param data { message_id:消息id, channel_id:频道id, announces_type:公告类型, recommend_channels:推荐频道id数组 }
-     * @param channel_id 子频道id 消息id存在时必须传
-     * @param announces_type 0:成员公告 1:欢迎公告 默认为 0
-     * @param recommend_channels 推荐频道id数组 "recommend_channels": [{ "channel_id": "xxxx","introduce": "推荐语" }]
-     * @returns 返回Announces 对象 （https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/content/announces/model.html#Announces）
-     */
     guildsAnnounces(guild_id: string, data: {
         message_id?: string;
         channel_id?: string;
         announces_type?: 0 | 1;
         recommend_channels?: string[];
     }): Promise<any>;
-    /**
-     * 删除频道公告
-     * @param guild_id 频道id
-     * @param message_id 消息id message_id 有值时，会校验 message_id 合法性，若不校验校验 message_id，请将 message_id 设置为 all
-     * @returns
-     */
     guildsAnnouncesDelete(guild_id: string, message_id: string): Promise<any>;
-    /**
-     * **********
-     * 精华消息api
-     * **********
-     */
-    /**
-     * 添加精华消息
-     * @param channel_id 频道id
-     * @param message_id 消息id
-     * @returns  返回 PinsMessage对象 {  "guild_id": "xxxxxx",  "channel_id": "xxxxxx",  "message_ids": ["xxxxx"]}
-     * @returns message_ids 为当前请求后子频道内所有精华消息 message_id 数组
-     */
     channelsPinsPut(channel_id: string, message_id: string): Promise<any>;
-    /**
-     * 删除精华消息
-     * @param channel_id 子频道id
-     * @param message_id 消息id
-     * 删除子频道内全部精华消息，请将 message_id 设置为 all
-     * @returns
-     */
     channelsPinsDelete(channel_id: string, message_id: string): Promise<any>;
-    /**
-     * 获取精华消息
-     * @param channel_id 子频道id
-     * @returns 返回 PinsMessage对象 {  "guild_id": "xxxxxx",  "channel_id": "xxxxxx",  "message_ids": ["xxxxx"]}
-     * @returns message_ids 为当前请求后子频道内所有精华消息 message_id 数组
-     */
     channelsPins(channel_id: string): Promise<any>;
-    /**
-     * ********
-     * 日程api
-     * *******
-     */
-    /**
-     * 获取频道日程列表
-     * @param channel_id 子频道id
-     * @returns 返回 Schedule 对象数组(详见https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/content/schedule/model.html#schedule)
-     */
     channelsSchedules(channel_id: string): Promise<any>;
-    /**
-     * 获取频道日程详情
-     * @param channel_id 子频道id
-     * @param schedule_id 日程id
-     * @returns 返回 Schedule 对象(详见https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/content/schedule/model.html#schedule)
-     */
     channelsSchedulesSchedule(channel_id: string, schedule_id: string): Promise<any>;
-    /**
-     * 创建频道日程
-     * @param channel_id 子频道id
-     * @param name 日程名称
-     * @param description 日程描述
-     * @param start_timestamp 日程开始时间戳
-     * @param end_timestamp 日程结束时间戳
-     * @param jump_channel_id 日程开始时跳转的子频道id
-     * @param remind_type 日程提醒类型
-     *  0不提醒
-     *  1开始时提醒
-     *  2开始前 5 分钟提醒
-     *  3开始前 15 分钟提醒
-     *  4开始前 30 分钟提醒
-     *  5开始前 60 分钟提醒
-     * @returns 返回 Schedule 对象(详见https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/content/schedule/model.html#schedule)
-     */
     channelsSchedulesPost(channel_id: string, data: {
         schedule: {
             name: string;
@@ -549,24 +160,6 @@ declare class QQBotAPI {
             remind_type: number;
         };
     }): Promise<any>;
-    /**
-     * 修改频道日程
-     * @param channel_id 子频道id
-     * @param schedule_id 日程id
-     * @param name 日程名称
-     * @param description 日程描述
-     * @param start_timestamp 日程开始时间戳
-     * @param end_timestamp 日程结束时间戳
-     * @param jump_channel_id 日程开始时跳转的子频道id
-     * @param remind_type 日程提醒类型
-     * 0不提醒
-     * 1开始时提醒
-     * 2开始前 5 分钟提醒
-     * 3开始前 15 分钟提醒
-     * 4开始前 30 分钟提醒
-     * 5开始前 60 分钟提醒
-     * @returns 返回 Schedule 对象(详见https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/content/schedule/model.html#schedule)
-     */
     channelsSchedulesSchedulePatch(channel_id: string, schedule_id: string, data: {
         schedule: {
             name: string;
@@ -577,144 +170,28 @@ declare class QQBotAPI {
             remind_type: number;
         };
     }): Promise<any>;
-    /**
-     * 删除频道日程
-     * @param channel_id 子频道id
-     * @param schedule_id 日程id
-     * @returns
-     */
     channelsSchedulesScheduleDelete(channel_id: string, schedule_id: string): Promise<any>;
-    /**
-     * ***********
-     * 表情表态api
-     * ***********
-     */
-    /**
-     * 机器人发表表情表态
-     * @param channel_id 子频道id
-     * @param message_id 消息id
-     * @param type 表情类型 1：系统表情 2：emoji表情
-     * @param id 表情id 参考https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#Emoji%20%E5%88%97%E8%A1%A8
-     * @returns
-     */
     channelsMessagesReactionsPut(channel_id: string, message_id: string, type: 1 | 2, id: string): Promise<any>;
-    /**
-     * 删除机器人发表的表情表态
-     * @param channel_id 子频道id
-     * @param message_id 消息id
-     * @param type 表情类型 1：系统表情 2：emoji表情
-     * @param id 表情id 参考https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#Emoji%20%E5%88%97%E8%A1%A8
-     * @returns
-     */
     channelsMessagesReactionsDelete(channel_id: string, message_id: string, type: 1 | 2, id: string): Promise<any>;
-    /**
-     * 获取消息表情表态的用户列表
-     * @param channel_id 子频道id
-     * @param message_id 消息id
-     * @param type 表情类型 1：系统表情 2：emoji表情
-     * @param id 表情id 参考https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#Emoji%20%E5%88%97%E8%A1%A8
-     * @param {object} data
-     * @param {object} data.cookie 返回的cookie 第一次请求不传，后续请求传上次返回的cookie
-     * @param {object} data.limit 返回的用户数量 默认20 最大50
-     * @returns data:{ users:User[], cookie:string,is_end:true|false }
-     */
     channelsMessagesReactionsUsers(channel_id: string, message_id: string, type: 1 | 2, id: string, data: {
         cookie?: string;
         limit?: number;
     }): Promise<any>;
-    /**
-     * ***********
-     * 音频api
-     * 音频接口：仅限音频类机器人才能使用，后续会根据机器人类型自动开通接口权限，现如需调用，需联系平台申请权限
-     * **********
-     */
-    /**
-     * 音频控制
-     * @param channel_id 子频道id
-     * @param audio_url 音频url status为0时传
-     * @param status  0:开始 1:暂停 2:继续 3:停止
-     * @param text 状态文本（比如：简单爱-周杰伦），可选，status为0时传，其他操作不传
-     * @returns
-     */
     channelsAudioPost(channel_id: string, data: {
         audio_url?: string;
         text?: string;
         status: 0 | 1 | 2 | 3;
     }): Promise<any>;
-    /**
-     * 机器人上麦
-     * @param channel_id 语音子频道id
-     * @returns {}
-     */
     channelsMicPut(channel_id: string): Promise<any>;
-    /**
-     * 机器人下麦
-     * @param channel_id 语音子频道id
-     * @returns {}
-     */
     channelsMicDelete(channel_id: string): Promise<any>;
-    /**
-     * **********
-     * 帖子api
-     * 注意
-     * 公域机器人暂不支持申请，仅私域机器人可用，选择私域机器人后默认开通。
-     * 注意: 开通后需要先将机器人从频道移除，然后重新添加，方可生效。
-     * **********
-     */
-    /**
-     * 获取帖子列表
-     * @param channel_id 子频道id
-     * @returns {threads:Thread[],is_finish:0|1}
-     * @returns 返回 Thread 对象数组(详见https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/content/forum/model.html#Thread)
-     * @returns is_finish 为 1 时，表示已拉取完 为 0 时，表示未拉取完
-     */
     channelsThreads(channel_id: string): Promise<any>;
-    /**
-     * 获取帖子详情
-     * @param channel_id 子频道id
-     * @param thread_id 帖子id
-     * @returns 返回 帖子详情对象(详见https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/content/forum/model.html#ThreadInfo)
-     * 其中content字段可参考 https://bot.q.qq.com/wiki/develop/api-v2/server-inter/channel/content/forum/model.html#RichText
-     */
     channelsThreadsThread(channel_id: string, thread_id: string): Promise<any>;
-    /**
-     * 发表帖子
-     * @param channel_id 子频道id
-     * @param title 帖子标题
-     * @param content 帖子内容
-     * @param format 帖子内容格式 1:纯文本 2:HTML 3:Markdown 4:JSON
-     * @returns 返回 {task_id:string,create_time:string} 其中 task_id 为帖子id，create_time 发帖时间戳
-     */
     channelsThreadsPut(channel_id: string, data: {
         title: string;
         content: string;
         format: 1 | 2 | 3 | 4;
     }): Promise<any>;
-    /**
-     * 删除帖子
-     * @param channel_id 子频道id
-     * @param thread_id 帖子id
-     * @returns
-     */
     channelsThreadsDelete(channel_id: string, thread_id: string): Promise<any>;
-    /**
-     * ********
-     * 接口权限api
-     * **********
-     */
-    /**
-     * 获得频道可用权限列表
-     * @param guild_id
-     * @returns
-     */
     guildApiPermission(guild_id: string): Promise<any>;
-    /**
-     * 交互事件回应
-     * @param interaction_id
-     * @param code
-     * @returns
-     */
     interactionResponse(mode: 'group' | 'guild', interaction_id: string, code?: number): Promise<any>;
 }
-
-export { QQBotAPI };