开发指南

概述

本文档是全时面向空间产品提供的开放接口。

开发前必读

1. 使用 HTTPS 协议作为基础的通讯协议
2. 所有请求使用 POST 方法
3. 请求参数和响应的结果均采用 UTF-8 编码的 JSON 结构，Content-Type 头值为"application/json; charset=utf-8"
4. 除获取凭据的接口外，所有的接口请求参数格式如下:

{
    "username": "admin@quanshi.com", // 管理员登录名
    "token": "xxxxxxx", // 登录凭据
    "data ": {} // 请求数据
}

1. 所有的答复的 JSON 格式如下

{
    "errorCode": 0, // 返回错误码，0表示调用成功
    "data ": {}, // 返回的数据
    "errorMessage": "xxxxxxxxx", // 错误信息
    "requestId": "xxxxxxxxxx" // 本地请求的ID，方便开发排查错误
}

接口域名说明

线上环境，接口请求域名：https://bee.quanshi.com/ucopenapi

接口文档

凭据

获取凭据

基本信息

Path： /auth/token/create

Method： POST

接口描述：

1. 参数username指的是空间产品的后台管理员的账号，输入正确的账号和密码后，会返回token，后面其他接口调用，需要带上username和token。
2. 参数role，空间管理员账号，此处设置为5。
3. 接口如果返回Invalid username or passWord的错误信息，请确认账号对应的站点是否已经开通了空间和云会议产品。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		此处输入空间产品或蜜蜂产品的后台管理员的账号，输入正确的账号和密码后，会返回token，后面其他接口调用只需要带上token就可以访问了。 需要注意以下两点： 1.空间产品的后台管理系统，在全时内部也称作“应用管家” 2.蜜蜂产品的后台管理系统，在全时内部也称作“管理中心”或“UCadmin” 希望不要混淆。
password	string	必须		密码
role	integer	必须	0	登录角色。 0-蜜蜂管理员 2-蜜蜂应用管理员 5-空间应用管家管理员
appId	integer	非必须		应用 ID， 当 role 为 2 时，必填。其他可以不填或者填写任意值。

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	integer	非必须		错误码
errorMessage	string	非必须		错误信息
data	object	非必须
├─ token	string	非必须		登录凭据
├─ username	string	非必须		登录用户名
requestId	string	非必须		请求ID

校验凭据

基本信息

Path： /auth/token/check

Method： POST

接口描述：

检查token的有效性

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		登录凭证

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	integer	非必须		错误码
errorMessage	string	非必须		错误信息
data	object	非必须
├─ token	string	非必须		登录凭证
├─ username	string	非必须		登录用户名
requestId	string	非必须		请求ID

销毁凭据

基本信息

Path： /auth/token/delete

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		登录凭证

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
errorMessage	string	非必须
requestId	string	非必须

日程

新建日程

基本信息

Path： /calendar/create

Method： POST

接口描述：

1. startTime，单位是秒，Unix 时间戳，而duration的单位是分钟。
2. members、externalMembers对应的是参会人。

• members指的是这场会议在公司内部需要哪些人参与，是一个json数组，数组的每一项是参会人的账号，一般是邮箱的格式
• externalMembers指的是外部参会人，也是一个json数组，数组的每一项是外部参会人的邮箱，会议创建成功后，会向参会人发送邮件，告知如何入会。

3. enableGNet是否启用“全时云会议”，如果设置为是，则这场会议就可以调起全时的开会软件，可以电话入会，可以外呼参会人，可以网络视频，可以共享桌面，可以直播等等。
4. eventType。0-现场会议 1-视频会议 2-电话会议。

• 这里需要注意，当参数为2时，表示是通过电话开会，接口会返回一个会控地址(monitorUrl)，除此之外，还有callinJoinUrl、accessNumber_zh、accessNumber_en、accessNumberUrl这几个参数，也和电话会议相关
• 参数0和1，也会返回monitorURL、callinJoinUrl、accessNumber_zh、accessNumber_en、accessNumberUrl，但为null。

