获取机器人昵称列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取机器人昵称列表

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

您可通过此接口获取指定直播间内添加的机器人昵称列表。获取到机器人昵称 ID 后，您可调用 DeleteRobotNickNames 接口删除指定机器人昵称。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListRobotNickNames`	接口名称。当前 API 的名称为 `ListRobotNickNames`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`1770637081234`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
NameContent	String	否	`机器人 A`	机器人昵称。长度为 1 到 60 个字符。支持模糊搜索。
PageNumber	Integer	否	`1`	分页查询页码。默认值为 `1`。说明最多支持返回 200 条查询结果，即 `PageNumber`×`PageSize`≤ 200。
PageSize	Integer	否	`10`	分页查询数量。默认值为 `10`。说明最多支持返回 200 条查询结果，即 `PageNumber`×`PageSize`≤ 200。

返回参数

参数	类型	示例值	描述
PageNumber	Integer	`1`	分页查询页码。
PageSize	Integer	`10`	分页查询数量。
TotalItemCount	Integer	`1`	查询结果总数。
RobotNickNames	Array of RobotNickNames	`-`	机器人昵称列表。

RobotNickNames

参数	类型	示例值	描述
Id	Long	`444833`	机器人昵称 ID。
NikeName	String	`机器人 A`	机器人昵称。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListRobotNickNames&Version=2023-08-01&ActivityId=1770637081234&NameContent=机器人 A&PageNumber=1&PageSize=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListRobotNickNames",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1721119228
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalItemCount": 1,
        "RobotNickNames": {
            "Id": 444833,
            "NikeName": "机器人 A"
        }
    }
}

错误码

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