tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeGroupList

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

    1. API Description

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

    This API is used to query groups.
    A maximum of 20 requests can be initiated per second for this API.

    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: DescribeGroupList.
    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.
    Page No Integer The page to return records from. Pagination starts from 1.
    Limit No Integer The maximum number of records per page. The value of this parameter cannot exceed 1000 and is 20 by default.
    TeacherId No String The user ID of the teacher, which is used as the filter. This parameter and MemberId are mutually exclusive. If both are specified, only this parameter will take effect.
    MemberId No String The user ID of a member, which is used as the filter. This parameter and TeacherId are mutually exclusive.

    3. Output Parameters

    Parameter Name Type Description
    Total Integer The total number of groups that meet the conditions.
    GroupInfos Array of GroupInfo
    Note: This field may return null, indicating that no valid values can be obtained.
    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 示例1

    TeacherId和MemberId都不填的返回结果

    Input Example

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

{
    "SdkAppId": 3618809
}

    Output Example

    {
    "Response": {
        "GroupInfos": [
            {
                "GroupId": "cfmsqfu2r378uak93i70",
                "GroupName": "修改测试群组名称",
                "GroupType": 0,
                "SubGroupIds": null,
                "TeacherId": "2LoDvr6M9TvI4x4dMFBpGRzxZXr"
            },
            {
                "GroupId": "cfmst8u2r378uak93i90",
                "GroupName": "批量创建群组1",
                "GroupType": 0,
                "SubGroupIds": null,
                "TeacherId": ""
            },
            {
                "GroupId": "cfmst8u2r378uak93i9g",
                "GroupName": "批量创建群组2",
                "GroupType": 0,
                "SubGroupIds": null,
                "TeacherId": ""
            },
            {
                "GroupId": "cfmthke2r378uak93ii0",
                "GroupName": "测试修改群组",
                "GroupType": 0,
                "SubGroupIds": null,
                "TeacherId": "2LoDvr6M9TvI4x4dMFBpGRzxZXr"
            },
            {
                "GroupId": "cjdipop7qk6r714q0fh0",
                "GroupName": "lukatest",
                "GroupType": 0,
                "SubGroupIds": null,
                "TeacherId": ""
            }
        ],
        "RequestId": "5b261337-70dc-49a9-92cb-820641958626",
        "Total": 5
    }
}

    Example2 示例2

    查询TeacherId的结果

    Input Example

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

{
    "SdkAppId": 3618809,
    "TeacherId": "2LoDvr6M9TvI4x4dMFBpGRzxZXr"
}

    Output Example

    {
    "Response": {
        "GroupInfos": [
            {
                "GroupId": "cfmsqfu2r378uak93i70",
                "GroupName": "修改测试群组名称",
                "GroupType": 0,
                "SubGroupIds": null,
                "TeacherId": "2LoDvr6M9TvI4x4dMFBpGRzxZXr"
            },
            {
                "GroupId": "cfmthke2r378uak93ii0",
                "GroupName": "测试修改群组",
                "GroupType": 0,
                "SubGroupIds": null,
                "TeacherId": "2LoDvr6M9TvI4x4dMFBpGRzxZXr"
            }
        ],
        "RequestId": "a69c412e-1da6-4d27-bd37-c74a2703f94a",
        "Total": 2
    }
}

    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 CAM signature/authentication error.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameter.GroupMemberOverLimit The number of users in the group reached the limit.
    InvalidParameter.GroupTypeInvalid Group type error.
    InvalidParameter.SdkAppId SdkAppId is incorrect.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter.
    RequestLimitExceeded Too many requests.
    ResourceNotFound.GroupNotExist The group does not exist.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy