tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateGroupWithMembers

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

    1. API Description

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

    his API is used to create a group and specify its members.
    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: CreateGroupWithMembers.
    Version Yes String Common Params. The value used for this API: 2022-08-17.
    Region No String Common Params. This parameter is not required.
    GroupName Yes String The group name.
    SdkAppId Yes Integer The SDKAppID assigned by LCIC.
    TeacherId No String The user ID of the teacher.
    MemberIds.N No Array of String The group members. Array length limit: 200.

    3. Output Parameters

    Parameter Name Type Description
    GroupId String The ID of the successfully created group.
    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 Creating a group

    This example shows you how to create a group and specify its members.

    Input Example

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

{
    "GroupName": "test",
    "SdkAppId": 12345678,
    "MemberIds": [
        "abc",
        "bcd"
    ]
}

    Output Example

    {
    "Response": {
        "GroupId": "2CvDgjRNjylAsBZB4iZc0F6koXe",
        "RequestId": "213das"
    }
}

    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.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameter.GroupMemberOverLimit The number of users in the group reached the limit.
    InvalidParameter.GroupParamInvalid Parameter error. The teacher and group members are not specified.
    InvalidParameter.GroupTeacherNotMember The teacher cannot be a group member.
    InvalidParameter.GroupTeachersNotExist The teacher does not exist.
    InvalidParameter.GroupTypeInvalid Group type error.
    InvalidParameter.SdkAppId SdkAppId is incorrect.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter.
    RequestLimitExceeded Too many requests.
    ResourceNotFound.GroupPartUsersNotExist The user ID does not exist.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy