调用 AddRobotNickNames
接口,在指定直播间内添加机器人昵称。机器人会按照发送规则,随机使用添加的昵称自动发送评论。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | AddRobotNickNames | 接口名称。当前 API 的名称为 AddRobotNickNames 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ActivityId | Long | 是 |
| 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
RobotCommentRepositoryId | Long | 否 |
| 机器人评论库 ID。您可通过调用 AddActivityRobotCommentRepository 接口获取 ID。 |
RobotNickNames | Array of String | 是 |
| 待添加的机器人昵称。长度为 1 到 60 个字符。 说明 一个机器人评论库内,最多可添加 200 个机器人昵称。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Status | Boolean | true | 是否成功添加所有指定的机器人昵称。成功返回 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 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.RobotNickNamesHitSensitiveWords | The RobotNickNames hits sensitive words. | RobotNickNames 的参数值包含敏感词。请修改后重试。 |
400 | InvalidParameter.RobotNickNamesOverLimit | The number of RobotNickNames exceeds the limit. | 一个机器人评论库内添加的机器人昵称超过 200 个。请删除部分机器人昵称后重试。 |