新增互动脚本评论--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

新增互动脚本评论

最近更新时间：2025.01.22 10:45:53首次发布时间：2025.01.22 10:45:53

调用 AddInteractionScriptComments 接口，新增一条或多条互动脚本评论。在绑定互动脚本的视频作为伪直播播放到指定时间节点时，会按照互动脚本配置的用户身份和昵称，发送预设的评论内容。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
使用限制：单次接口调用最多支持新增 1000 条评论。在一个互动脚本中，每秒最多支持添加 10 条评论。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=AddInteractionScriptComments&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`AddInteractionScriptComments`	接口名称。当前 API 的名称为 `AddInteractionScriptComments`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
InteractionScriptId	Integer	是	`1`	互动脚本 ID。您可通过调用 ListActivityMediaAPI 接口获取绑定视频库或直播暂存视频的互动脚本 ID、调用 ListLoopVideos 接口获取绑定伪直播视频的互动脚本 ID、调用 CreateInteractionScript 接口创建空白互动脚本并获取互动脚本 ID。
Comments	Array of Comments	是	`-`	评论配置信息。

Comments

参数	类型	是否必选	示例值	描述
SendTime	Integer	是	`10`	评论的发送时间。单位为秒。例如参数取值为 `10`，则该条评论会在视频开始播放 10 秒后发送。
Role	Integer	是	`1`	发送评论的用户身份。取值如下： `1`：观众 `2`：主持人 `3`：助教
Nickname	String	是	`观众 A`	用户昵称。长度为 1 到 20 个字符。说明当 `Role` 取值为 `2` 时，字符长度无限制，但建议不传该参数，从而确保发送评论的主持人昵称与直播间的主持人昵称一致。
Content	String	是	`你好`	评论内容。长度为 1 到 200 个字符。

返回参数

参数	类型	示例值	描述
SuccessAmount	Integer	`1`	新增成功的评论数量。
LatestCommentId	Long	`1`	最后一条新增成功的评论 ID。
FailList	Array of FailList	`-`	新增失败的评论列表。

FailList

参数类型示例值描述

Index Integer 0 新增失败的评论在请求中的下标，从 0 开始计数。例如参数值为 0，则表示请求中传入的第 1 个评论新增失败。

参数	类型	示例值	描述
Index	Integer	`0`	新增失败的评论在请求中的下标，从 0 开始计数。例如参数值为 `0`，则表示请求中传入的第 1 个评论新增失败。
FailType	Integer	`1`	失败类型。取值如下： `1`：1 秒内的评论总数超出 10 条 `2`：用户昵称或评论内容的字符长度超出上限

FailType

Integer

1

失败类型。取值如下：

1：1 秒内的评论总数超出 10 条
2：用户昵称或评论内容的字符长度超出上限

请求示例

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
    }
}

错误码

访问公共错误码和错误码获取详细信息。