GetWsToken

Last updated: 2025-10-30 21:48:58

GetWsToken

Last updated: 2025-10-30 21:48:58

1. API Description

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

This API is used to get ws token.

A maximum of 100 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: GetWsToken.
Version	Yes	String	Common Params. The value used for this API: 2023-11-30.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-jakarta.
Type	Yes	Integer	Access type, 5 - API visitor .
BotAppKey	No	String	Application AppKey How to Obtain It: 1. After the application is released, obtain it at [Release Management] - [Call Information] - [API Management] on the application page. 2. See the second item in https://www.tencentcloud.com/document/product/1759/109469?from_cn_redirect=1.
VisitorBizId	No	String	Visitor ID (external input, recommended to be unique, identifies the user currently accessing the session). Length Limit: string(64).
VisitorLabels.N	No	Array of GetWsTokenReq_Label	Knowledge label, used for search filter in the knowledge base. This field is about to be deactivated. Please use the custom_variables field in the dialogue endpoint API to replace this field.

3. Output Parameters

Parameter Name	Type	Description
Token	String	Token value (valid for 60 seconds, valid only once, multiple validations will report an error).
Balance	Float	Balance. The balance is valid if it is greater than 0.
InputLenLimit	Integer	The character limit for input in the chat window.
Pattern	String	Application mode: standard; agent; single_workflow.
SingleWorkflow	KnowledgeQaSingleWorkflow	SingleWorkflow.
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 Get WS Token

Get WS Token.

Input Example

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

{
    "Type": 5,
    "BotAppKey": "abcdefg",
    "VisitorLabels": []
}

Output Example

{
    "Response": {
        "RequestId": "3fa293a5-****-****-8c0b-95252cfef12f",
        "Token": "0457ad8d-****-****-9f2f-81863f4b0182"
    }
}

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
FailedOperation	Operation failed.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud