创建SDK云会议室号

功能说明

创建会议的云服务API，用于合作伙伴直接创建一个云会议室号，用于直接呼叫、预约会议、预约直播等操作。用户在创建云会议室号时，可选择是否需要密码以及云会议室号的生效时间、失效时间等。

注意：云服务API创建的云会议室号，是有时长限制的。这个时长由start_time和end_time限制，但是最长时间没有限制。如果不传start_time，那么云会议室将从当前时间生效，会在三个月后过期；如果传了start_time，那么必须传end_time，云会议室在end_time过期。云会议室过期后，不能再呼叫入会，但是已经在会议里面的人不受影响。

有效期内的SDK会议室数量默认最大限制一万，数量如不满足需求请联系小鱼支持人员。

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

实现方法

REST URL

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

请求参数说明

参数	参数类型	参数位置	是否必须	默认值	说明	初始平台
version	String	Path	是	无	传v1即可	3.9
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	3.9
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参考签名鉴权	3.9
meetingName	String	Body	否	sdk meeting room	云会议室的名称	3.9
startTime	long	Body	否	无	云会议室生效时间， Unix时间戳（毫秒数）【如果startTime和endTime都不传，则有效期三个月】	3.9
endTime	long	Body	否	无	云会议室失效时间，Unix时间戳（毫秒数）【如果startTime和endTime都不传，则有效期三个月】,如果传了 startTime，那么必须传 endTime ,并且 endTime 必须大于 startTime	3.9
maxSharedSession	int	Body	否	无	会议最大方数（会议最大人数），硬终端不计方数。无需限制该云会议室参会人数，不需要设置该值。（仅公有云使用）	6.0
maxParticipant	int	Body	否	无	会议最大方数（会议最大人数），硬终端不计方数。无需限制该云会议室参会人数，不需要设置该值。（仅限分区5.2使用）	3.9
requirePassword	boolean	Body	否	无	是否需要密码，如果为true，则会默认生成一个6位数字密码；如为false，则该会议没有密码	3.9
password	String	Body	否	无	指定密码，如果用户指定了密码，那么该云会议室默认有密码。如果用户没有指定密码，但是require_password为true，小鱼会自动生成密码	3.9
controlPassword	String	Body	否	随机生成6位数字会控密码	主持会议密码	3.9
autoMute	String	Body	否	0	0: 智能静音（默认第6个人以后自动静音）1: 全部静音 2: 不静音	3.9
onlyScheduledCall	Integer	Body	否	无	0或无: 不限制预约呼叫 1: 仅限制预约呼叫	5.2
internetCallLimit	Integer	Body	否	无	互联网端呼叫限制 0或无: 不限制 1: 限制	公有云
bindAccount	String	Body	否	无	设置会议室owner，支持手机号和ExternalUserId	5.2
configs	Map	Body	否	无	云会议室扩展配置Object	3.9
└ autoRecord	boolean	Body	否	false	是否自动录制	3.9
└ smartMutePerson	String	Body	否	6	智能静音人数：从第几个人开始启动智能静音返回值在 (0, Integer.MAX) 中	3.9
└ onlyRecordMainImage	boolean	Body	否	false	只录制主画面	3.9
└ recordAddDeviceName	boolean	Body	否	false	是否在录制视频中叠加终端名称	3.9
└ hrRecord	boolean	Body	否	false	是否开启超高清录制（1080P）	3.9
└ mediaEncrypt	String	Body	否	无	会议室加密能力：AUTO、AES256、SM4; 如果输入非以上三个内容则自动填充为AUTO	3.9
└ watermark	int	Body	否	无	是否开启会议水印：0 不开启，1 开启会议水印	3.9
└ inoutReminder	boolean	Body	否	false	是否开启客户端出入会消息通知：false 不开启，true 开启	3.9
└ pushAudioStream	boolean	Body	否	false	是否开启服务端推流：false 不开启，true 开启（打开服务端推流需要打开相应权限）	3.9
└ enableWaitingRoom	boolean	Body	否	false	是否开启等候室：false 不开启，true 开启	公有云及分区云20241018
└subtitle	boolean	Body	否	无	是否开启通话字幕 true 开启 false 关闭注：开启通话字幕需要申请企业权限
└transcriptionMode	Integer	Body	否	无	会议纪要模式 0 关闭会议纪要 1 开启录制会议纪要模式 2 开始入会会议纪要模式注：开启会议纪要模式需要申请企业权限
└generateExtraAudio	boolean	Body	否	无	额外生成音频文件
└recordingBitrate	Integer	Body	否	无	码率（取值范围 200-10000，单位为Kbps） 4K--4000~10000、1080P--1000~4000、720P--500~2000、480P--200~1000	仅公有云
└recordingResolution	String	Body	否	无	分辨率（字符串） 4K、1080P、720P、480P	仅公有云
└allowCallScope	String	Body	否	1	允许呼叫范围（1所有成员，2企业成员）	公有云及分区云20240802
└cascadeBetweenMeeting	boolean	Body	否	false	开启会间级联使能开关 true：使能 false：不使能注：需要配置平台级级联可见性	公有云及分区云20240802
└forbidInvitedCascade	boolean	Body	否	false	会间级联禁止被邀请 true：禁止 false：不禁止	公有云及分区云20240802
└enableInvitedAutoCascade	boolean	Body	否	false	收到邀请自动级联 true/false	公有云及分区云20240802
└crossCloudCallScope	String	Body	否	0	跨云呼叫范围 0：跨云通讯录用户可呼叫1：所有跨云用户禁止呼叫 2：所有跨云用户均可呼叫	公有云及分区云20240802

示例代码

请求消息体示例（Json）

{
    "meetingName": "小飞的会议室",
    "startTime": 1537874159062,
    "endTime": 1537881359062,
    "requirePassword": true,
    "password": "123456",
    "controlPassword": "123456",
    "autoMute": 0,
    "configs":{
        "autoRecord": false,
        "enableRecordCrypt": false,
        "recordFileFormat": "m3u8",
        "storageId": "2"
        ···
    }
}

返回结果示例：

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

{
    "meetingNumber": "910025205918",
    "controlPassword": "123456",
    "password": "123456",
    "shareUrl": "https://cloud.xylink.com/page/j/12KFI0G"
}

返回参数说明

参数名称	说明
meetingNumber	会议号
controlPassword	会控密码
password	密码
shareUrl	云会议室分享链接

2024-11-28 17:16:33

导出PDF文档