编辑会议室
请求方法
PUT
请求地址
/rooms/{roomId}
请求参数
请求参数 | 参数类型 | 数据类型 | 是否必须 | 参数说明 |
---|---|---|---|---|
roomId | path | String | 是 | 会议室Id |
name | body | String | 是 | 会议室名称。 必填,支持输入1-64个字符,文本形式不限。会议室名称不做唯一性校验 |
groupId | body | String | 是 | 父节点ID(原groupId) |
capacity | body | Integer | 是 | 实体会议室的能够支持的与会最大人数。必填,仅限数字(正值,<=500) |
description | body | String | 是 | 指会议室的简介,用于在客户端或者门牌上预约时查看。非必填,文本形式不限,最大支持输入256个字符 |
number | body | String | 是 | 云账号,符合用户账号号码资源。视频会议室必传,普通会议室不用传 |
phoneExtension | body | String | 是 | 电话分机号,符合电话分机号号码资源,为空的时候自动生成。视频会议室必传,普通会议室不用传 |
password | body | String | 否 | 明文密码,需要符合系统设置的密码安全策略,为空的时候自动生成。 |
followPassword | body | Boolean | 是 | 分机密码是否跟随账号密码 |
phoneExtensionPassword | body | String | 是 | 明文密码,需要符合系统设置的密码安全策略,为空的时候自动生成。普通会议室不用传,视频会议室followPassword=false时必传,followPassword=true时不传 |
type | body | Integer | 是 | 终端类型,0为普通会议室,1为视频会议室 |
maxVideoConcurrentAmount | body | Integer | 否 | 最大视频并发数(2-9999),为视频会议室时必传。 |
enableAudioPermission | body | Boolean | 否 | 是否启用音频权限,不传默认true |
HTTP状态码
返回值 | 描述 |
---|---|
200 | 操作成功,详见响应参数 |
400 | 客户端传参异常 |
401 | 鉴权失败 |
500 | 服务端异常 |
请求消息示例
PUT /open/api/v2/rooms/a40837d3b2214c198488fcc29c2d3222
HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"name": "测试添加",
"groupId": "a40837d3b2214c198488fcc29c2d3bce",
"capacity": 20,
"description": "",
"number": "5259",
"phoneExtension": "5259",
"password": "2PtTSSvH",
"followPassword": true,
"phoneExtensionPassword": "2PtTSSvH",
"type": 1,
"maxVideoConcurrentAmount": 1000,
"enableAudioPermission": true
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
CURL命令示例
curl -X PUT \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' \
-H 'Content-Type: application/json' \
-H 'timestamp: 1583742732181' \
-H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' \
-d '{
"name": "测试添加",
"groupId": "a40837d3b2214c198488fcc29c2d3bce",
"capacity": 20,
"description": "",
"number": "5259",
"phoneExtension": "5259",
"password": "2PtTSSvH",
"followPassword": true,
"phoneExtensionPassword": "2PtTSSvH",
"type": 1,
"maxVideoConcurrentAmount": 1000,
"enableAudioPermission": true
}' \
'https://api.yealink.com/open/api/v2/rooms/a40837d3b2214c198488fcc29c2d3222'