开发者工具
更新时间: 2024/04/02 17:59:25为了方便开发者快速集成和接入云屋会议API,这里提供了基于java语言的开发工具包。
依赖环境
- JDK 7 以上
- 获得secretId和secretKey
使用方式
在自己的项目引入该jar包,初始化CRClient
类。
CRClient client = new CRClient(secretId, secretKey);
工具类CRClient
封装了对会议API的调用,提供了相应的封装方法。
封装方法
功能 | 方法名 |
---|---|
创建会议 | createMeeting |
修改会议 | updateMeeting |
查询会议 | queryMeeting |
加入会议 | joinMeeting |
结束会议 | endMeeting |
删除会议 | deleteMeeting |
查询会议列表 | queryMeetingList |
查询历史会议 | queryHistoryMeeting |
查询录像 | queryVideo |
删除录像 | deleteVideo |
创建用户 | createUser |
修改用户 | updateUser |
删除用户 | deleteUser |
查询用户列表 | queryUser |
创建部门 | createDepartment |
修改部门 | updateDepartment |
删除部门 | deleteDepartment |
查询部门列表 | queryDepartmentList |
查询实时会中成员列表 | queryRealTimeParticipants |
查询历史会议参会成员列表 | queryHistoryParticipants |
呼叫SIP/H323终端 | callTerminal |
使用示例
创建一个简单会议
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
CreateMeetingRequestBody requestBody = new CreateMeetingRequestBody();
// 会议主题
requestBody.setSubject("api test");
// 构造请求
CreateMeetingRequest request = new CreateMeetingRequest(requestBody);
// 创建会议
CreateMeetingResponse response = client.createMeeting(request);
说明:
- 创建会议,调用
CRClient
类的createMeeting
方法 CreateMeetingRequest
类封装了创建会议接口的请求CreateMeetingRequestBody
类包含了创建会议接口的传参,详细参数见创建会议接口的请求参数说明CreateMeetingResponse
类封装了创建会议接口的返回数据,详细参数见创建会议接口的返回参数说明
预约会议
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
CreateMeetingRequestBody requestBody = new CreateMeetingRequestBody()
// 会议主题
.setSubject("api test")
.setOrderConfig(new OrderConfig()
// 预约开始时间(时间戳,单位:秒
.setScheduleTime(1622980800L)
// 预约结束时间(时间戳,单位:秒)
.setScheduleEndTime(1622988000L));
// 构造请求
CreateMeetingRequest request = new CreateMeetingRequest(requestBody);
// 创建会议
CreateMeetingResponse response = client.createMeeting(request);
说明:
- 创建会议,调用
CRClient
类的createMeeting
方法 CreateMeetingRequest
类封装了创建会议接口的请求CreateMeetingRequestBody
类包含了创建会议接口的传参,详细参数见创建会议接口的请求参数说明CreateMeetingResponse
类封装了创建会议接口的返回数据,详细参数见创建会议接口的返回参数说明
创建一个周期会议
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
CreateMeetingRequestBody requestBody = new CreateMeetingRequestBody()
// 会议主题
.setSubject("周期会议")
.setOrderConfig(new OrderConfig()
// 预约开始时间(时间戳,单位:秒
.setScheduleTime(1622980800L)
// 预约结束时间(时间戳,单位:秒)
.setScheduleEndTime(1622988000L)
// 周期类型(0:非周期会议;1:每天;2:每个工作日;3:每周;4:每两周;5:每月,默认为0)
// 3 每周
.setPeriodType(3)
// 周期结束时间(时间戳,单位:秒;-1:无结束时间;如果周期类型不为0,则为必填)
.setPeriodEndTime(1622988000L)
);
// 构造请求
CreateMeetingRequest request = new CreateMeetingRequest(requestBody);
// 创建会议
CreateMeetingResponse response = client.createMeeting(request);
说明:
- 创建会议,调用
CRClient
类的createMeeting
方法 CreateMeetingRequest
类封装了创建会议接口的请求CreateMeetingRequestBody
类包含了创建会议接口的传参,详细参数见创建会议接口的请求参数说明CreateMeetingResponse
类封装了创建会议接口的返回数据,详细参数见创建会议接口的返回参数说明
修改预约的会议
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
UpdateMeetingRequestBody requestBody = new UpdateMeetingRequestBody()
// 会议主题
.setSubject("修改会议")
.setOrderConfig(new OrderConfig()
// 预约开始时间(时间戳,单位:秒
.setScheduleTime(1623067200L)
// 预约结束时间(时间戳,单位:秒)
.setScheduleEndTime(1623074400L));
// 构造请求
UpdateMeetingRequest request = new UpdateMeetingRequest(72235176L, requestBody);
// 修改会议 72235176
UpdateMeetingResponse response = client.updateMeeting(request);
说明:
- 修改会议,调用
CRClient
类的updateMeeting
方法 UpdateMeetingRequest
类封装了修改会议接口的请求UpdateMeetingRequestBody
类包含了修改会议接口的传参,详细参数见修改会议接口的请求参数说明UpdateMeetingResponse
类封装了修改会议接口的返回数据,详细参数见修改会议接口的返回参数说明
修改周期会议
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
UpdateMeetingRequestBody requestBody = new UpdateMeetingRequestBody()
// 会议主题
.setSubject("修改周期会议")
.setOrderConfig(new OrderConfig()
// 预约开始时间(时间戳,单位:秒
.setScheduleTime(1623067200L)
// 预约结束时间(时间戳,单位:秒)
.setScheduleEndTime(1623074400L)
// 周期类型(0:非周期会议;1:每天;2:每个工作日;3:每周;4:每两周;5:每月,默认为0)
// 1:每天
.setPeriodType(1)
// 周期结束时间(时间戳,单位:秒;-1:无结束时间;如果周期类型不为0,则为必填)
.setPeriodEndTime(1623074400L));
// 构造请求
UpdateMeetingRequest request = new UpdateMeetingRequest(15310396L, requestBody);
// 修改会议 15310396
UpdateMeetingResponse response = client.updateMeeting(request);
说明:
- 修改会议,调用
CRClient
类的updateMeeting
方法 UpdateMeetingRequest
类封装了修改会议接口的请求UpdateMeetingRequestBody
类包含了修改会议接口的传参,详细参数见修改会议接口的请求参数说明UpdateMeetingResponse
类封装了修改会议接口的返回数据,详细参数见修改会议接口的返回参数说明
查询会议
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造请求
QueryMeetingRequest request = new QueryMeetingRequest(15310396L);
// 查询会议 15310396
QueryMeetingResponse response = client.queryMeeting(request);
说明:
- 查询会议,调用
CRClient
类的queryMeeting
方法 QueryMeetingRequest
类封装了查询会议接口的请求,详细参数见查询会议接口的请求参数说明QueryMeetingResponse
类封装了查询会议接口的返回数据,详细参数见查询会议接口的返回参数说明
加入会议
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造请求
JoinMeetingRequest request = new JoinMeetingRequest(15310396L, "test");
// 加入会议 15310396
JoinMeetingResponse response = client.joinMeeting(request);
说明:
- 加入会议,调用
CRClient
类的joinMeeting
方法 JoinMeetingRequest
类封装了加入会议接口的请求,详细参数见加入会议接口的请求参数说明JoinMeetingResponse
类封装了加入会议接口的返回数据,详细参数见加入会议接口的返回参数说明
结束会议
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造请求
EndMeetingRequest request = new EndMeetingRequest(15310396L);
// 结束会议 15310396
EndMeetingResponse response = client.endMeeting(request);
说明:
- 结束会议,调用
CRClient
类的endMeeting
方法 EndMeetingRequest
类封装了结束会议接口的请求,详细参数见结束会议接口的请求参数说明EndMeetingResponse
类封装了结束会议接口的返回数据,详细参数见结束会议接口的返回参数说明
删除会议
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造请求
DeleteMeetingRequest request = new DeleteMeetingRequest(77574744L);
// 删除会议 77574744
DeleteMeetingResponse response = client.deleteMeeting(request);
说明:
- 删除会议,调用
CRClient
类的deleteMeeting
方法 DeleteMeetingRequest
类封装了删除会议接口的请求,详细参数见删除会议接口的请求参数说明DeleteMeetingResponse
类封装了删除会议接口的返回数据,详细参数见删除会议接口的返回参数说明
查询会议列表
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造请求
QueryMeetingListRequest request = new QueryMeetingListRequest(new QueryMeetingParams());
// 查询会议列表
QueryMeetingListResponse response = client.queryMeetingList(request);
说明:
- 查询会议列表,调用
CRClient
类的queryMeetingList
方法 QueryMeetingListRequest
类封装了查询会议列表接口的请求QueryMeetingParams
类包含了查询会议列表接口的传参,详细参数见查询会议列表接口的请求参数说明QueryMeetingListResponse
类封装了查询会议列表接口的返回数据,详细参数见查询会议列表接口的返回参数说明
查询历史会议列表
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造请求
QueryHistoryMeetingRequest request = new QueryHistoryMeetingRequest(new QueryMeetingParams());
// 查询历史会议列表
QueryHistoryMeetingResponse response = client.queryHistoryMeeting(request);
说明:
- 查询历史会议列表,调用
CRClient
类的queryHistoryMeeting
方法 QueryHistoryMeetingRequest
类封装了查询历史会议列表接口的请求QueryMeetingParams
类包含了查询历史会议列表接口的传参,详细参数见查询历史会议列表接口的请求参数说明QueryHistoryMeetingResponse
类封装了查询历史会议列表接口的返回数据,详细参数见查询历史会议列表接口的返回参数说明
查询录像
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造请求
QueryVideoListRequest request = new QueryVideoListRequest(new QueryVideoParams());
// 查询录像
QueryVideoListResponse response = client.queryVideo(request);
说明:
- 查询录像,调用
CRClient
类的queryVideo
方法 QueryVideoListRequest
类封装了查询录像接口的请求QueryVideoParams
类包含了查询录像接口的传参,详细参数见查询录像接口的请求参数说明QueryVideoListResponse
类封装了查询录像接口的返回数据,详细参数见查询录像接口的返回参数说明
删除录像
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 文件id
String fileId = "387702296233417094";
// 构造请求
DeleteVideoRequest request = new DeleteVideoRequest(fileId);
// 删除录像
DeleteVideoResponse response = client.deleteVideo(request);
说明:
- 删除录像,调用
CRClient
类的deleteVideo
方法 DeleteVideoRequest
类封装了删除录像接口的请求,详细参数见删除录像接口的请求参数说明DeleteVideoResponse
类封装了删除录像接口的返回数据,详细参数见删除录像接口的返回参数说明
创建用户
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
//构造传参
CreateUserRequestBody requestBody = new CreateUserRequestBody();
// 构造请求
CreateUserRequest request = new CreateUserRequest(requestBody);
// 创建用户
CreateUserResponse response = client.createUser(request);
说明:
- 创建用户,调用
CRClient
类的createUser
方法 CreateUserRequest
类封装了创建用户接口的请求CreateUserRequestBody
类包含了创建用户接口的传参,详细参数见创建用户接口的请求参数说明CreateUserResponse
类封装了创建用户接口的返回数据,详细参数见创建用户接口的返回参数说明
修改用户
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
//构造传参
UpdateUserRequestBody requestBody = new UpdateUserRequestBody();
// 构造请求
UpdateUserRequest request = new UpdateUserRequest(212312L,requestBody);
// 修改用户
UpdateUserResponse response = client.updateUser(request);
说明:
- 修改用户,调用
CRClient
类的updateUser
方法 UpdateUserRequest
类封装了修改用户接口的请求UpdateUserRequestBody
类包含了修改用户接口的传参,详细参数见修改用户接口的请求参数说明CreateUserResponse
类封装了修改用户接口的返回数据,详细参数见修改用户接口的返回参数说明
删除用户
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造请求
DeleteUserRequest request = new DeleteUserRequest(212312L);
// 删除用户
DeleteUserResponse response = client.deleteUser(request);
说明:
- 删除用户,调用
CRClient
类的deleteUser
方法 DeleteUserRequest
类封装了删除部门接口的请求,详细参数见删除用户接口的请求参数说明DeleteUserResponse
类封装了删除部门接口的返回数据,详细参数见删除用户接口的返回参数说明
查询用户列表
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造参数
QueryUserParams params = new QueryUserParams();
// 构造请求
QueryUserListRequest request = new QueryUserListRequest(params);
// 查询用户
QueryUserListResponse response = client.queryUser(request);
说明:
- 查询用户,调用
CRClient
类的queryUser
方法 UpdateUserRequest
类封装了查询用户接口的请求QueryUserParams
类包含了查询用户接口的传参,详细参数见查询用户列表接口的请求参数说明QueryUserListResponse
类封装了查询用户列表接口的返回数据,详细参数见查询用户列表接口的返回参数说明
创建部门
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
CreateDepartmentRequestBody requestBody = new CreateDepartmentRequestBody();
// 构造请求
CreateDepartmentRequest request = new CreateDepartmentRequest(requestBody);
// 创建部门
CreateDepartmentResponse response = client.createDepartment(request);
说明:
- 创建部门,调用
CRClient
类的createDepartment
方法 CreateDepartmentRequest
类封装了创建部门接口的请求CreateDepartmentRequestBody
类包含了创建部门接口的传参,详细参数见创建部门接口的请求参数说明CreateDepartmentResponse
类封装了创建部门接口的返回数据,详细参数见创建部门接口的返回参数说明
修改部门
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
UpdateDepartmentRequestBody requestBody = new UpdateDepartmentRequestBody();
// 构造请求
UpdateDepartmentRequest request = new UpdateDepartmentRequest(1L, requestBody);
// 修改部门
UpdateDepartmentResponse response = client.updateDepartment(request);
说明:
- 创建部门,调用
CRClient
类的updateDepartment
方法 UpdateDepartmentRequestt
类封装了修改部门接口的请求UpdateDepartmentRequestBody
类包含了修改部门接口的传参,详细参数见修改部门接口的请求参数说明UpdateDepartmentResponse
类封装了修改部门接口的返回数据,详细参数见修改部门接口的返回参数说明
删除部门
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
DeleteDepartmentRequestBody requestBody = new DeleteDepartmentRequestBody();
requestBody.setDepartmentIdList(new ArrayList<Long>());
// 构造请求
DeleteDepartmentRequest request = new DeleteDepartmentRequest(requestBody);
// 删除部门
DeleteDepartmentResponse response = client.deleteDepartment(request);
说明:
- 删除部门,调用
CRClient
类的deleteDepartment
方法 DeleteDepartmentRequest
类封装了删除部门接口的请求DeleteDepartmentRequestBody
类包含了删除部门接口的传参,详细参数见删除部门接口的请求参数说明DeleteDepartmentResponse
类封装了删除部门接口的返回数据,详细参数见删除部门接口的返回参数说明
查询部门列表
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
QueryDepartmentParams params = new QueryDepartmentParams();
// 构造请求
QueryDepartmentListRequest request = new QueryDepartmentListRequest(params);
// 查询部门列表
QueryDepartmentListResponse response = client.queryDepartmentList(request);
说明:
- 查询部门,调用
CRClient
类的queryDepartmentList
方法 QueryDepartmentListRequest
类封装了查询部门列表接口的请求QueryDepartmentParams
类包含了查询部门列表接口的传参,详细参数见查询部门列表接口的请求参数说明QueryDepartmentListResponse
类封装了查询部门列表接口的返回数据,详细参数见查询部门列表接口的返回参数说明
查询实时会中成员列表
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
QueryRealTimeParticipantsParams params = new QueryRealTimeParticipantsParams(66196854L);
// 构造请求
QueryRealTimeParticipantsRequest request = new QueryRealTimeParticipantsRequest(params);
// 查询实时会中成员列表
QueryRealTimeParticipantsResponse response = client.queryRealTimeParticipants(request);
说明:
- 查询实时会中成员列表,调用
CRClient
类的queryRealTimeParticipants
方法 QueryRealTimeParticipantsRequest
类封装了查询实时会中成员列表接口的请求QueryRealTimeParticipantsParams
类包含了查询部门列表接口的传参,详细参数见查询实时会中成员列表接口的请求参数说明QueryRealTimeParticipantsResponse
类封装了查询部门列表接口的返回数据,详细参数见查询实时会中成员列表接口的返回参数说明
查询实时会中成员列表
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造传参
QueryHistoryParticipantsParams params = new QueryHistoryParticipantsParams(66196854L, 0);
// 构造请求
QueryHistoryParticipantsRequest request = new QueryHistoryParticipantsRequest(params);
// 查询实时会中成员列表
QueryHistoryParticipantsResponse response = client.queryHistoryParticipants(request);
说明:
- 查询历史会议参会成员列表,调用
CRClient
类的queryHistoryParticipants
方法 QueryHistoryParticipantsRequest
类封装了查询历史会议参会成员列表接口的请求QueryHistoryParticipantsParams
类包含了查询历史会议参会成员列表接口的传参,详细参数见查询历史会议参会成员列表接口的请求参数说明QueryHistoryParticipantsResponse
类封装了查询历史会议参会成员列表接口的返回数据,详细参数见查询历史会议参会成员列表接口的返回参数说明
呼叫SIP/H323终端
String secretId = "LQrJzTFBsSTB90Stjr";
String secretKey = "HxYxy7baX8jn7swVJaFdEx7HpMuOcRX6";
CRClient client = new CRClient(secretId, secretKey);
// 构造请求
CallTerminalRequest request = new CallTerminalRequest(90996178L, "h323:192.168.2.164");
// 返回结果
CallTerminalResponse response = client.callTerminal(request);
说明
-
呼叫SIP/H323终端,调用
CRClient
类的callTerminal
方法 -
CallTerminalRequest
类封装了呼叫SIP/H323终端接口的请求,详细参数见呼叫SIP/H323终端接口的请求参数说明 -
CallTerminalResponse
类封装了呼叫SIP/H323终端接口的的返回数据,详细参数见呼叫SIP/H323终端接口的返回参数说明