1. 接口描述
接口请求域名： lke.tencentcloudapi.com 。
获取ws token
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetWsToken。 |
| Version | 是 | String | 公共参数，本接口取值：2023-11-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Type | 是 | Integer | 接入类型，当前请填写5 示例值：1: 坐席 2: 访客 3: 体验 5: API 访客 |
| BotAppKey | 否 | String | 当Type=5时，必填；应用AppKey（应用发布后在应用页面[发布管理]-[调用信息]-[API管理]处获取） |
| VisitorBizId | 否 | String | 访客ID（外部输入，建议唯一，标识当前接入会话的用户） |
| VisitorLabels.N | 否 | Array of GetWsTokenReq_Label | 知识标签，用于知识库中知识的检索过滤。该字段即将下线，请使用对话端接口中的 custom_variables 字段替代该字段。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Token | String | token值（有效期60s，仅一次有效，多次校验会报错） |
| Balance | Float | 余额; 余额大于 0 时表示有效 注意：此字段可能返回 null，表示取不到有效值。 |
| InputLenLimit | Integer | 对话窗输入字符限制 |
| Pattern | String | 应用模式，standard:标准模式, agent: agent模式，single_workflow：单工作流模式 示例值：standard |
| SingleWorkflow | KnowledgeQaSingleWorkflow | SingleWorkflow |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取 WS Token
获取 WS Token
输入示例
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetWsToken
<公共请求参数>
{
"Type": 5,
"BotAppKey": "abcdefg",
"VisitorLabels": []
}输出示例
{
"Response": {
"RequestId": "3fa293a5-****-****-8c0b-95252cfef12f",
"Token": "0457ad8d-****-****-9f2f-81863f4b0182"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
