腾讯会议
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 腾讯会议 > 开放平台文档 > 服务端 API > REST APIs > 直播管理 > 修改直播配置

修改直播配置

最近更新时间：2023-09-14 14:18:52

我的收藏

本页目录：

通过会议 ID 修改

接口描述

描述：通过会议 ID 修改直播配置信息，企业 secret 鉴权用户（会议创建者）可修改任何该企业该用户创建的会议中的直播配置，目前暂不支持 OAuth2.0 鉴权访问。
调用方式：PUT
接口请求域名：
https://api.meeting.qq.com/v1/meetings/{meeting_id}/live_play/config

输入参数

HTTP 请求头公共参数参考签名验证章节里的 公共参数说明。
参数名称
必选
参数类型
参数描述
userid
是
String
用户 ID。
instanceid
是
integer
用户的终端设备类型：
0：PSTN
1：PC
2：Mac
3：Android
4：iOS
5：Web
6：iPad
7：Android Pad
8：小程序
9：voip、sip 设备
10：Linux
20：Rooms for Touch Windows
21：Rooms for Touch MacOS
22：Rooms for Touch Android
30：Controller for Touch Windows
32：Controller for Touch Android
33：Controller for Touch iOS
live_config
是
LiveConfig 对象
直播配置。

LiveConfig 对象

参数名称
必选
参数类型
参数描述
live_subject
否
String
直播主题。
live_summary
否
String
直播简介。
enable_live_password
否
Boolean
是否开启直播密码。
true：开启
false：不开启
live_password
否
String
直播密码，当设置开启直播密码时需要填写，如不填写则表示跟会议创建时的会议密码保持一致。
enable_live_im
否
Boolean
是否开启直播互动。
true：开启
false：不开启
enable_live_replay
否
Boolean
是否开启直播回放。
true：开启
false：不开启
live_watermark
否
LiveWatermarkInfo 对象
直播水印对象信息。

LiveWatermarkInfo 对象

参数名称
必选
参数类型
参数描述
watermark_opt
否
integer
水印选项，默认为0。
0：默认水印
1：无水印

输出参数

无输出参数，则成功返回空消息体，失败返回 错误码 和错误信息。
参数名称
必选
参数类型
参数描述
error_info
否
ErrorInfo 对象
错误信息对象（失败时返回）。

ErrorInfo 对象

参数名称
参数类型
参数描述
error_code
Integer
错误码。
message
String
错误描述。

示例

输入示例

PUT https://api.meeting.qq.com/v1/meetings/{meeting_id}/live_play/config

{
    "userid": "test_userid",
    "instanceid": 1,
    "live_config": {
        "live_subject": "test_subject",
        "live_summary": "test_summary",
        "enable_live_password": true,
        "live_password": "654321",
        "enable_live_im": true,
        "enable_live_replay": true，
     "live_watermark": {
            "watermark_opt": 0
        }
    }
}


输出示例（失败时返回）

{"error_info":{"error_code":200005,"message":"Json Schema validation failed!"}}

通过会议 Code 修改

接口描述

描述：用会议 Code 修改直播信息，企业 secret 鉴权用户（会议创建者）可修改任何该企业该用户创建的会议中的直播配置，目前暂不支持 OAuth2.0 鉴权访问。
调用方式：PUT
接口请求域名：
https://api.meeting.qq.com/v1/meetings/live_play/config

输入参数

HTTP 请求头公共参数参考签名验证章节里的 公共参数说明。
参数名称
必选
参数类型
参数描述
meeting_code
是
String
会议号码。
userid
是
String
调用 API 的用户 ID。
instanceid
是
Integer
用户的终端设备类型：
0：PSTN
1：PC
2：Mac
3：Android
4：iOS
5：Web
6：iPad
7：Android Pad
8：小程序
9：voip、sip 设备
10：linux
20：Rooms for Touch Windows
21：Rooms for Touch MacOS
22：Rooms for Touch Android
30：Controller for Touch Windows
32：Controller for Touch Android
33：Controller for Touch iOS
live_config
是
LiveConfig 对象
直播配置。

LiveConfig 对象

参数名称
必选
参数类型
参数描述
live_subject
否
String
直播主题。
live_summary
否
String
直播简介。
enable_live_password
否
Boolean
是否开启直播密码。
true：开启
false：不开启
live_password
否
String
直播密码，当设置开启直播密码时需要填写，如不填写则表示跟会议创建时的会议密码保持一致。
enable_live_im
否
Boolean
是否开启直播互动。
true：开启
false：不开启
enable_live_replay
否
Boolean
是否开启直播回放。
true：开启
false：不开启
live_watermark
否
LiveWatermarkInfo 对象
直播水印对象信息。

LiveWatermarkInfo 对象

参数名称
必选
参数类型
参数描述
watermark_opt
否
integer
水印选项，默认为0。
0：默认水印
1：无水印

输出参数

成功则返回空消息体，失败则返回 错误码 和错误信息。
参数名称
必选
参数类型
参数描述
error_info
否
ErrorInfo
错误信息对象（失败时返回）。

ErrorInfo 对象

参数名称
参数类型
参数描述
error_code
Integer
错误码。
message
String
错误描述。

示例

输入示例

PUT https://api.meeting.qq.com/v1/meetings/live_play/config

{
    "userid": "test_userid",
    "instanceid": 1,
    "meeting_code": "33291296584",
    "live_config": {
        "live_subject": "test_subject",
        "live_summary": "test_subject",
        "enable_live_password": true,
        "live_password": "654322",
        "enable_live_im": true,
        "enable_live_replay": true
    }
}

输出示例（失败时返回）

{"error_info":{"error_code":200005,"message":"Json Schema validation failed!"}}

中国站