选择应用类型
企业内部应用开发

修改直播属性信息新版SDK

更新于 2024-12-30

接口调用量说明使用当前 API 接口会消耗每月计量 API 调用额度,请登录开发者后台-资源管理查看企业所有的用量权益。如您已经收到用量预警,或调用额度无法满足使用,您可以购买应用开发增购包(独立购)提升当月调用总额度。
调用本接口,修改直播属性信息。

例如,小钉创建了一个直播,直播标题为测试直播,如下图所示。

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

权限

要调用此API,需要以下权限之一。

应用类型

是否支持

权限

API Explorer调试

企业内部应用支持钉钉直播获取数据写权限API Explorer
第三方企业应用支持钉钉直播获取数据写权限API Explorer
第三方个人应用暂不支持钉钉直播获取数据写权限暂不支持

请求方法

Loading...

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证。

Body参数

名称

类型

是否必填

描述

liveId

String

直播ID。

  • 企业内部应用,调用创建直播接口获取liveId参数值。

  • 第三方企业应用,调用创建直播接口获取liveId参数值。

unionId

String

主播的unionId。

title

String

直播标题。

introduction

String

直播简介。

coverUrl

String

直播的封面地址。

preStartTime

Long

直播的预计开播时间戳,单位毫秒。

preEndTime

Long

直播的预计结束时间戳,单位毫秒。

返回参数

名称

类型

描述

result

Object

返回结果。

success

Boolean

操作是否成功。

  • true:成功

  • false:失败

示例

请求示例

Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

返回示例

Loading...

错误码

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

系统服务错误

点击纠错