tencent cloud

APIs

DescribeMsgRecordList

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-11-05 11:20:14

1. API Description

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

This API is used to query the dialogue message record list of an application. It supports filtering by channel type, feedback type, intent, call result, and other conditions, and supports cursor pagination and sorting by creation time.

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: DescribeMsgRecordList.
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.
AppId Yes String

Application ID

FilterList.N No Array of Filter
  • ChannelType : 0-all 2-experience page (Tencent Cloud) 3-web debugging page (Tencent Cloud) 4-experience page (phone number) 5-dialogue API connection 6-application evaluation 7-debug API 10000-WeChat service account 10001-WeChat Subscription Account 10002-WeCom app 10004-WeChat Customer Service 10005-WeChat mini program 10006-Tencent Yuanqi 10007-App Treasure 10009-WeCom intelligent bot 10014-WeCom intelligent bot 10011-LINE 10012-Telegram 10013-DingTalk chatbot 10016-Lark chatbot 30000-scheduled task 30001-trigger
  • FeedbackType : feedback type, -1-all 0-not rated 1-like 2-dislike
  • QueryType : retrieval type (take value as agreed by the platform), SessionId-sessionID Question-question Answer-reply Intent-intent User-user
  • Query : filter criteria corresponding to QueryType
  • CategoryId : category ID
  • ReplyMethod : reply type 0-all reply types 1-reply to rejected questions 2-direct QA reply 3-review failure reply 4-knowledge polish reply 6-workflow reply 8-image understanding reply 9-search engine reply 10-large model direct reply 11-fallback response
  • StartTime : start time, unix second-level timestamp
  • EndTime : end time, unix second-level timestamp
  • Cursor : cursor. For the previous page, take PrevCursor from the response; for the next page, take NextCursor from the response.
  • Direction : direction. next: next page, prev: previous page
  • CallResult : call result: 0-all / 1-success / 2-failure / 3-canceled by the user
  • FailReason : failure reason 0-all 1-review failure 2-QPM limit reached 3-TPM limit reached 4-concurrency limit reached 5-system exception
  • Intent : intent
PageNumber No Integer

Page number, starting from 0. If not passed, it is processed as 0.

PageSize No Integer

Number of items per page. Maximum value: 100. If not specified or set to 0, the default pagination size is used.

Sort No Sort

Sort condition. Supports sorting by CreateTime only

3. Output Parameters

Parameter Name Type Description
HasMore Boolean

Whether there are more pages

MsgRecordList Array of MsgRecord

Message record list

NextCursor String

Next page cursor information.

PrevCursor String

Previous page cursor info.

TotalCount String

Total record count that meets the conditions, used for frontend paginated display

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 Use Case 1

Input Example

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

{
    "AppId": "2087429578337166592",
    "FilterList": [
        {
            "Name": "StartTime",
            "ValueList": [
                "1786118400"
            ]
        }
    ]
}

Output Example

{
    "Response": {
        "HasMore": false,
        "MsgRecordList": [
            {
"Answer": "# \"Defying the Heavens: Path to Immortality\"\n\n## Chapter One: The Useless One Defies Fate\n\n---\n\nDeep within the vast mountain range, clouds and mist rolled like an ocean.\n\nOutside Fallen Cloud City, in a run-down woodshed, the young man Lin Yuan sat cross-legged, eyes tightly shut, veins bulging on his forehead, beads of sweat rolling down his cheeks.\n\n\"Failed again.\"\n\nHe slowly opened his eyes, bitterness filling his gaze. Sixteen years old, practicing",
                "AppId": "2087429578337166592",
                "CategoryId": "0",
                "CreateTime": "1786526009",
"Intent": "other issues"
                "IntentCategory": "default",
                "IsSmart": false,
"Question": "Write a cultivation novel for me without calling any tools"
                "RecordId": "Gwx_20260812_171328_602_BAZ2vswt",
                "ReplyMethod": 10,
                "Result": {
                    "CallResult": 3,
                    "CustomerVariable": "**",
                    "FailReason": "0",
                    "FirstTokenLatency": 2685,
                    "InputToken": 1991,
                    "OutputToken": 44,
                    "TotalToken": 2035,
                    "TotalTokenLatency": 6444
                },
                "Score": 0,
                "SessionId": "c0a10dbb-b9fa-4aae-89fd-7f0d44a8eec0",
                "Source": {
                    "ChannelType": 2,
                    "FromId": "1319",
                    "FromType": 2,
                    "UserAvatar": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/avatar_sheep01.png",
                    "UserId": "1932008810606356480",
                    "UserNickname": "ty_02@tt.com"
                },
                "TraceId": "34e89fa8029842ebaaac03cd31192d23"
            }
        ],
        "NextCursor": "{\"cursor_time\":\"2026-08-12 14:43:24\",\"skipped\":6}",
        "PrevCursor": "{\"cursor_time\":\"2026-08-12 17:13:29\",\"skipped\":0}",
        "TotalCount": "6",
        "RequestId": "b3eedba2-e542-4e7e-aa84-0b2d46f8ec1f"
    }
}

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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Parameter error.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック