开发者中心 - 小鱼易连

一、创建分组

功能说明

创建会议分组。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/meeting/dynamicGroup?enterpriseId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	传v1即可	公有云分区云5.2-20260327
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	公有云分区云5.2-20260327
meetingRoomNumber	String	Body	是	无	会议室号码	公有云分区云5.2-20260327
groupList	Object[]	Body	否	无	分组列表，最大 30	公有云分区云5.2-20260327
└ groupName	分组名称	Body	否	无	分组名称	公有云分区云5.2-20260327
└ memberList	String	Body	否	无	成员列表，最大 100	公有云分区云5.2-20260327
└ └id	long	Body	否	无	参会方id，可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	公有云分区云5.2-20260327
└ └type	int	Body	否	无	参会方设备类型，可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	公有云分区云5.2-20260327
└└participantNumber	String	Body	否	无	参会者设备号，设备类型为H.323/SIP终端时必须传。可以从“主持会议 - 查看全体成员的会议状态”API查询： participantNumber表示参会者设备号	公有云分区云5.2-20260327
mode	String	Body	否	random	random随机分配（如果未设置groupCount，则根据与会人员数量分组），manual指定终端创建分组	公有云分区云5.2-20260327
groupCount	Integer	Body	否	1	分组数量，random随机分配使用，最大 30	公有云分区云5.2-20260327
groupName	String	Body	否	无	分组名称	公有云分区云5.2-20260327

示例代码

请求示例

{
    "meetingRoomNumber":"910004217404",
    "mode": "manual",
    "groupList": [
        {
            "groupName": "分组1",
            "memberList": [
                {
                    "id": 101990441,
                    "type": 5,
                    "participantNumber": "18961782725"
                }
            ]
        },
        {
            "groupName": "分组2",
            "memberList": [
                {
                    "id": 101875491,
                    "type": 5,
                    "participantNumber": "18811119988"
                }
            ]
        }
    ]
}

响应结果示例

[
    {
        "groupNo": "mmsd502ca7b72654893a0e7d8a7144d0323",
        "groupName": "分组2",
        "memberList": [
            {
                "id": 101990441,
                "type": 5,
                "externalUserId": null,
                "participantNumber": "18811119988",
                "admin": false,
                "canSetAdmin": true
            }
        ]
    },
    {
        "groupNo": "mms63acf388382c40d7ad8afb57827c5ee5",
        "groupName": "分组1",
        "memberList": [
            {
                "id": 101875491,
                "type": 5,
                "externalUserId": null,
                "participantNumber": "18811119922",
                "admin": false,
                "canSetAdmin": true
            }
        ]
    }
 ]

返回参数说明：

参数	说明
groupNo	分组号
groupName	分组名称
id	与会设备id
type	与会设备type
externalUserId	与会设备三方id
participantNumber	与会设备呼号
admin	是否为分组管理员
canSetAdmin	是否可以设置为分组管理员

二、开启或结束分组

功能说明

开启或结束某个会议的分组会议。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/meeting/dynamicGroup/operate?enterpriseId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	是否必须	默认值	说明	初始平台
version	String	Path	是	无	v1	公有云分区云5.2-20260327
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	公有云分区云5.2-20260327
meetingRoomNumber	String	Body	是	无	会议室号码	公有云分区云5.2-20260327
action	String	Body	是	无	start开启会议分组 end结束会议分组	公有云分区云5.2-20260327

示例代码

请求示例

{
  "meetingRoomNumber": "910004217404",
  "action": "start"
}

响应结果示例

请求成功时返回http状态码200

三、设置分组管理员

功能说明

在开启分组前设置分组的管理员。分组管理只支持软终端，不能是管理员的有：监控、小程序、webrtc、323、主持人、硬终端、pstn

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/meeting/dynamicGroupAdmin?enterpriseId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	是否必须	默认值	说明	初始平台
version	String	Path	是	无	v1	公有云分区云5.2-20260327
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	公有云分区云5.2-20260327
meetingRoomNumber	String	Body	是	无	会议室号码	公有云分区云5.2-20260327
adminn		Body	是	无	分组管理员，只限软终端（手机端、PC 端）支持。	公有云分区云5.2-20260327
└id	long	Body			参会方id，可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	公有云分区云5.2-20260327
└type	int	Body	是	无	参会方设备类型，可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询。只能传 1、5	公有云分区云5.2-20260327
└participantNumber	String	Body	是	无	参会者设备号，设备类型为H.323/SIP终端时必须传。可以从“主持会议 - 查看全体成员的会议状态”API查询： participantNumber表示参会者设备号	公有云分区云5.2-20260327
groupNo	String	Body	是	无	分组号	公有云分区云5.2-20260327

示例代码

请求示例

{
    "groupNo": "mmsc4ab0d16c3bc4957afb87f1370d1f9f0",
    "meetingRoomNumber": "910004217404",
    "admin": {
        "id": 101990441,
        "type": 5,
        "participantNumber": "18811119988"
    }
}

响应结果示例

请求成功时返回http状态码200

四、移入或移出分组

功能说明

将某些设备从一个分组（或主会议）移到另一个分组（或主会议）

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/external/v1/conferenceControl/meeting/dynamicGroup/moveMember?enterpriseId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	是否必须	默认值	说明	初始平台
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	公有云分区云5.2-20260327
meetingRoomNumber	String	Body	是	无	会议室号码	公有云分区云5.2-20260327
fromGroupNo	String	Body	否	无	来源分组；为空/null 表示主会议	公有云不存在分区云5.2-20260928
toGroupNo	String	Body	否	无	目标分组；为空/null 表示主会议	公有云不存在分区云5.2-20260928
deviceMembers	Object[]	Body	否	无	批量成员列表；最大 50 个	公有云不存在分区云5.2-20260928
└id	long	Body	否	无	参会方id，可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	公有云分区云5.2-20260327
└type	int	Body	否	无	参会方设备类型，可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	公有云分区云5.2-20260327
└participantNumber	String	Body	否	无	参会者设备号，设备类型为H.323/SIP终端时必须传。可以从“主持会议 - 查看全体成员的会议状态”API查询： participantNumber表示参会者设备号	公有云分区云5.2-20260327

示例代码

请求示例

{
    "meetingRoomNumber": "910004217404",
    "fromGroupNo":null,
    "toGroupNo": "mms3d4eb008deef4c1982730b5e70c54eec",
    "deviceMembers": [{
        "id": 101990441,
        "type": 5,
        "participantNumber": "+86-18811119988"
    }]
}

响应结果示例

请求成功时返回http状态码200

五、指定分组成员返回主会议

功能说明

将指定的一个或多个讨论组成员全部返回主会议。本接口不限定调用角色，不受未来「允许随时返回主会议」开关约束（该开关约束客户端自行返回行为）。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST /api/rest/external/v1/conferenceControl/meeting/dynamicGroup/returnToMain?enterpriseId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	是否必须	默认值	说明	初始平台
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	公有云不存在分区云5.2-20260928
meetingRoomNumber	String	Body	是	无	会议室号码	公有云不存在分区云5.2-20260928
groupNoList	String[]	Body	是	无	分组列表	公有云不存在分区云5.2-20260928

示例代码

请求示例

{
    "meetingRoomNumber": "910004217404",
    "groupNoList": ["mms3d4eb008deef4c1982730b5e70c54eec"]
}

响应结果示例

请求成功时返回http状态码200

六、查询会议分组结构与状态

功能说明

查询会议分组结构与状态（分组状态 + 组数 + 每组名称/id/人数，不含成员明细）。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

GET /api/rest/external/v1/conferenceControl/meeting/dynamicGroup/structure?enterpriseId=XXX&meetingRoomNumber=XXX

请求参数说明

参数

参数类型

参数位置

是否必须

默认值

说明

初始平台

enterpriseId

String

Query

是

无

企业ID，通过管理平台-云视讯API获得

公有云不存在

分区云5.2-20260928

meetingRoomNumber

String

Query

是

无

会议室号码

公有云不存在

分区云5.2-20260928

示例代码

响应结果示例

{
  "meetingRoomNumber": "9100363737",
  "discussing": true,
  "groupCount": 2,
  "groups": [
    {"groupNo": "G1", "groupName": "讨论组1", "memberCount": 12, "status": "ACTIVE"},
    {"groupNo": "G2", "groupName": "讨论组2", "memberCount": 8,  "status": "ACTIVE"}
  ]
}

响应参数说明

