1. 接口描述
接口请求域名： csip.tencentcloudapi.com 。
获取云安全AI助手基础信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAIAnalysisRobotInfo。 |
| Version | 是 | String | 公共参数，本接口取值：2022-11-21。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| AccessType | 否 | Integer | 接入类型，0/不传入：企业微信url配置接入 1:企业微信扫码接入 2:微信扫码接入 3:QQ 账密接入 4:飞书 账密接入 5:钉钉 账密接入 示例值：1 |
| AccountId | 否 | String | QQ/飞书/钉钉 创建Bot账号ID 示例值：dinggc**fz |
| Secret | 否 | String | QQ/飞书/钉钉 创建Bot密钥 示例值：5***-****wA8BQ_V |
| BotName | 否 | String | 预设机器人名称，为空时则后台生成 示例值：k****t |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| URL | String | 机器人配置url 示例值：https://up.yd.qcloud.com/ai-test/14***1**************cdc-89c651a95872 |
| AccessToken | String | 访问token 示例值：8ZdlPzuo*2sFSMnmqBjy |
| AesKey | String | aes key 示例值：57HdBdt***TZ7rETqBFVqRhA3q2 |
| BotID | String | 机器人ID 示例值：286c6*1-a3f390956939 |
| QrcodeImageContext | String | 二维码图片获取地址 示例值：https://wo******xin.qq.com/ai/qc/c?s******************hide_******tn**rue&for_native=true |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 1
输入示例
POST / HTTP/1.1
Host: csip.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAIAnalysisRobotInfo
<公共请求参数>
{
"AccessType": 1,
"AccountId": "ding****g*c*******fz",
"Secret": "5***************************-****************************wA8BQ_V",
"BotName": "k********t"
}输出示例
{
"Response": {
"AccessToken": "8ZdlPzuo*************2sFSMnmqBjy",
"AesKey": "57HdBdt*******************TZ7rETqBFVqRhA3q2",
"BotID": "286c6*****************1-a3f390956939",
"QrcodeImageContext": "https://wo******xin.qq.com/ai/qc/c?s******************hide_******tn**rue&for_native=true",
"URL": "https://up.yd.qcloud.com/ai-test/14***1**************cdc-89c651a95872",
"RequestId": "b3ed6bfc-ee28-4266-8d91-d0b60b4fc726"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
