You need to enable JavaScript to run this app.
导航
GetActivityRobotCommentConfig - 获取机器人评论库配置
最近更新时间:2025.03.24 17:09:23首次发布时间:2024.08.21 21:25:11
我的收藏
有用
有用
无用
无用

调用 GetActivityRobotCommentConfig 接口,获取指定直播间内指定机器人评论库的配置,包括是否开启机器人评论库以及机器人评论的发送规则。

注意事项

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

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=GetActivityRobotCommentConfig&Version=2023-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetActivityRobotCommentConfig接口名称。当前 API 的名称为 GetActivityRobotCommentConfig
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

ActivityId

Long

1770****81234

直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

说明

使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

RobotCommentRepositoryId

Long

1770****81233

机器人评论库 ID。您可通过调用 AddActivityRobotCommentRepository 接口获取 ID。
默认值为 0,即默认评论库。

返回参数

参数类型示例值描述
RobotCommentConfigObject of RobotCommentConfig-机器人评论库配置。

RobotCommentConfig

参数类型示例值描述
RobotCommentRepositoryIdLong1770****81233机器人评论库 ID。
RobotCommentRepositoryNameString商品评论库机器人评论库的名称。

IsRobotEnable

Integer

1

是否开启机器人评论库。取值如下:

  • 0:关闭
  • 1:开启

RobotSendUnit

Long

30

每当直播间内有 RobotSendUnit 参数指定的在线人数时,每分钟将自动发送 RobotSendNum 参数指定的评论条数,即直播间内每分钟自动发送的机器人评论总数 = 当前在线人数 ÷ RobotSendUnit(取整数部分) × RobotSendNum
例如,RobotSendUnit 取值为 30RobotSendNum 取值为 5,当直播间内有 100 在线人数时,每分钟将自动发送 15 条评论(100 ÷ 30(取整数部分)× 5)。

说明

直播间内每分钟最多支持自动发送 60 条机器人评论。

RobotSendNum

Long

5

每当直播间内有 RobotSendUnit 参数指定的在线人数时,每分钟将自动发送 RobotSendNum 参数指定的评论条数,即直播间内每分钟自动发送的机器人评论总数 = 当前在线人数 ÷ RobotSendUnit(取整数部分) × RobotSendNum
例如,RobotSendUnit 取值为 30RobotSendNum 取值为 5,当直播间内有 100 在线人数时,每分钟将自动发送 15 条评论(100 ÷ 30(取整数部分)× 5)。

说明

直播间内每分钟最多支持自动发送 60 条机器人评论。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityRobotCommentConfig&Version=2023-08-01&ActivityId=1770****81234&RobotCommentRepositoryId=1770****81233

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetActivityRobotCommentConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "RobotCommentConfig": {
            "IsRobotEnable": 1,
            "RobotSendUnit": 30,
            "RobotSendNum": 5,
            "RobotCommentRepositoryId": 1770****81233,
            "RobotCommentRepositoryName": "商品评论库"
        }
    }
}

错误码

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