修改直播属性信息新版SDK
更新于 2024-12-30
例如,小钉创建了一个直播,直播标题为测试直播,如下图所示。

调用本接口,根据直播ID,修改直播的属性信息。修改标题测试直播为测试直播1,修改直播封面等信息。接口调用成功后,效果如下图所示。

权限
要调用此API,需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 支持 | 钉钉直播获取数据写权限 | API Explorer |
第三方企业应用 | 支持 | 钉钉直播获取数据写权限 | API Explorer |
第三方个人应用 | 暂不支持 | 钉钉直播获取数据写权限 | 暂不支持 |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证。
|
Body参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
liveId | String | 是 | 直播ID。 |
unionId | String | 是 | 主播的unionId。 |
title | String | 否 | 直播标题。 |
introduction | String | 否 | 直播简介。 |
coverUrl | String | 否 | 直播的封面地址。 |
preStartTime | Long | 否 | 直播的预计开播时间戳,单位毫秒。 |
preEndTime | Long | 否 | 直播的预计结束时间戳,单位毫秒。 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
result | Object | 返回结果。 |
success | Boolean | 操作是否成功。
|
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | invalidParam | lippi_live.stream.paramError | 参数错误 |
400 | contentNotCompliant | lippi_live.validate.contentNotCompliant | 内容不合规 |
400 | liveNotExist | this live not exist, please check liveId | 直播不存在,请检查直播ID |
400 | liveStatusNotMatch | this live status is not match, only forecast can update | 直播状态检查失败,预告态直播才允许修改 |
404 | noPermission | lippi_live.stream.noPermission | 鉴权失败 |
500 | serviceError | systemError | 系统服务错误 |