添加机器人昵称--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

添加机器人昵称

最近更新时间：2024.08.21 21:25:11首次发布时间：2024.08.21 21:25:11

您可通过此接口在指定直播间内添加机器人昵称。机器人会按照发送规则，随机使用添加的昵称自动发送评论。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1770637081234`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
RobotNickNames	Array of String	是	`["机器人 A", "机器人 B"]`	待添加的机器人昵称。长度为 1 到 60 个字符。说明直播间内最多可添加 200 个机器人昵称。

返回参数

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

请求示例

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

返回示例

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

错误码

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

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