已预约的会议绑定盒子
- 盒子与已预约会议绑定接口
- 盒子的客户编码需要与会议主持人的客户编码（customerCode）一致，即盒子与会议主持人在一个客户下
- 尽量让客户提前将盒子和会议室在会议管理中心进行绑定
- 每次绑定都会清空该conferenceId之前绑定的所有盒子信息，以本次提交的盒子来绑定会议
1. 接口描述
接口名称：
http://confopenapi.quanshi.com/conference/conference/confBindBox
发送方式：
POST
参数格式：
accept: application/json;content-type: application/json
2. 输入参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| boxInfoList | 是 | 数组 | 盒子ID和会议室ID的绑定对应关系,数组最大长度为20；若boxInfoList为空，表示删除该conferenceId之前绑定的所有盒子 |
| conferenceId | 是 | 字符串 | 已预约的会议id ，不允许为空 |
boxInfoList参数：
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| boxId | 是 | string array | 盒子id数组（盒子ID必须跟会议主持人在一个客户下，即customerCode相同） |
| conferenceRoomId | 是 | int | 盒子绑定的会议室ID（如果盒子绑定了会议室传会议室ID，如果没绑定则传0） |
| conferenceRoomPhone | 否 | string | 会议室电话 |
3. 示例
请求示例
{
"boxInfoList": [{
"boxId": "GN3399BOX0001856",
"conferenceRoomId": 187567899,
"conferenceRoomPhone": "010-256567"
}, {
"boxId": "GN3399BOX0001429",
"conferenceRoomId": 187567899,
"conferenceRoomPhone": "010-256597"
}, {
"boxId": "GN3399BOX0001875",
"conferenceRoomId": 187567999,
"conferenceRoomPhone": "010-256598"
}],
"conferenceId": "239376958"
}
删除会议绑定的请求示例
{
"boxInfoList": [],
"conferenceId": "239376700"
}
返回示例(正常)
{
"status": 0,
"result": {
"invalidBoxIdList": [],
"successBoxIdList": [{
"boxId": "GN3399BOX0001856",
"conferenceRoomId": 187567899,
"conferenceRoomPhone": "010-256567"
}, {
"boxId": "GN3399BOX0001429",
"conferenceRoomId": 187567899,
"conferenceRoomPhone": "010-256597"
}, {
"boxId": "GN3399BOX0001875",
"conferenceRoomId": 187567999,
"conferenceRoomPhone": "010-256598"
}]
},
"request_id": "confopenapiserver-192.168.22.47-1610417984.700268000.81",
"reqid": "confopenapiserver-192.168.22.47-1610417984.700268000.81",
"timestamp": 1610417984700,
"content_type": "application/json",
"product_type": "",
"device_type": "",
"iscycle": "",
"isgnet": "",
"mem_count": "",
"verify": "",
"video_conference_mode": "",
"live_flag": "",
"conferenceid": "",
"record": 0,
"share_media": 0,
"hardware_video": 0,
"accessNumber": "",
"client_ip": "",
"request_duration": "1.877526067s"
}
返回示例(传递的盒子全部未通过校验） ---该错误返回中包含盒子的客户编码与会议主持人的客户编码不一致的错误返回的示例)
{
"status": 51208,
"result": {
"invalidBoxIdList": [{
"boxId": "GN3399BOX0001856",
"conferenceRoomId": 187567899,
"conferenceRoomPhone": "010-256567",
"errMsg": "the customerCode of this boxId: GN3399BOX0001856 difference with conference host's customerCode"
}, {
"boxId": "GN3399BOX0001429",
"conferenceRoomId": 187567899,
"conferenceRoomPhone": "010-256597",
"errMsg": "the customerCode of this boxId: GN3399BOX0001429 difference with conference host's customerCode"
}, {
"boxId": "GN3399BOX0001875",
"conferenceRoomId": 187567999,
"conferenceRoomPhone": "010-256598",
"errMsg": "the customerCode of this boxId: GN3399BOX0001875 difference with conference host's customerCode"
}],
"successBoxIdList": []
},
"msg": "the num of valid boxIds is 0",
"request_id": "confopenapiserver-192.168.22.47-1610417816.588745000.81",
"reqid": "confopenapiserver-192.168.22.47-1610417816.588745000.81",
"timestamp": 1610417816588,
"content_type": "application/json",
"product_type": "",
"device_type": "",
"iscycle": "",
"isgnet": "",
"mem_count": "",
"verify": "",
"video_conference_mode": "",
"live_flag": "",
"conferenceid": "",
"record": 0,
"share_media": 0,
"hardware_video": 0,
"accessNumber": "",
"client_ip": "",
"request_duration": "1.233418452s"
}
返回示例(传递的盒子存在无效的盒子)
{
"status": 0,
"result": {
"invalidBoxIdList": [{
"boxId": "GN3399BOX0001859",
"conferenceRoomId": 187567899,
"conferenceRoomPhone": "010-256567",
"errMsg": "not found box info by boxId:GN3399BOX0001859"
}],
"successBoxIdList": [{
"boxId": "GN3399BOX0001429",
"conferenceRoomId": 187567899,
"conferenceRoomPhone": "010-256597"
}, {
"boxId": "GN3399BOX0001875",
"conferenceRoomId": 187567999,
"conferenceRoomPhone": "010-256598"
}]
},
"request_id": "confopenapiserver-192.168.22.47-1610418262.235930000.887",
"reqid": "confopenapiserver-192.168.22.47-1610418262.235930000.887",
"timestamp": 1610418262235,
"content_type": "application/json",
"product_type": "",
"device_type": "",
"iscycle": "",
"isgnet": "",
"mem_count": "",
"verify": "",
"video_conference_mode": "",
"live_flag": "",
"conferenceid": "",
"record": 0,
"share_media": 0,
"hardware_video": 0,
"accessNumber": "",
"client_ip": "",
"request_duration": "1.655531488s"
}
4. 返回参数
| 参数名 | 类型 | 说明 |
|---|---|---|
| status | int | 0:成功，非0失败 （50103：请求的参数不合法；50709：会议不存在；51104：未查到会议主持人账号信息；51101：校验管理员失败，请检查核对使用的证书是否与会议主持人在同一个客户下；51208：传递的所有盒子均为通过校验） |
| result | object | 接口返回结果 |
| request_id | string | 接口请求唯一标识 |
返回 result 参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| successBoxIdList | object 数组 | 与会议绑定成功的盒子信息 |
| invalidBoxIdList | object 数组 | 与会议未绑定成功的盒子信息 |
返回 result.successBoxIdList 参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| boxId | string array | 盒子id数组（盒子ID必须跟会议主持人在一个客户下，即customerCode相同） |
| conferenceRoomId | int | 盒子绑定的会议室ID（如果盒子绑定了会议室传会议室ID，如果没绑定则传0） |
| conferenceRoomPhone | string | 会议室电话 |
返回 result.invalidBoxIdList 参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| boxId | string array | 盒子id数组（盒子ID必须跟会议主持人在一个客户下，即customerCode相同） |
| conferenceRoomId | int | 盒子绑定的会议室ID（如果盒子绑定了会议室传会议室ID，如果没绑定则传0） |
| conferenceRoomPhone | string | 会议室电话 |
| errMsg | string | 失败原因 |
备注
- 更多返回错误代码请看首页的错误代码描述
