将媒资库中的视频和互动脚本关联到指定直播间。关联后,媒资库中的视频和脚本将作为该直播间的回放视频和绑定的脚本播放。
说明
每次仅允许将一个视频文件或一个互动脚本关联到指定直播间。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UploadReplayAPI | 接口名称。当前 API 的名称为 UploadReplayAPI。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| Media | Object of Media | 是 | - | 媒资库中视频和脚本列表。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Vid | String | 是 |
| 媒资库中视频的 Vid。您可以通过 ListActivityMediaAPI 接口查询 Vid。 说明 使用子账号调用接口时,确保视频对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| InteractionScript | Object of InteractionScript | 否 | - | 互动脚本评论配置。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ScriptId | Long | 是 |
| 媒资库中的互动脚本 ID。您可以通过 ListActivityMediaAPI 接口查询互动脚本 ID。 注意 使用子账号调用该接口时,请确保该互动脚本绑定的媒资库视频对子账号可见;否则,该脚本 ID 将被忽略,且接口不会返回错误。有关如何配置子账号的可见范围,详见子账号管理。 |
| CommentOffset | Integer | 否 | 5 | 从视频的第 N 秒开始导入互动脚本中的评论内容,并根据该偏移量自动调整每条评论的时间戳。默认值为 0,表示不进行时间偏移。 |
本接口无特有的返回参数。
POST https://livesaas.volcengineapi.com/?Action=UploadReplayAPI&Version=2020-06-01 { "ActivityId": 178465844575, "Media": { "Vid": "id123", "InteractionScript": { "ScriptId": 1, "CommentOffset": 5 } } }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "UploadReplayAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1656067132 } }