5. 接口统一会返回，主持人入会地址、内外部参会人入会地址，即：hostJoinUrl，attendeeJoinUrl，这个是为了方便主持人和参会人入会。还有主持人参会密码，参会人入会密码，hostPwd，attendeePwd。
6. allowHardVideo，入会方式，是否允许硬件视频入会 0-否 1-是 默认0，是一个设置项，在接口返回的参数ipList里，带上了硬件入会时的IP，在实际入会的过程中可能会用到。
7. callBackUrl，回调地址，日程状态有变更，会向这个地址发送消息。
8. priority，有多个会议的时候，设置会议的优先级。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	必须
├─ title	string	必须		日程标题
├─ location	string	非必须		日程地点
├─ summary	string	非必须		日程摘要
├─ owner	string	必须		日程主持人用户名
├─ members	string []	非必须		内部参会人用户名称数组	item 类型: string
├─		非必须
├─ externalMembers	string []	非必须		外部参会人用户名称数组	item 类型: string
├─		非必须
├─ startTime	number	必须		日程起始时间，Unix 时间戳 (单位：秒)
├─ duration	number	必须		日程时长，单位“分钟”
├─ priority	number	非必须		优先级， 0：不重要，１：重要； 选填，默认：０。
├─ enableGNet	boolean	非必须		是否启用“全时云会议”， 选填，默认：false
├─ callBackUrl	string	非必须		回调地址（POST 接口，接受 JSON 类型请求参数， 响应为 http 200 成功状态码）
├─ allowBox	integer	非必须		允许全时盒子入会，0（默认）：不允许，1：允许
├─ liveOpenFlag	number	非必须		是否开启直播（1：开启 0：不开启）
├─ livePassword	string	非必须		直播密码（6 位数字与英文组成，开启直播时传入， 可不传）
├─ eventType	integer	必须		0-现场会议 1-视频会议 2-电话会议
├─ allowHardVideo	integer	必须		入会方式，是否允许硬件视频入会 0-否 1-是 默认0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object	非必须
├─ owner	string	非必须		日程主持人用户名
├─ calendarId	number	非必须		日程ID
├─ groupId	number	非必须		日程讨论组ID
├─ pullUrl	string	非必须		拉流地址
├─ pullPwd	string	非必须		拉流密码
├─ hostJoinUrl	string	非必须		主持人入会地址
├─ attendeeJoinUrl	string	非必须		参会人入会地址
├─ monitorUrl	string	非必须		会控地址
├─ callinJoinUrl	string	非必须
├─ accessNumber_zh	string	非必须
├─ accessNumber_en	string	非必须
├─ accessNumberUrl	string	非必须
├─ hostPwd	string	非必须		主持人入会密码
├─ attendeePwd	string	非必须		参会人入会密码
├─ ipList	string []	非必须		入会方式为硬件视频时，返回硬件IP列表	item 类型: string
├─		非必须
errorMessage	string	非必须
requestId	string	非必须

编辑日程

基本信息

Path： /calendar/update

Method： POST

接口描述：

详见“创建会议”接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ calendarId	number	必须		日程ID
├─ title	string	非必须		日程标题
├─ location	string	非必须		日程地点
├─ summary	string	非必须		日程摘要
├─ owner	string	非必须		日程主持人用户名
├─ members	string []	非必须		内部参会人用户名称数组	item 类型: string
├─		非必须
├─ externalMembers	string []	非必须		外部参会人用户名称数组	item 类型: string
├─		非必须
├─ startTime	number	非必须		日程起始时间，Unix 时间戳
├─ duration	number	非必须		日程时长，单位“分钟”
├─ priority	number	非必须		优先级， 0：不重要，１：重要； 选填，默认：０。
├─ enableGNet	boolean	非必须		是否启用“全时云会议”， 选填，默认：false。
├─ allowBox	number	非必须		允许全时盒子入会，0（默认）：不允许，1：允许
├─ liveOpenFlag	string	非必须		是否开启直播（1：开启 0：不开启）
├─ livePassword	string	非必须		直播密码（6 位数字与英文组成，开启直播时传入， 可不传）
├─ eventType	integer	非必须		0-现场会议 1-视频会议 2-电话会议
├─ allowHardVideo	string	非必须		入会方式，是否允许硬件视频入会 0-否 1-是 默认0

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object	非必须
├─ owner	string	非必须		日程主持人用户名
├─ calendarId	number	非必须		日程ID
├─ groupId	number	非必须		日程讨论组ID
├─ pullUrl	null	非必须		拉流地址
├─ pullPwd	null	非必须		拉流密码
├─ hostJoinUrl	string	非必须		主持人入会地址
├─ attendeeJoinUrl	string	非必须		参会人入会地址
├─ monitorUrl	string	非必须		会控地址。电话会议会用到
├─ callinJoinUrl	string	非必须
├─ accessNumber_zh	string	非必须
├─ accessNumber_en	string	非必须
├─ accessNumberUrl	string	非必须
├─ hostPwd	string	非必须		主持人入会密码
├─ attendeePwd	string	非必须		参会人入会密码
├─ ipList	string []	非必须		入会方式为硬件视频时，返回硬件IP列表	item 类型: string
├─		非必须
errorMessage	string	非必须
requestId	string	非必须

取消日程

基本信息

Path： /calendar/cancel

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ calendarId	number	必须		日程ID
├─ owner	string	非必须		主持人用户名

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object	非必须
errorMessage	string	非必须
requestId	string	非必须

获取日程详情

基本信息

Path： /calendar/get

Method： POST

接口描述：

详见“创建会议”接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ calendarId	integer	非必须		日程ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object	非必须
├─ title	string	非必须		日程标题
├─ location	string	非必须		日程地址
├─ summary	string	非必须		日程摘要
├─ owner	string	非必须		日程主持人用户名
├─ members	object []	非必须		内部参会人信息数组	item 类型: object
├─ loginname	string	必须		内部参会人用户名。
├─ status	number	必须		内部参会人状态; 1: 等待， 2： 删除， 3：接受，４： 拒绝。
├─ externalMembers	object []	非必须		外部参会人信息数组，选填。	item 类型: object
├─ email	string	必须		外部参会人邮件地址
├─ status	number	必须		外部参会人状态; 1: 等待， 2： 删除， 3：接受，４： 拒绝。
├─ startTime	number	非必须		日程起始时间，Unix 时间戳
├─ duration	number	非必须		日程时长，单位“分钟”
├─ priority	number	非必须		优先级， 0：不重要，１：重要； 选填，默认：０。
├─ enableGNet	boolean	非必须		是否启用“全时云会议”， 选填，默认：false。
├─ callBackUrl	null	非必须		回调地址
├─ allowBox	null	非必须		允许全时盒子入会，0（默认）：不允许，1：允许
├─ liveOpenFlag	number	非必须		是否开启直播（1：开启 0：不开启）
├─ livePassword	null	非必须		直播密码
├─ calendarId	number	非必须		日程ID
├─ status	number	非必须		日程状态， 0：取消，1：正常
├─ hostJoinUrl	string	非必须		主持人参会地址
├─ attendeeJoinUrl	string	非必须		参会人入会地址
├─ monitorUrl	string	非必须		会控地址
├─ callinJoinUrl	string	非必须
├─ accessNumber_zh	string	非必须
├─ accessNumber_en	string	非必须
├─ accessNumberUrl	string	非必须
├─ hostPwd	string	非必须		主持人入会密码
├─ attendeePwd	string	非必须		参会人入会密码
├─ ipList	string []	非必须		入会方式为硬件视频时，返回硬件IP列表	item 类型: string
├─ rooms	array	非必须		此日程预定的会议室及设备列表	item类型 会议室信息对象
├─ deviceId	Integer	非必须		会议室/设备ID
├─ deviceType	Integer	非必须		设备类型，2：会议室；3：会议室关联的设备
├─ deviceName	String	非必须		会议室/设备名称
├─ approvalStatus	Integer	非必须		审批状态,0:待审核，1：未批准，2：已批准，3：已取消
├─ subDevices	Array	非必须		会议室下的设备列表	item类型：设备信息对象，字段定义同deviceId、deviceName、deviceType
├─		非必须
errorMessage	string	非必须
requestId	string	非必须

列出日程

基本信息

Path： /calendar/list

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ startTime	number	必须		起始时间，Unix 时间戳，必填
├─ endTime	number	必须		结束时间，Unix 时间戳，必填
├─ loginname	string	必须		查询指定用户的日程，选填，默认查询所有日程。
├─ direction	number	必须		查询方向， 0： 从开始时间向后查询，1：从结束时 间向前查询； 默认： 0； 最大列出会议数量 100.

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object []	非必须			item 类型: object
├─ title	string	必须		日程标题
├─ location	string	必须		日程地点
├─ summary	string	必须		日程摘要
├─ owner	string	必须		日程主持人用户名
├─ members	object []	必须		内部参会人信息数组，	item 类型: object
├─ loginname	string	必须		内部参会人用户名
├─ status	number	必须		内部参会人状态; 1: 等待， 2： 删除， 3：接受，４： 拒绝
├─ externalMembers	object []	必须		外部参会人信息数组	item 类型: object
├─ email	string	必须		外部参会人邮件地址
├─ status	number	必须		外部参会人状态; 1: 等待， 2： 删除， 3：接受，４： 拒绝。
├─ startTime	number	必须		起始时间，Unix 时间戳，
├─ duration	number	必须		日程时长，单位“分钟”
├─ priority	number	必须		优先级， 0：不重要，１：重要； 选填，默认：０
├─ enableGNet	boolean	必须		是否启用“全时云会议”
├─ callBackUrl	string	必须		回调地址（POST 接口，接受 JSON 类型请求参数， 响应为 http 200 成功状态码）
├─ allowBox	integer	必须		允许全时盒子入会，0（默认）：不允许，1：允许
├─ liveOpenFlag	number	必须		是否开启直播（1：开启 0：不开启）
├─ livePassword	string	必须		直播密码（6 位数字与英文组成，开启直播时传入， 可不传）
├─ calendarId	number	必须		日程ID
├─ status	number	必须
errorMessage	string	非必须
requestId	string	非必须

获取入会地址

基本信息

Path： /calendar/conference/link/get

Method： POST

接口描述：

获取参会人入会链接，如需更多会议信息，请调用“获取日程详情”接口

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ calendarId	integer	非必须		日程ID
├─ attendeeUser	string	非必须		参会人用户名（loginName） ；选填 备注： 1 可以为空; 2 不为空的话必须能够通过 attendeeUser 找到其 profile 3 attendeeUser 有值时，身份是根据 profile 获 取，参数中 role 无效
├─ attendeeName	string	非必须		自定义名称 ；选填 备注： 1 会中显示的名称。如果不为空则有最高显示优先 级。 2 attendeeUser 为空时必填
├─ role	string	非必须		身份区分 ；选填 1 主持人 0 参与人 备注： 1 当 attendeeUser 为空时必填; 2 不填默认参会人身份

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object	非必须
├─ link	string	非必须		入会链接
errorMessage	string	非必须
requestId	string	非必须

外呼参会人

基本信息

Path： /calendar/conference/attendee/dailout

Method： POST

接口描述：

通过电话号码，外呼参会人入会

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ calendarId	number	非必须		日程ID
├─ attendees	object []	非必须		需要召集的参会人列表	item 类型: object
├─ phone	string	必须		外呼号码，规则如下： ##1 国际标准写法： +861059933596， 分机+861059933596-3666 ##2 直接的外呼号码： 如 59933596,01059933596,13810366687， 013810366687 ##3 ACM 发送给应用的号码格式： （86）1059933596，分机（86）1059933596-3666 ##4 分机号码可以用-或者 w,,,分开，逗号的个数 不限，如 59933636-3596,599333636w,,,3596
├─ role	number	必须		身份区分 ；必填 1 主持人 0 参与人
├─ timeoutMinute	number	非必须		外呼通知时效，单位：分钟，不传值默认两天

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object []	非必须			item 类型: object
├─ phone	string	非必须		外呼号码
├─ attendeeId	string	非必须		ACM 外呼唯一标记，挂断电话时需要使用该数据
errorMessage	string	非必须
requestId	string	非必须

挂断参会人

基本信息

Path： /calendar/conference/attendee/hangup

Method： POST

接口描述：

通过电话号码，外呼参会人入会，参会人会接收到一个来电，此时调用此接口，会直接停止呼叫，挂断电话

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ calendarId	number	非必须		日程ID
├─ attendeeIds	string []	非必须		ACM 外呼唯一标记	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object	非必须
errorMessage	string	非必须
requestId	string	非必须

获取会议录制播放地址

基本信息

Path： /calendar/conference/replay/get

Method： POST

接口描述：

温馨提示：
会议结束并且会议期间需要录制，待录制服务器发出录制完成通知后才能得到录制播放地址

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ calendarId	number	非必须		日程ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	string	非必须		会议录制播放地址
errorMessage	string	非必须
requestId	string	非必须

获取会议录制下载地址

基本信息

Path： /calendar/conference/record/get

Method： POST

接口描述：

温馨提示：
会议结束并且会议期间需要录制，待录制服务器发出录制完成通知后才能得到录制下载地址

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ calendarId	number	非必须		日程ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	string	非必须		下载地址
errorMessage	string	非必须
requestId	string	非必须

获取直播流地址

基本信息

Path： /calendar/live/url

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ eventId	integer	非必须		日程ID
├─ pwd	string	非必须		直播密码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object	非必须
├─ status	integer	非必须		蜜蜂通道状态, 0:已创建，1：直播开始，2:直播结束, 3 合并中，4：会议结束点播中，5：会议结束无点播，6： 已关闭
├─ httpPullUrl	string	非必须		只有在 status 为 1 或 4 才
├─ hlsPullUrl	string	非必须		只有在 status 为 1 或 4 才
├─ rtmpPullUrl	string	非必须		只有在 status 为 1 或 4 才
errorMessage	string	非必须
requestId	string	非必须

设置是否允许移动端入会

基本信息

Path： /calendar/confsettingupdate

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须
├─ allow_mobile	integer	非必须		是否允许移动端入会 0:不允许 1:
├─ userId	number	非必须		用户 id ,用来修改该用户的会议

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	null	非必须
errorMessage	string	非必须
requestId	string	非必须

会议室

批量预定会议室

基本信息

Path： /calendar/room/reserv/multi

Method： POST

接口描述：

预约日程后，为日程预定会议室，支持一次预定多个会议室及会议室中的设备。

Tips 1：如果多次调用该接口，新的会覆盖旧的，即以最近一次预定的会议室列表为准。

Tips 2: 先后多次预定时，相比上次减少的会议室会自动取消预定，相比上次增加的会议室会新增预定。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	必须		业务参数
|--calendarId	integer	必须		日程ID
|--composeRoomList	array	必须		要预订的会议室信息列表
|-- roomId	interger	必须		会议室ID
|-- equipIdList	integer []	非必须		设备ID列表
─

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	必须		错误码，0：成功，非0：失败
data	object	非必须		NULL
errorMessage	string	非必须		错误描述
requestId	string	非必须		请求标识

获取会议室列表

基本信息

Path： /calendar/room/list

Method： POST

接口描述：

返回账号所在公司，所有会议室和会议室内的设备列表。
传递startTime和endTime，会标记会议室和设备在此时间段内的状态

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
data	object	非必须		业务参数
|-- startTime	integer	非必须		unix时间戳,单位：秒
|-- endTime	integer	非必须		unix时间戳，单位：秒

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object	非必须
├─ rooms	object []	必须			item 类型: object
├─ roomId	number	必须		会议室ID
├─ roomName	string	必须		会议室名称
├─ roomNote	string	非必须		备注
├─ roomCapacity	number	非必须		容量
├─ roomCity	string	非必须		所在城市
├─ roomLocation	string	非必须		详细地址
├─ roomLogoUrl	string	非必须		图片地址
├─ roomPhone	string	非必须		电话
├─ roomStatus	number	非必须		1-启用 2-停用
├─ status	null	必须		忙闲状态。0-闲 1-忙
├─ roomApprovalType	number	必须		是否需要审批 0-否 1-是
├─ equips	object []	必须		会议室内的所有设备	item 类型: object
├─ equipId	number	非必须		设备ID
├─ equipName	string	非必须		设备名称
├─ equipNote	string	非必须		备注
├─ equipLogoUrl	string	非必须		设备图片链接
├─ equipStatus	number	非必须		1-启用 2-停用
├─ status	string	必须		忙闲状态。0-闲 1-忙
errorMessage	string	非必须
requestId	string	非必须

预定单个会议室(计划废弃)

基本信息

Path： /calendar/room/reserv

Method： POST

接口描述：

为某个日程预定会议室和设备，预定成功，errorCode返回0

说明：此接口只支持预订一个会议室，后面将会废弃，推荐使用新接口 /calendar/room/reserv/multi,

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	必须		登录用户名
token	string	必须		凭据
calendarId	integer	必须		日程ID
roomId	integer	必须		会议室ID
equipIds	integer []	必须		设备ID列表	item 类型: integer
├─		非必须		设备ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
errorCode	number	非必须
data	object	非必须
├─ calendarId	number	非必须
├─ roomId	number	非必须
├─ equipIds	integer []	非必须			item 类型: integer
├─		非必须
errorMessage	string	非必须
requestId	string	非必须

​

更新日志

2020.6.15

1. 日程模块新增批量预订会议室接口，以前的单个预订和取消接口不推荐再使用，后面会废弃。

2019.5.10

1. 接口文档优化，增加了部分接口参数的详细解释。

2019.4.30

1. 日程创建、修改、详情接口增加了参数，支持电话会议，支持选择入会方式
2. 添加了部分接口请求、返回参数的说明

常见问题

1. 接口调试过程中遇到问题，如何提供有效的错误信息给平台开发人员，以方便排查？

调试时所在的环境，接口请求URL，接口请求和返回的参数，并简单的描述遇到的问题。将这些信息发送给全时对接人员。