Domain name for API request: adp.intl.tencentcloudapi.com.
Get session list.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeConversationList. |
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Type | Yes | Integer | Session type. Pass CONVERSATION_TYPE_UNSPECIFIED to indicate all. Enumeration values: 0-CONVERSATION_TYPE_UNSPECIFIED (not specified; means all in list query), 1-CONVERSATION_TYPE_VISITOR (visitor trial), 2-CONVERSATION_TYPE_EVALUATION (evaluation), 5-CONVERSATION_TYPE_API (API integration), 10-CONVERSATION_TYPE_WORKFLOW (workflow debugging), 20-CONVERSATION_TYPE_SHARE (share a link) |
| AppId | No | String | App ID |
| AppKey | No | String | Required when Type=CONVERSATION_TYPE_API. Application key |
| Keyword | No | String | Keyword |
| Limit | No | Integer | Number limit (integer), used in conjunction with Offset |
| LoginSubAccountUin | No | String | Sub-account Uin |
| LoginUin | No | String | Root account Uin |
| Offset | No | Integer | Offset (integer), used in conjunction with Limit, starts from 0 |
| ShareCode | No | String | Required when Type=CONVERSATION_TYPE_SHARE. Share code |
| UserId | No | String | Required when Type=CONVERSATION_TYPE_API. Visitor ID |
| AgentId | No | String | Client-side AgentId, used when querying sessions created based on the client-side AgentId |
| Parameter Name | Type | Description |
|---|---|---|
| ConversationList | Array of Conversation | Session list |
| Conversations | Array of Conversation | Session list |
| TotalCount | String | Total. |
| 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. |
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConversationList
<Common request parameters>
{
"Type": 2,
"AppId": "2056226819910862592"
}{
"Response": {
"ConversationList": [
{
"AppId": "2056226819910862592",
"ConversationId": "1038a37e-93b6-4f1f-b4cc-a73ce87a1c39",
"CreateTime": "2026-05-18T21:58:38+08:00",
"Type": 2,
"UpdateTime": "2026-05-19T16:12:32+08:00"
}
],
"TotalCount": "4",
"RequestId": "9b13a60e-39cc-4390-8a09-f6741b2c73f1"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
フィードバック