参数	参数类型	说明	初始平台
meetingRoomNumber	String	会议室号码	公有云不存在分区云5.2-20260928
discussing	boolean	是否处于分组讨论中	公有云不存在分区云5.2-20260928
groupCount	Int	活动分组数量	公有云不存在分区云5.2-20260928
groups	Object[]	分组集合	公有云不存在分区云5.2-20260928
└groupNo	String	分组号	公有云不存在分区云5.2-20260928
└groupName	String	分组名称	公有云不存在分区云5.2-20260928
└memberCount	int	成员数	公有云不存在分区云5.2-20260928
└status	String	目前固定ACTIVE	公有云不存在分区云5.2-20260928

七、分页查询某分组成员列表

功能说明

分页查询某分组成员列表（包含已入会成员和未入会邀请成员）。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

GET /api/rest/external/v1/conferenceControl/meeting/dynamicGroup/members?enterpriseId=ff8080816ce1fed8016cefd84c23008b&meetingRoomNumber=9100363737&groupNo=G1&pageIndex=1&pageSize=100

请求参数说明

参数	参数类型	参数位置	是否必须	默认值	说明	初始平台
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	公有云不存在分区云5.2-20260928
meetingRoomNumber	String	Query	是	无	会议室号码	公有云不存在分区云5.2-20260928
groupNo	String	Query	是	无	分组号码	公有云不存在分区云5.2-20260928
pageIndex	int	Query	否	0	页码	公有云不存在分区云5.2-20260928
pageSize	int	Query	否	100	每页数量，最大 100	公有云不存在分区云5.2-20260928

示例代码

响应结果示例

{
    "page": 0,
    "pageTotal": 1,
    "rowsTotal": 3,
    "rows": 3,
    "list": [
    {"deviceId":"100001","deviceUri":"100001@DESK","displayName":"张三","number":"13800000001","role":"group_admin","joined":true, "groupAdmin":true},
    {"deviceId":"100002","deviceUri":"100002@SOFT","displayName":"李四","number":"13800000002","role":"participant","joined":true, "groupAdmin":false},
    {"deviceId":"100003","deviceUri":"100003@WECHAT","displayName":"王五","number":null,"role":"participant","joined":false,"groupAdmin":false}
  ]
}

响应参数说明

参数	参数类型	说明	初始平台
page	Int	当前页（pageIndex）	公有云不存在分区云5.2-20260928
pageTotal	Int	总页数	公有云不存在分区云5.2-20260928
rowsTotal	Int	数据总条数	公有云不存在分区云5.2-20260928
rows	Int	每页面显示条数（pageSize）	公有云不存在分区云5.2-20260928
deviceId	Int	成员 id	公有云不存在分区云5.2-20260928
deviceUri	Object[]	成员 uri	公有云不存在分区云5.2-20260928
displayName	String	名称	公有云不存在分区云5.2-20260928
number	String	成员号码	公有云不存在分区云5.2-20260928
role	String	角色：host / co_host / group_admin / participant	公有云不存在分区云5.2-20260928
joined	boolean	是否已入会；false 表示仍在邀请集合	公有云不存在分区云5.2-20260928
groupAdmin	String	是否分组管理员	公有云不存在分区云5.2-20260928

八、设置是否允许分组成员自行返回主会议

功能说明

设置当前会议是否允许分组成员自行返回主会议。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST /api/rest/external/v1/conferenceControl/meeting/dynamicGroup/allowReturnMain?enterpriseId=ext_demo&meetingRoomNumber=9100000001&enable=true

请求参数说明

参数	参数类型	参数位置	是否必须	默认值	说明	初始平台
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	公有云不存在分区云5.2-20260928
meetingRoomNumber	String	Query	是	无	会议室号码	公有云不存在分区云5.2-20260928
enable	boolean	Query	是	无	true 允许成员自行返回；false 禁止	公有云不存在分区云5.2-20260928

示例代码

响应结果示例

请求成功时返回http状态码200

错误码

错误码	描述
66620	没有进行中的会议
66658	主持人不能设置为分组管理员
66684	会议分组讨论已经开启
66686	设备不在会中
66687	错误的分组号，分组不存在
66685	分组数量超过最大限制
66605	分组不存在
66639	参数非法
66644	操作受限/含不可调整对象（主持人/联席/监会/备份/翻译员/小程序/监控/contentonly/等候室）
66689	未进入分组
66611022	并发冲突，其他入口正在调整该分组
66611021	禁止返回主会议
66611024	端点侧频控
66690	设备已在分组中
66654	分组管理员更新失败
6667	批量超过 50 人

2026-08-25 15:33:57

导出PDF文档