创建企业永久云会议室号

功能说明

永久云会议室号有数量限制，默认限制100个，请合理使用。

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

实现方法

REST URL

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

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	v1
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参见签名规则
meetingName	String	Body	是	sdk meeting room	云会议室的名称	3.9
requirePassword	boolean	Body	否	无	是否需要密码，如果为true，则会默认生成一个6位数字密码；如为false，则该会议没有密码	3.9
password	String	Body	否	无	指定密码，如果用户指定了密码，那么该云会议室默认有密码。如果用户没有指定密码，但是require_password为true，小鱼会自动生成密码	3.9
controlPassword	String	Body	否	无	主持会议密码	3.9
autoMute	String	Body	否	0	0: 智能静音（默认第6个人以后自动静音）；1: 全部静音；2: 不静音	3.9
configs	Map	Body	否	无	云会议室扩展配置Object	3.9
└ autoRecord	boolean	Body	否	false	是否自动录制	3.9
└ smartMutePerson	String	Body	否	6	智能静音人数：从第几个人开始启动智能静音	3.9
└ onlyRecordMainImage	boolean	Body	否	false	只录制主画面	3.9
└ recordAddDeviceName	boolean	Body	否	false	是否在录制视频中叠加终端名称	3.9
└ pushAudioStream	boolean	Body	否	无	服务端推流开关： true：打开 false：关闭	3.9
└ enableWaitingRoom	boolean	Body	否	无	是否打开等候室： true：打开 false：关闭	公有云及分区云20241018

示例代码

请求消息体示例（Json）

{
    "meetingName": "小毛的会议室",
    "requirePassword": true,
    "password": "123456",
    "controlPassword": "123456",
    "autoMute": 0,
    "configs":{
        "autoRecord":false
        ···
    }
}

返回结果示例：

成功时返回结果数据，失败时返回小鱼RESTAPI错误码

{
    "meetingNumber": "900111222",
    "controlPassword": "123456",
    "password": "123456"
}

返回参数说明

参数名称	说明
meetingNumber	会议号
controlPassword	会控密码
password	密码

2024-10-23 15:37:46

导出PDF文档