You need to enable JavaScript to run this app.
导航
AddRobotNickNames - 添加机器人昵称
最近更新时间:2025.03.24 17:09:23首次发布时间:2024.08.21 21:25:11
我的收藏
有用
有用
无用
无用

调用 AddRobotNickNames 接口,在指定直播间内添加机器人昵称。机器人会按照发送规则,随机使用添加的昵称自动发送评论。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

ActivityId

Long

1770****81234

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

说明

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

RobotCommentRepositoryId

Long

1770****81233

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

RobotNickNames

Array of String

["机器人 A", "机器人 B"]

待添加的机器人昵称。长度为 1 到 60 个字符。

说明

一个机器人评论库内,最多可添加 200 个机器人昵称。

返回参数

参数类型示例值描述
StatusBooleantrue是否成功添加所有指定的机器人昵称。成功返回 true

请求示例

POST https://livesaas.volcengineapi.com/?Action=AddRobotNickNames&Version=2023-08-01
{
    "ActivityId": 1770****81234,
    "RobotNickNames": [
        "机器人 A",
        "机器人 B"
    ],
    "RobotCommentRepositoryId": 1770****81233
}

返回示例

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

错误码

下表提供了该接口特有的错误码,公共错误码请参见公共错误码错误码文档。

状态码错误码错误信息说明
400InvalidParameter.RobotNickNamesHitSensitiveWordsThe RobotNickNames hits sensitive words.RobotNickNames 的参数值包含敏感词。请修改后重试。
400InvalidParameter.RobotNickNamesOverLimitThe number of RobotNickNames exceeds the limit.一个机器人评论库内添加的机器人昵称超过 200 个。请删除部分机器人昵称后重试。