tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

BatchCreateGroupWithMembers

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

    1. API Description

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

    This API is used to create multiple groups at a time.
    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: BatchCreateGroupWithMembers.
    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.
    GroupBaseInfos.N Yes Array of GroupBaseInfo The information of the groups to create. Array length limit: 256.
    MemberIds.N No Array of String The group members. Array length limit: 200.

    3. Output Parameters

    Parameter Name Type Description
    GroupIds Array of String The IDs of the groups created, which are in the same order as the elements in the request parameter GroupBaseInfos.N.
    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 multiple groups

    This example shows you how to create multiple groups.

    Input Example

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

{
    "SdkAppId": 12345678,
    "GroupBaseInfos": [
        {
            "GroupName": "test1",
            "TeacherId": "abc"
        },
        {
            "GroupName": "test2"
        }
    ],
    "MemberIds": [
        "abc",
        "bcd"
    ]
}

    Output Example

    {
    "Response": {
        "GroupIds": [
            "2CvDgjRNjylAsBZB4iZc0F6koXe",
            "abcddredrtertet"
        ],
        "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.
    DryRunOperation The request would have succeeded, but the DryRun parameter was used.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameter.Content Prohibited content (pornographic, terrorist, politically sensitive) detected.
    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.
    ResourceUnavailable The resource is unavailable.
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy