tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

RegisterUser

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

    1. API Description

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

    This API is used to register a user.

    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: RegisterUser.
    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 LCIC SdkAppId
    Name No String Username
    OriginId No String User's ID in the customer system, which should be unique under the same application
    Avatar No String User's profile photo

    3. Output Parameters

    Parameter Name Type Description
    UserId String User ID
    Token String Login status token returned after successful login or registration. The token is valid for seven days.
    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 a user.

    Input Example

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

{
    "SdkAppId": 1234657
}

    Output Example

    {
    "Response": {
        "UserId": "2CvDgjRNjylAsBZB4iZc0F6koXe",
        "Token": "3o32r0j134m13aa0uva0jvj90qj4j004198",
        "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
    FailedOperation Operation failed.
    FailedOperation.OriginIdExists The user origin ID already exists.
    InternalError Internal error.
    InvalidParameter.SdkAppId SdkAppId is incorrect.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy