BatchRegister

最終更新日:2025-10-30 21:46:42

BatchRegister

最終更新日: 2025-10-30 21:46:42

1. API Description

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

This API is used to register multiple users (up to 1,000) at a time. If a user ID already exists, the existing one will be overwritten.
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: BatchRegister.
Version	Yes	String	Common Params. The value used for this API: 2022-08-17.
Region	No	String	Common Params. This parameter is not required.
Users.N	Yes	Array of BatchUserRequest	The information of the users to register.

3. Output Parameters

Parameter Name	Type	Description
Users	Array of BatchUserInfo	The information of the successfully registered users. 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 Registering multiple users

This API shows you how to register multiple users at a time.

Input Example

{
  "Users": [
    {
      "SdkAppId": 1,
      "Name": "xx",
      "OriginId": "xx",
      "Avatar": "xx"
    }
  ]
}

Output Example

{
    "Response": {
        "Users": [
            {
                "SdkAppId": 1,
                "UserId": "xx",
                "OriginId": "xx"
            }
        ],
        "RequestId": "xx"
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameter.SdkAppId	`SdkAppId` is incorrect.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Missing parameter.
UnauthorizedOperation	Unauthorized operation.

この記事はお役に立ちましたか？

営業担当者にお問い合わせいただくかチケットを提出してサポートを求めることができます。

はい

いいえ

フィードバック

tencent cloud