# 腾讯会议SDK

**Repository Path**: FlyFive/tencent-meeting-sdk

## Basic Information

- **Project Name**: 腾讯会议SDK
- **Description**: 腾讯会议非官方SDK
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 3
- **Created**: 2020-08-28
- **Last Updated**: 2024-04-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 腾讯会议SDK

#### 介绍
非官方sdk。
鉴于腾讯会议文档上代码实现不太详细，特建立本项目，希望大家可以少走点弯路。

#### 软件架构
普通maven项目，考虑到大部分项目都是web架构，该项目直接依赖spring-web，使用RestTemplate请求。
##### com.shenchuangit.tm.sdk 根路径
* com.shenchuangit.tm.sdk.TencentMeetingClient：客户端类，已封装常用请求方法，自动构造腾讯会议所需请求头（包含签名）
##### com.shenchuangit.tm.sdk.util 工具
* com.shenchuangit.tm.sdk.util.CommonUtils：通用工具类（生成随机数、获取时间戳、JSON转换函数、请求头构造）
* com.shenchuangit.tm.sdk.util.SignatureUtils：签名工具类
##### com.shenchuangit.tm.sdk.model 高级封装
* com.shenchuangit.tm.sdk.model.UserModel：用户管理SDK，对应文档“企业用户管理”API
* com.shenchuangit.tm.sdk.model.MeetingModel：企业会议SDK，对应文档“企业会议管理”API

#### 安装教程

2020.9.16，项目已发布到maven中央仓库，直接pom引用即可。

项目添加maven依赖：
```xml
<dependency>
    <groupId>com.shenchuangit</groupId>
    <artifactId>tencent-meeting-sdk</artifactId>
    <version>0.1.0-SNAPSHOT</version>
</dependency>
```

#### 使用说明

##### 第一步：初始化腾讯会议API所需配置，初始化过程只需要一次即可，建议在项目启动等地方调用一次。
```java
TencentMeetingClient.init(String secretId, String secretKey, String appId, String sdkId);
```

##### 第二步：访问接口

该项目支持两种方式访问腾讯会议，此处以获取用户列表接口为例说明。
* 方法一：直接使用`com/shenchuangit/tm/sdk/TencentMeetingClient.java`中的get、post方法直接访问腾讯会议接口的URI。
```java
TencentMeetingClient.get("/v1/users/list?page=1&page_size=10"),
```
* 方法二：使用`com/shenchuangit/tm/sdk/model/`中的接口实现各接口访问。
```java
UserModel userModel = new UserModel();
String result = userModel.create(requestBody);
```

#### 常见问题
* 新建请求体JSON格式时，不能使用Pretty
* 修改、取消会议时需要保证会议有效，比如结束时间是否已经过期
* GET请求，请求体需要传递空字符串
* 请求头中的时间戳，单位为秒，即10位时间戳
* APPID等应用信息以腾讯会议官网发送邮件为准，如果邮件中有SDKID，则请求头中需要添加SDKID