AddActivityRobotCommentRepository - 添加机器人评论库--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

AddActivityRobotCommentRepository - 添加机器人评论库

最近更新时间：2025.03.24 17:09:23首次发布时间：2025.03.03 14:02:25

调用 AddActivityRobotCommentRepository 接口，在指定直播间中添加机器人评论库。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的菜单管理 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1770****81234`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
RobotCommentConfig	Object of RobotCommentConfig	是	`-`	机器人评论库配置。说明直播间中存在 1 个默认评论库，您至多可以添加 4 个评论库。

RobotCommentConfig

参数	类型	是否必选	示例值	描述
IsRobotEnable	Integer	否	`1`	是否开启评论库。默认值为 `0`。取值如下： `0`：关闭 `1`：开启说明将参数值设置为 `1` 后，可调用 AddRobotComments 和 AddRobotNickNames 接口添加机器人评论和昵称，机器人会按照发送规则，随机使用添加的昵称自动发送添加的评论内容。
RobotCommentRepositoryName	String	是	`商品评论库`	机器人评论库的名称。长度为 1 到 10 个字符。
RobotSendUnit	Long	否	`30`	取值范围为 [1,999]，默认取值为 `30`。每当直播间内有 `RobotSendUnit` 参数指定的在线人数时，每分钟将自动发送 `RobotSendNum` 参数指定的评论条数，即直播间内每分钟自动发送的机器人评论总数 = 当前在线人数 ÷ `RobotSendUnit`（取整数部分） × `RobotSendNum`。例如，`RobotSendUnit` 取值为 `30`，`RobotSendNum` 取值为 `5`，当直播间内有 100 在线人数时，每分钟将自动发送 15 条评论（100 ÷ 30（取整数部分）× 5）。说明直播间内每分钟最多支持自动发送 60 条机器人评论。
RobotSendNum	Long	否	`5`	取值范围为 [1,60]，默认取值为 `5`。每当直播间内有 `RobotSendUnit` 参数指定的在线人数时，每分钟将自动发送 `RobotSendNum` 参数指定的评论条数，即直播间内每分钟自动发送的机器人评论总数 = 当前在线人数 ÷ `RobotSendUnit`（取整数部分） × `RobotSendNum`。例如，`RobotSendUnit` 取值为 `30`，`RobotSendNum` 取值为 `5`，当直播间内有 100 在线人数时，每分钟将自动发送 15 条评论（100 ÷ 30（取整数部分）× 5）。说明直播间内每分钟最多支持自动发送 60 条机器人评论。

返回参数

参数	类型	示例值	描述
RobotCommentRepositoryId	Long	`1770****81233`	机器人评论库 ID。

请求示例

POST https://livesaas.volcengineapi.com/?Action=AddActivityRobotCommentRepository&Version=2023-08-01
{
    "RobotCommentConfig": {
        "IsRobotEnable": 1,
        "RobotSendUnit": 30,
        "RobotSendNum": 5,
        "RobotCommentRepositoryName": "商品评论库"
    },
    "ActivityId": 1770****81234
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "AddActivityRobotCommentRepository",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "RobotCommentRepositoryId": 1770****81233
    }
}

错误码

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