tencent cloud

实时互动-教育版

动态与公告
低代码互动课堂产品更名公告
关于低代码互动课堂升级的公告
产品简介
产品概述
应用场景
产品功能
产品优势
购买指南
计费概述
包月套餐说明
计费示例
购买指引
欠费停服资源回收说明
退费说明
Demo 下载及体验
客户端集成指引
Web 和 H5
Android
iOS
Windows 和 macOS
控制台指南
概览
用量统计
应用管理
快速跑通
API 文档
History
Introduction
API Category
Making API Requests
User Login APIs
Room Management APIs
Group Management APIs
Application Configuration APIs
Recording Management APIs
Courseware Management APIs
User Management APIs
Developer APIs
Data Types
Error Codes
界面定制
快速开始
事件监听
监听服务端事件回调
高级功能
自定义业务域名
移动端屏幕分享
移动端预加载
实践教程
排课系统集成
账户体系集成
录制回放集成
课件模块集成
LCIC 政策
隐私政策
数据处理和安全协议
常见问题
计费相关问题
录制相关问题
控制台与 API 授权问题
互动白板涂鸦不跟手问题
屏幕共享相关问题
应对防火墙限制相关问题
集成相关问题(Web)
Electron 相关问题
设备性能要求问题
相关协议
Service Level Agreement

DescribeSupervisors

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 21:46:58

1. API Description

Domain name for API request: lcic.intl.tencentcloudapi.com.

This API is used to get the spectators of a room.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeSupervisors.
Version Yes String Common Params. The value used for this API: 2022-08-17.
Region No String Common Params. This parameter is not required.
SdkAppId Yes Integer The SDKAppID assigned by LCIC.
Limit No Integer The maximum number of records per page. The maximum value allowed is 100, and the default value is 20.
Page No Integer The page to return records from. Pagination starts from 1, which is also the default value of this parameter.

3. Output Parameters

Parameter Name Type Description
Total Integer The total number of spectators.
Page Integer The current page number.
Limit Integer The number of records on the current page.
UserIds Array of String A list of the spectators.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Getting the spectators of a room

This example shows you how to get the spectators of a room.

Input Example

POST / HTTP/1.1
Host: lcic.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSupervisors
<Common request parameters>

{
    "SdkAppId": 1,
    "Limit": 1,
    "Page": 1
}

Output Example

{
    "Response": {
        "Total": 1,
        "Page": 1,
        "Limit": 1,
        "UserIds": [
            "abc"
        ],
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.RequestTimedOut Request timed out.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameter.SdkAppId SdkAppId is incorrect.
InvalidParameterValue Invalid parameter value.
MissingParameter Missing parameter.
ResourceNotFound The resource doesn’t exist.
UnknownParameter Unknown parameter error.
UnsupportedOperation Unsupported operation.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