SDK接口更新 (#72)

* feat: 添加语音子频道在线成员查询接口

* feat: 新增机器人上麦|下麦接口

Co-authored-by: joyqwang <[email protected]>

Author: Joy-Wang

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.9.4](https://github.com/tencent-connect/bot-node-sdk/compare/v2.9.3...v2.9.4) (2022-05-18)
+
+
+### Features
+
+* 事件分发添加事件ID ([dd9800e](https://github.com/tencent-connect/bot-node-sdk/commit/dd9800ec1cc8e0f305d70baab60dc31bf5fc9d91))
+* 修复依赖版本问题 ([1be18a3](https://github.com/tencent-connect/bot-node-sdk/commit/1be18a300ec6241b08dcdf56ae7560a0f5863cb2))
+* 新增机器人获取表情表态成员列表接口 ([b4739d7](https://github.com/tencent-connect/bot-node-sdk/commit/b4739d719db4d860d2d96fb5f7a6476fc4788053))
+
 ### [2.9.3](https://github.com/tencent-connect/bot-node-sdk/compare/v2.9.1...v2.9.3) (2022-05-12)
 
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "qq-guild-bot",
-  "version": "2.9.3",
+  "version": "2.9.4",
   "description": "QQ频道机器人NodeSDK",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package.json

@@ -21,4 +21,28 @@ export default class Audio implements AudioAPI {
     };
     return this.request<AudioControl>(options);
   }
+  // 机器人上麦
+  botOnMic(channelID: string): Promise<RestyResponse<{}>> {
+    const options = {
+      method: 'PUT' as const,
+      url: getURL('botMic'),
+      rest: {
+        channelID,
+      },
+      data: {},
+    };
+    return this.request<{}>(options);
+  }
+  // 机器人下麦
+  botOffMic(channelID: string): Promise<RestyResponse<{}>> {
+    const options = {
+      method: 'DELETE' as const,
+      url: getURL('botMic'),
+      rest: {
+        channelID,
+      },
+      data: {},
+    };
+    return this.request<{}>(options);
+  }
 }

src/openapi/v1/audio.ts

@@ -1,4 +1,4 @@
-import { Config, OpenAPIRequest, GuildAPI, GuildMembersPager, IGuild, IMember } from '@src/types';
+import { Config, OpenAPIRequest, GuildAPI, GuildMembersPager, IGuild, IMember, IVoiceMember } from '@src/types';
 import { RestyResponse } from 'resty-client';
 import { getURL } from './resource';
 
@@ -57,4 +57,15 @@ export default class Guild implements GuildAPI {
     };
     return this.request(options);
   }
+  // 语音子频道在线成员列表
+  public guildVoiceMembers(channelID: string): Promise<RestyResponse<IVoiceMember[]>> {
+    const options = {
+      method: 'GET' as const,
+      url: getURL('guildVoiceMembersURI'),
+      rest: {
+        channelID,
+      },
+    };
+    return this.request<IVoiceMember[]>(options);
+  }
 }

src/openapi/v1/guild.ts

@@ -34,5 +34,7 @@ const apiMap = {
   pinsMessageIdURI: '/channels/:channelID/pins/:messageID',
   pinsMessageURI: '/channels/:channelID/pins',
   interactionURI: '/interactions/:interactionID',
+  guildVoiceMembersURI: '/channels/:channelID/voice/members', // 语音子频道在线成员车查询
+  botMic: '/channels/:channelID/mic', // 机器人上麦|下麦
 };
 export const getURL = (endpoint: keyof typeof apiMap) => apiMap[endpoint];

src/openapi/v1/resource.ts

@@ -3,6 +3,8 @@ import { RestyResponse } from 'resty-client';
 //  ============= Audio 音频接口 =============
 export interface AudioAPI {
   postAudio: (channelID: string, value: AudioControl) => Promise<RestyResponse<AudioControl>>;
+  botOnMic: (channelID: string) => Promise<RestyResponse<{}>>;
+  botOffMic: (channelID: string) => Promise<RestyResponse<{}>>;
 }
 
 // 语音对象-参数

src/types/openapi/v1/audio.ts

@@ -10,6 +10,7 @@ export interface GuildAPI {
   guildMember: (guildID: string, userID: string) => Promise<RestyResponse<IMember>>;
   guildMembers: (guildID: string, pager?: GuildMembersPager) => Promise<RestyResponse<IMember[]>>;
   deleteGuildMember: (guildID: string, userID: string) => Promise<RestyResponse<any>>;
+  guildVoiceMembers: (channelID: string) => Promise<RestyResponse<IVoiceMember[]>>;
 }
 
 // 频道对象(Guild)
@@ -39,6 +40,14 @@ export interface IMember {
   mute: boolean;
 }
 
+// 语音子频道参与语音的Member群成员
+export interface IVoiceMember {
+  user: IUser;
+  nick: string;
+  joined_at: string;
+  mute: boolean;
+}
+
 export interface GuildMembersPager {
   // 上一次回包中最大的用户ID， 如果是第一次请求填0，默认为0
   after: string;

src/types/openapi/v1/guild.ts

@@ -0,0 +1,59 @@
+import { client, channelID, REQUEST_SUCCESS_CODE } from '../config';
+
+describe('audio测试', () => {
+  enum AudioPlayStatus {
+    START = 0, // 开始播放
+    PAUSE = 1, // 暂停播放
+    RESUME = 2, // 继续播放
+    STOP = 3, // 停止播放
+  }
+  test('【 postAudio方法 】=== 开始播放操作', async () => {
+    const audioControl = {
+      audioUrl: '',
+      text: '',
+      status: AudioPlayStatus.START,
+    }
+    const res = await client.audioApi.postAudio(channelID, audioControl);
+    expect(res?.status).toStrictEqual(REQUEST_SUCCESS_CODE);
+  });
+
+  test('【 postAudio方法 】=== 暂停播放操作', async () => {
+    const audioControl = {
+      audioUrl: '',
+      text: '',
+      status: AudioPlayStatus.PAUSE,
+    }
+    const res = await client.audioApi.postAudio(channelID, audioControl);
+    expect(res?.status).toStrictEqual(REQUEST_SUCCESS_CODE);
+  });
+
+  test('【 postAudio方法 】=== 继续播放操作', async () => {
+    const audioControl = {
+      audioUrl: '',
+      text: '',
+      status: AudioPlayStatus.RESUME,
+    }
+    const res = await client.audioApi.postAudio(channelID, audioControl);
+    expect(res?.status).toStrictEqual(REQUEST_SUCCESS_CODE);
+  });
+
+  test('【 postAudio方法 】=== 停止播放操作', async () => {
+    const audioControl = {
+      audioUrl: '',
+      text: '',
+      status: AudioPlayStatus.STOP,
+    }
+    const res = await client.audioApi.postAudio(channelID, audioControl);
+    expect(res?.status).toStrictEqual(REQUEST_SUCCESS_CODE);
+  });
+
+  test('【 botOnMic方法 】=== 机器人上麦', async () => {
+    const res = await client.audioApi.botOnMic(channelID);
+    expect(res?.status).toStrictEqual(REQUEST_SUCCESS_CODE);
+  });
+
+  test('【 botOffMic方法 】=== 机器人下麦', async () => {
+    const res = await client.audioApi.botOffMic(channelID);
+    expect(res?.status).toStrictEqual(REQUEST_SUCCESS_CODE);
+  });
+});

test/openapi/v1/audio.spec.ts

@@ -1,4 +1,10 @@
-import { client, guildID, userID, REQUEST_SUCCESS_CODE, REQUEST_SUCCESS_CODE_WITH_NO_CONTENT } from '../config';
+import {
+  client,
+  guildID,
+  channelID,
+  userID,
+  REQUEST_SUCCESS_CODE,
+  REQUEST_SUCCESS_CODE_WITH_NO_CONTENT } from '../config';
 
 describe('guild测试', () => {
   test('【 guild方法 】=== 获取频道信息', async () => {
@@ -31,4 +37,10 @@ describe('guild测试', () => {
     const res = await client.guildApi.deleteGuildMember(guildID, testUserId);
     expect(res?.status).toStrictEqual(REQUEST_SUCCESS_CODE_WITH_NO_CONTENT);
   });
+
+  test('【 guildVoiceMembers 】=== 语音子频道内参与语音的频道成员列表', async () => {
+    const res = await client.guildApi.guildVoiceMembers(channelID);
+    expect(res?.status).toStrictEqual(REQUEST_SUCCESS_CODE);
+    expect(Array.isArray(res?.data)).toStrictEqual(true);
+  });
 });