创建分组

功能说明

创建会议分组。

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

实现方法

REST URL

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

请求参数说明

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

示例代码

请求示例

请求消息体示例（Json）

{
    "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	是否可以设置为分组管理员

请求失败结果示例

{
    "developerMessage": "",
    "userMessage": "error.no.meeting",
    "errorCode": 66620,
    "moreInfo": "http://www.com.ainemo.com/errors/66620"
}

错误码

以下仅列出该接口业务逻辑错误码，其他错误码见小鱼RESTAPI错误码

错误码	描述
66620	没有进行中的会议
66684	会议分组讨论已开启
66685	分组数量超过最大限制

2024-11-13 14:29:40

导出PDF文档