调用 AddInteractionScriptComments 接口,新增一条或多条互动脚本评论。在绑定互动脚本的视频作为录播直播播放到指定时间节点时,会按照互动脚本配置的用户身份和昵称,发送预设的评论内容。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | AddInteractionScriptComments | 接口名称。当前 API 的名称为 AddInteractionScriptComments。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
InteractionScriptId | Integer | 是 |
| 互动脚本 ID。获取方式:
|
| Comments | Array of Comments | 是 | - | 评论配置信息。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| SendTime | Integer | 是 | 10 | 评论的发送时间。单位为秒。例如参数取值为 10,则该条评论会在视频开始播放 10 秒后发送。 |
Role | Integer | 是 |
| 发送评论的用户身份。取值如下:
|
Nickname | String | 是 |
| 用户昵称。长度为 1 到 20 个字符。 说明 当 |
| Content | String | 是 | 你好 | 评论内容。长度为 1 到 200 个字符。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| SuccessAmount | Integer | 1 | 新增成功的评论数量。 |
| LatestCommentId | Long | 1 | 最后一条新增成功的评论 ID。 |
| FailList | Array of FailList | - | 新增失败的评论列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Index | Integer | 0 | 新增失败的评论在请求中的下标,从 0 开始计数。例如参数值为 0,则表示请求中传入的第 1 个评论新增失败。 |
FailType | Integer |
| 失败类型。取值如下:
|
POST https://livesaas.volcengineapi.com/?Action=AddInteractionScriptComments&Version=2023-08-01 { "Comments": [ { "SendTime": 10, "Role": 1, "Nickname": "观众 A", "Content": "你好" }, { "SendTime": 20, "Role": 1, "Nickname": "观众 B", "Content": "你好" } ], "InteractionScriptId": 1 }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "AddInteractionScriptComments", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "SuccessAmount": 1, "FailList": [ { "Index": 0, "FailType": 1 } ], "LatestCommentId": 1 } }