添加会议室
请求方法
POST
请求地址
/rooms
请求参数
请求参数 |
参数类型 |
数据类型 |
是否必须 |
参数说明 |
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 |
服务端异常 |
响应参数
参数 |
数据类型 |
描述 |
id |
String |
会议室Id |
partyId |
String |
企业id |
name |
String |
名称 |
type |
Integer |
会议室类型 0:普通会议室 1: 视频会议室 |
capacity |
Integer |
会议室容量 |
description |
String |
会议室描述 |
请求消息示例
POST /open/api/v2/rooms
HTTP/1.1
Host: api.yealink.com
Content-Type: application/json
{
"name": "测试添加",
"groupId": "a40837d3b2214c198488fcc29c2d3bce",
"capacity": 20,
"description": "",
"number": "5259",
"phoneExtension": "5259",
"password": "cBAmciZ6YKg2ggzdngGL/CVd2nvInr3TOeZmKxmJbU3vNXP7PYYDlCqiooPQcylPoo409s64bp6aZwZ74wRNqA2lQCpemH4bIhHfARyhWXADzSuhSBTmBGEoHUk02rTuKrpsYJkjLUfwH2p1259E3pLpTNJvxpa2t4tdLee5wYo=",
"followPassword": true,
"phoneExtensionPassword": "PN1kzZQVdzhgdLAcujLK2BcS0vYtfL3KMuzHTQ2n/TF0+i6VpLC6MqqAZSA0hj0cOi1j18/QMjSF799nDVcrMiHD5AcnGnfu/LiMGI6v3IVUsz+jFRIzNpJ/GI3+a45aF6LGZRYuuF2PsYVl8NjNJLW+Kg4qYJ1WLi3dU8qNq78=",
"type": 1,
"maxVideoConcurrentAmount": 1000,
"enableAudioPermission": true
}
响应消息示例
HTTP/1.1 200
Content-Type: application/json;charset=UTF-8
{
"id": "9b965ad9ec734e33a7c0ee2a9eb2b533",
"partyId": "ee8f134d5bb64c80830dc4f58ea8c543",
"name": "测试添加",
"type": 1,
"capacity": 20,
"description": ""
}
CURL命令示例
curl -X POST \
-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": "cBAmciZ6YKg2ggzdngGL/CVd2nvInr3TOeZmKxmJbU3vNXP7PYYDlCqiooPQcylPoo409s64bp6aZwZ74wRNqA2lQCpemH4bIhHfARyhWXADzSuhSBTmBGEoHUk02rTuKrpsYJkjLUfwH2p1259E3pLpTNJvxpa2t4tdLee5wYo=",
"followPassword": true,
"phoneExtensionPassword": "PN1kzZQVdzhgdLAcujLK2BcS0vYtfL3KMuzHTQ2n/TF0+i6VpLC6MqqAZSA0hj0cOi1j18/QMjSF799nDVcrMiHD5AcnGnfu/LiMGI6v3IVUsz+jFRIzNpJ/GI3+a45aF6LGZRYuuF2PsYVl8NjNJLW+Kg4qYJ1WLi3dU8qNq78=",
"type": 1,
"maxVideoConcurrentAmount": 1000,
"enableAudioPermission": true
}' \
'https://api.yealink.com/open/api/v2/rooms'