You need to enable JavaScript to run this app.
导航
更新机器人评论配置
最近更新时间:2024.08.22 00:45:16首次发布时间:2024.08.21 21:25:11

您可通过此接口更新指定直播间的机器人评论配置,包括是否开启机器人评论功能以及机器人评论的发送规则。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong1770637081234直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
RobotCommentConfigObject of RobotCommentConfig-机器人评论配置。

RobotCommentConfig

参数类型是否必选示例值描述

IsRobotEnable

Integer

1

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

  • 0:关闭
  • 1:开启

说明

将参数值设置为 1 后,可调用 AddRobotCommentsAddRobotNickNames 接口添加机器人评论和昵称,机器人会按照发送规则,随机使用添加的昵称自动发送添加的评论内容。

RobotSendUnit

Long

30

直播间内每有 RobotSendUnit 参数指定的在线人数,每分钟将自动发送 RobotSendNum 参数指定的评论条数。
参数值必须为正整数。

RobotSendNum

Long

5

直播间内每有 RobotSendUnit 参数指定的在线人数,每分钟将自动发送 RobotSendNum 参数指定的评论条数。
参数值必须为正整数。

说明

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

返回参数

参数类型示例值描述
StatusBooleantrue机器人评论配置是否更新成功。成功返回 true

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityRobotCommentConfig&Version=2023-08-01
{
    "ActivityId": 1770637081234,
    "RobotCommentConfig": {
        "IsRobotEnable": 1,
        "RobotSendUnit": 30,
        "RobotSendNum": 5
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateActivityRobotCommentConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1721116418
    },
    "Result": {
        "Status": true
    }
}

错误码

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