tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateSDKLoginToken

Last updated: 2024-11-26 16:03:09

1. API Description

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

This API is used to create the SDK log-in token.

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: CreateSDKLoginToken.
Version Yes String Common Params. The value used for this API: 2020-02-10.
Region No String Common Params. This parameter is not required.
SdkAppId Yes Integer Application ID (required) can be found at https://console.tencentcloud.com/ccc.
SeatUserId Yes String Agent account.
OnlyOnce No Boolean Whether the generated token is for one-time verification?

3. Output Parameters

Parameter Name Type Description
Token String SDK log-in Token.
ExpiredTime Integer Expiry timestamp. Unix timestamp.
SdkURL String The path in which the SDK is loaded will change with its release.
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 SDK Log-in Token

This example shows you how to create SDK log-in token.

Input Example

https://ccc.intl.tencentcloudapi.com/?Action=CreateSDKLoginToken
&SdkAppId=1400000000
&SeatUserId=FooOrBar@tencent.com
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "6bb56a09-2787-40bc-80c5-dc6dab783eff",
        "Token": "6bb56a09278740bc80c5dc6dab783eff",
        "SdkURL": "https://29294-22989-29805-29810.cdn-go.cn/tccc-agent-sdk/latest/",
        "ExpiredTime": 1601371974
    }
}

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
InternalError An internal error occurs.
InternalError.DBError Internal database access failure.
InvalidParameter.InstanceNotExist The instance does not exist.
InvalidParameterValue.AccountNotExist Account does not exist.
InvalidParameterValue.InstanceNotExist The instance does not exist.
OperationDenied.UinDisabled The account has been disabled.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy