本页绍了智能会议相关的JS-API方法,开发者可以根据应用的需求进行相应的配置。本页方法会不定期更新以满足更多应用个性化的开发需求。如果您有什么需求,欢迎在云之家开发者交流社区留言反馈,我们会根据您的需求进行优化。
http://yunzhijia.com/gateway/cloudwork/meeting/create?accessToken=xxx
header:
Content-Type:application/json
参数:
| 参数 | 类型 | 注释 |
|---|---|---|
| openid | String | 会议创建者的oid |
| title | String | 会议标题 |
| content | String | 会议内容 |
| meetingPlace | String | 会议地址 |
| startDate | Long | 会议开始时间戳 |
| endDate | Long | 会议结束时间戳 |
| roomId | String | 会议室ID |
| noticeTime | int | 提醒时间(-1:不提醒、0:开始时间提醒、15:开始时间前15分钟提醒、60:开始时间前1小时提醒) |
| topState | int | 是否标记为重要(0:否、1:是) |
| actors | 集合 | 协作人oid的集合 |
| type | String | 会议类型(null:普通会议、sign:线下签到类会议、voice:语音类会议) |
| submitExperience | boolean | 是否需要提交会议纪要(新的体会、总结) |
{
"openid": "5a67e08d00b0e8dfe4aab4fa",
"title": "测试会议",
"content":"新增会议测试",
"meetingPlace":"云8会议室",
"startDate":1522729800000,
"endDate":1522737000000,
"roomId":"xxxxx",
"noticeTime": 0,
"topState": 0,
"actors": ["xxxxxx","xxxxxx"],
"type":"xxxx",
"submitExperience":true
}
返回结果示例:
{
"data": {
"meetingId":"xxxxx"//添加成功后会议id
},
"error": null,
"errorCode": 0,
"success": true
}
http://yunzhijia.com/gateway/cloudwork/meeting/modify?accessToken=xxxx
header:
Content-Type:application/json
参数:
| 参数 | 类型 | 注释 |
|---|---|---|
| id | String | 会议ID |
| openid | String | 会议创建者的oid |
| title | String | 会议标题 |
| content | String | 会议内容 |
| meetingPlace | String | 会议地址 |
| startDate | Long | 会议开始时间戳 |
| endDate | Long | 会议结束时间戳 |
| roomId | String | 会议室ID |
| noticeTime | int | 提醒时间(-1:不提醒、0:开始时间提醒、15:开始时间前15分钟提醒、60:开始时间前1小时提醒) |
| topState | int | 是否标记为重要(0:否、1:是) |
| actors | 集合 | 协作人oid的集合(即原来的actors加上addActors减去delActors) |
| addActors | 集合 | 新加的协作人oid集合 |
| delActors | 集合 | 删除的协作人oid集合 |
| submitExperience | boolean | 是否需要提交会议纪要(新的体会、总结) |
{
"id":"5ac2e3971834a1bc583d9bb8",
"openid": "5a67e08d00b0e8dfe4aab4fa",
"title": "测试会议",
"content":"更新会议测试",
"meetingPlace":"云8会议室",
"startDate":1522729800000,
"endDate":1522737000000,
"roomId":"xxxxx",
"noticeTime": 0,
"topState": 0,
"actors": ["xxxxxx","xxxxxx"],
"addActors": ["xxxxxx","xxxxxx"],
"delActors": ["xxxxxx","xxxxxx"],
"submitExperience":true
}
返回结果示例:
{
"success": true,
"errorCode": 0,
"error": null,
"data":null
}
http://yunzhijia.com/gateway/cloudwork/meeting/cancel?accessToken=xxxx
header:
Content-Type:application/json
参数:
| 参数 | 类型 | 注释 |
|---|---|---|
| id | String | 会议ID |
| openid | String | 会议创建者的oid |
PS:必须是创建人创建的会议,才可以取消
{
"openid": "5a67e08d00b0e8dfe4aab4fa",
"id": "5b33275f14cada62e4e44840"
}
返回结果示例:
{
"success": true,
"errorCode": 0,
"error": null,
"data":null
}
http://yunzhijia.com/gateway/cloudwork/meeting/repeatMeeting?accessToken=xxxx
header:
Content-Type:application/json
参数:
| 参数 | 类型 | 注释 | |
|---|---|---|---|
| openid | String | 会议创建者的oid | |
| title | String | 会议标题 | |
| content | String | 会议内容 | |
| startDate | Long | 会议开始时间戳 | |
| endDate | Long | 会议结束时间戳 | 、 |
| noticeTime | int | 提醒时间(-1:不提醒、0:开始时间提醒、15:开始时间前15分钟提醒、60:开始时间前1小时提醒) | |
| topState | int | 是否标记为重要(0:否、1:是) | |
| actors | 集合 | 协作人oid的集合 | |
| submitExperience | boolean | 是否需要提交会议纪要(新的体会、总结) | |
| repeat | int | 重复周期(0:不重复、1:每工作日、2:每日、3:每周、4:每两周、5:每月) | |
| repeatEndDate | long | 重复截止时间 |
{
"openid": "5a67e08d00b0e8dfe4aab4fa",
"title": "测试会议",
"content": "批量修改重复日程接口",
"startDate": 1530002768912,
"endDate": 1530687800000,
"noticeTime": 0,
"topState": 0,
"actors": ["xxxxxx","xxxxxx"],
"submitExperience": true,
"repeat": 1,
"repeatEndDate": 1530687800000
}
返回结果示例:
meetingIds为添加成功后的会议id集合,其中第一个是父会议ID
{
"data": {
"meetingIds": ["5b614fe80e4f78209cb99689", "5b61504e0e4f78209cb99690", "5b61504e0e4f78209cb9968f"]
},
"error": null,
"errorCode": 0,
"success": true
}
http://yunzhijia.com/gateway/cloudwork/meeting/batchModify?accessToken=xxxx
header:
Content-Type:application/json
参数:
| 参数 | 类型 | 注释 | |
|---|---|---|---|
| id | String | 会议ID | |
| openid | String | 会议创建者的oid | |
| title | String | 会议标题 | |
| content | String | 会议内容 | |
| startDate | Long | 会议开始时间戳 | |
| endDate | Long | 会议结束时间戳 | 、 |
| noticeTime | int | 提醒时间(-1:不提醒、0:开始时间提醒、15:开始时间前15分钟提醒、60:开始时间前1小时提醒) | |
| topState | int | 是否标记为重要(0:否、1:是) | |
| actors | 集合 | 协作人oid的集合(即原来的actors加上addActors减去delActors) | |
| addActors | 集合 | 新加的协作人oid集合 | |
| delActors | 集合 | 删除的协作人oid集合 | |
| submitExperience | boolean | 是否需要提交会议纪要(新的体会、总结) | |
| repeat | int | 重复周期(0:不重复、1:每工作日、2:每日、3:每周、4:每两周、5:每月) | |
| repeatEndDate | long | 重复截止时间 | |
| batchId | String | 批量ID(如果是父会议,则没有批量ID,可以不传) |
如何判断batchId是不是父会议ID? 调用上面创建重复会议的接口,返回的meetingIds集合的第一个id即为父会议ID
{
"id": "5b33262e14cada62e4e44822",
"openid": "5a67e08d00b0e8dfe4aab4fa",
"title": "测试会议",
"content": "在京举行还很好",
"startDate": 1530002768912,
"endDate": 1530687800000,
"noticeTime": 0,
"topState": 0,
"actors": ["xxxxxx","xxxxxx"],
"addActors": ["xxxxxx","xxxxxx"],
"delActors": ["xxxxxx","xxxxxx"],
"submitExperience": true,
"repeat": "1",
"repeatEndDate": 1533549600000,
"batchId": "5b6986c514cada6af0f03821"
}
返回结果示例:
{
"success": true,
"errorCode": 0,
"error": null,
"data":null
}
http://yunzhijia.com/gateway/cloudwork/meeting/batchCancel?accessToken=xxxx
header:
Content-Type:application/json
参数:
| 参数 | 类型 | 注释 |
|---|---|---|
| id | String | 会议ID |
| openid | String | 会议创建者的oid |
| batchId | String | 批量ID(如果是父会议,则没有批量ID,可以不传) |
PS:必须是创建人创建的会议,才可以取消 如何判断batchId是不是父会议ID? 调用上面创建重复会议的接口,返回的meetingIds集合的第一个id即为父会议ID
{
"id": "1234567890",
"openid": "5a67e08d00b0e8dfe4aab4fa",
"batchId": "1234567890"
}
返回结果示例:
{
"success": true,
"errorCode": 0,
"error": null,
"data":null
}
http://yunzhijia.com/gateway/cloudwork/meeting/queryByDay?accessToken=xxxx
header:
Content-Type:application/json
参数:
| 参数 | 类型 | 注释 |
|---|---|---|
| day | long | 待查询的日期时间戳 |
{
"day": 1533549600000 //时间戳
}
返回结果示例:
| 参数 | 类型 | 注释 |
|---|---|---|
| openid | String | 会议创建者的oid |
| type | String | 会议类型(null:普通会议、sign:线下签到类会议、voice:语音类会议) |
| title | String | 会议标题 |
| content | String | 会议内容 |
| meetingPlace | String | 会议地址 |
| meetingStatus | int | 会议状态(0:未完成、1:完成、2:删除) |
| readStatus | int | 是否已读(0:未读、1:已读) |
| acceptStatus | int | 接受状态(0:未响应、1:不接受、2:接受) |
| personName | String | 创建者姓名 |
| doneTime | long | 完成时间戳 |
| id | String | 会议ID |
| noticeTime | int | 提醒时间(-1:不提醒、0:开始时间提醒、15:开始时间前15分钟提醒、60:开始时间前1小时提醒) |
| startDate | Long | 会议开始时间戳 |
| endDate | Long | 会议结束时间戳 |
| createDate | long | 会议创建时间 |
| roomId | String | 会议室ID |
| roomOrderId | String | 会议室订单ID |
{
"success": true,
"errorCode": 0,
"error": null,
"data": [
{
"openid": "5a67e1e1e4b02f1de22a70a3",
"type": "sign",
"title": "测试会议",
"content": "在京举行还很好",
"meetingPlace":"云8会议室",
"meetingStatus":1,
"readStatus":1,
"acceptStatus":2,
"personName": "张三",
"doneTime": 1535569199741,
"id": "5b86ed2fbeb7cc35af769eb8",
"noticeTime": 0,
"startDate": 1535558400000,
"endDate": 1535644799999,
"createDate": 1535569199741,
"roomId":"xx",// 会议室ID
"roomOrderId":""// 会议订单ID
}
]
}
会议助手暴露公共接口给第三方, 第三方通过调用该接口获取自己工作圈的会议室的预定信息, 用于展示。
所有请求均通过云之家通用的第三方鉴权方式,oauth2 鉴权,
详情如:https://open.yunzhijia.com/openplatform/resourceCenter/doc#/gitbook-wiki/server-api/accessToken.html
获取 token后 作为url参数 再调用以下接口所有请求与响应的格式均为json
接口为http 接口,接口配置了灰度名单, 请需要调用的客户联系云之家会议助手的开发工作人员配置灰度名单.
客户->云之家: 轮询/api/roomBook/third/hasNew
云之家-->客户: 是否有会议预定信息
Note left of 客户: 有新增会议室预定信息的情况
客户->云之家: 查询/api/roomBook/third/bookInfo
云之家-->客户: 返回会议预定信息列表(分页返回)
URL: /api/roomBook/third/hasNew
post请求, json格式参数. 查询某个会议的与会人
请求:
{
"eid":"10109", //必填, 工作圈eid
"lastTime":"1538064000000" //选填, 判断该时间节点之后是否有新增预定信息
//最后的时间(可根据/roombook/api/third/bookInfo接口获取的最后一条信息的updateTime)
}
返回:
{
"success": true,
"errorCode": 0,
"error": "",
"data": {
"hasNew": true // boolean 是否有新的会议预定信息
}
}
URL: /api/roomBook/third/bookInfo
post请求, json格式参数. 查询某个会议的与会人
请求:
{
"eid":"10109", //必填, 工作圈eid
"lastTime":"1538064000000" //选填, 最后的时间戳, 不填 则返回所有会议预定信息
"pageIndex": 1 //选填, 默认1
"pageSize":50 //选填, 默认50
}
返回:
{
"success": true,
"errorCode": 0,
"error": "",
"data": {
"add": [
{
"orderId":"eeafjkdslfjsldjfdsf", //会议预定订单id
"roomName": "23F会议室", //会议室名称
"roomDetail": null, //会议室地址
"day": "2018-09-29", //会议日期
"userName": "何****", //预定人姓名
"eid": "10109", //工作圈eid
"startTime": 1538202600000, //会议开始时间
"endTime": 1538209800000, //会议结束时间
"createTime": 1538201890395,//预定时间
"updateTime": 1538201890395,//修改时间
"meetingTopic": "云*****论",//会议主题
"meetingContent": "*****" //会议内容
}...
],
"delete": [
{
"orderId":"eeafjkdslfjsldjfdsf", //会议预定订单id
"roomName": "A304",
"roomDetail": "A栋-3F",
"day": "2018-09-28",
"userName": "符**",
"eid": "10109",
"startTime": 1538121600000,
"endTime": 1538125200000,
"createTime": 1538201890395,
"updateTime": 1538201890395,
"meetingTopic": "商学院*******",
"meetingContent": "商学院*******"
}...
]
}
}
URL: /api/roomBook/third/freeRooms
post请求, json格式参数. 查询某个会议的与会人
请求:
{
"openId":"fsdfsdfdsfsdfdsfewfaga", //必填,预约人员信息openId,
"startTime": 1538121600000,
"endTime": 1538125200000,
"pageIndex": 1, //选填, 默认1
"pageSize":50 //选填, 默认50
}
返回:
{
"success": true,
"errorCode": 0,
"error": "",
"data": [
{
"note": "小猪佩",
"roomDetail": "啊啊啊啊啊",
"tagId": null,
"limitCount": 99999999,
"approve": true,
"roomId": "5c121cfd7453ed63750a9767",
"roomName": "冥王星1号"
},...
]
}
URL: /api/roomBook/third/getActors
post请求, json格式参数. 查询某个会议的与会人
请求:
{
"orderId":"fsdfsdfdsfsdfdsfewfaga" //必填,会议订单id,
}
返回:
{
"success": true,
"errorCode": 0,
"error": "",
"data": [
{
"openId": "5c32b90b84aef86b358bc9cc",
"headerUrl": "http://192.168.22.144/space/c/photo/load?id=54f7b6b116b2e39217000002",
"userName": "陈*波"
},
{
"openId": "5b652863e4b0689c4f38b1d3",
"headerUrl": "http://192.168.22.144/space/c/photo/load?id=5b602f57b6238e0c44043f51",
"userName": "陈*略"
}
]
}
调用代码:
qing.call('createLive', {
groupId:'xxx',
success: function(result){
// success: true or false 是否成功(String)
// error: 错误信息(String)}
// errorCode:错误码(String),
// data:{}
}
});
参数:
| 参数名称 | 数据类型 | 必选 | 说明 |
|---|---|---|---|
| groupId | string | 否 | groupId不会空,在对应的群组内选人发起;如果不传,则走默认的选人界面 |
调用代码:
qing.call('createVoiceMeeting', {
groupId:'xxx',
success: function(result){
// success: true or false 是否成功(String)
// error: 错误信息(String)}
// errorCode:错误码(String),
// data:{}
}
});
参数:
| 参数名称 | 数据类型 | 必选 | 说明 |
|---|---|---|---|
| groupId | string | 否 | groupId不会空,在对应的群组内选人发起;如果不传,则走默认的选人界面 |