查询云会议室列表

请求方法

GET

请求地址

/vmrs

请求参数

请求参数	参数类型	数据类型	是否必需	描述
limit	Query	Long	否	获取的最大记录数，默认为10，最大100
offset	Query	Long	否	跳过的记录数，默认为0
groupId	Query	String	否	指定查询的起始分组，长度32，未指定则默认从根分组开始查询
searchKey	Query	String	否	模糊查询关键字，长度小于128，支持按名称搜索

HTTP状态码

返回值	描述
200	操作成功，详见响应参数
400	客户端传参异常
401	鉴权失败
500	服务端异常

响应参数

参数	数据类型	描述
offset	Long	偏移量
limit	Long	返回最大数量
total	Long	总数据量
data	Vmr[]	vmr信息数组

Vmr对象定义

参数	数据类型	描述
id	String	vmr Id
name	String	名称
number	String	会议号码
password	String	密码
profile	String	会议模式，0：视频会议模式；2：研讨会模式；3：语音会议模式
groupId	String	分组Id
organizerName	String	组织者名称

请求消息示例

GET /open/api/v2/vmrs?limit=3&offset=0 HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

响应消息示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
    "offset": 0, 
    "limit": 3, 
    "total": 7, 
    "data": [
        {
            "id": "147d94feddaf4d4f85dbb773f196b703", 
            "name": "test-参会者角色类型错误", 
            "number": "242309*10006", 
            "password": "346237", 
            "profile": "0",
            "groupId": "452ae18eb3164c999d197f97f9d4fd72", 
            "organizerName": "大帅-dev企业"
        }
    ]
}

CURL命令示例

curl -XGET -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' 'https://api.yealink.com/open/api/v2/vmrs?limit=3&offset=0'