tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeUserStatus

Last updated: 2023-12-07 10:46:32

    1. API Description

    Domain name for API request: tiw.tencentcloudapi.com.

    This API is used to query the Tencent Interactive Whiteboard service status of a user, including the activation status and validity period.

    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: DescribeUserStatus.
    Version Yes String Common Params. The value used for this API: 2019-09-19.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.

    3. Output Parameters

    Parameter Name Type Description
    AppId Integer AppId of the customer.
    IsTiwUser Integer Specifies whether the whiteboard service of the trial or official edition is activated before.

    0: The whiteboard service is not activated.
    1: The whiteboard service is activated.
    IsSaaSUser Integer Specifies whether the interactive class feature of the trial or official edition is activated before.
    IsTiwOfflineRecordUser Integer Specifies whether the user uses the offline recording feature of the whiteboard service.
    IsAuthenticated Integer Specifies whether the user is authenticated.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the Tencent Interactive Whiteboard service status of a user

    Input Example

    https://tiw.tencentcloudapi.com/?Action=DescribeUserStatus
&<Common request parameters>

    Output Example

    {
    "Response": {
        "AppId": 1250000060,
        "IsTiwUser": 1,
        "IsSaaSUser": 1,
        "IsTiwOfflineRecordUser": 1,
        "IsAuthenticated": 1,
        "RequestId": "9f5a59d6-2b77-41b2-a945-78084577e225"
    }
}

    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
    AuthFailure
    FailedOperation.AlreadyEnabled Service already activated.
    InvalidParameter A parameter error occurred.
    InvalidParameter.UnmarshalJSONBodyFail JSON parsing failed, which may be due to parameter type mismatch.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy