tencent cloud

APIs

DescribeAIAnalysisRobotInfo

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:03:22

1. API Description

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

This API is used to obtain basic information of the Cloud Security AI Assistant.

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: DescribeAIAnalysisRobotInfo.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
AccessType No Integer

Access type. 0/Not imported: WeCom url configuration access. 1: WeCom QR code scan access. 2: WeChat QR code scan access. 3: QQ username and password access. 4: Lark username and password access. 5: DingTalk username and password access

AccountId No String

Create a Bot account ID for QQ, Lark, or DingTalk

Secret No String

Create a Bot key for QQ/Lark/DingTalk

BotName No String

Preset bot name. If empty, it will be generated by the backend.

3. Output Parameters

Parameter Name Type Description
URL String

Robot configuration url

AccessToken String

Access token

AesKey String

aes key

BotID String

Robot ID

QrcodeImageContext String

QR code image get address

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 1

Input Example

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

{
    "AccessType": 1,
    "AccountId": "ding****g*c*******fz",
    "Secret": "5***************************-****************************wA8BQ_V",
    "BotName": "k********t"
}

Output Example

{
    "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. 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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback