tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSupervisors

Last updated: 2024-04-01 19:34:46

    1. API Description

    Domain name for API request: lcic.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.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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy