tencent cloud

Cloud Contact Center

DokumentasiCloud Contact CenterDesk API ReferenceAPI ReferenceSession APIsQuery the Chat Record of the Specified Session

Query the Chat Record of the Specified Session

Mode fokus
Ukuran font
Terakhir diperbarui: 2025-04-07 11:14:03

API Call Description

Through this API to query the chat record of the specified session.

Sample Request URL

https://console.tim.qq.com/v4/desk_http_svc/describe_chat_messages?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table only lists the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, please refer to REST API Introduction.
Parameter
Description
v4/desk_http_svc/describe_chat_messages
Request API.
sdkappid
Assigned SDKAppID in the Chat console when creating an application.
identifier
Must be an App administrator account. For more details, see App Administrator.
usersig
Generated signature by the App administrator account. For specific operations, see Generate UserSig.
random
Enter a random 32-bit unsigned integer in the range of 0 to 4294967295.
contenttype
The request format has a fixed value of json.

Sample Request Packet

{
    "SessionId": "b0f4ca12-4850-4218-a284-efe679a87066",
    "Limit": 50,
    "Offset": 0,
    "Order": 1
}

Request Packet Fields

Field
Type
Required
Description
SessionId
String
Required
Specify the session ID to be queried.
Limit
Integer
Optional.
Number of returned entries, the maximum is 100, the default is 20.
Example value: 100
Offset
Integer
Optional.
Offset of returned records, default is 0.
Example value: 0
Order
Integer
Optional.
1. From morning to evening; 2. From evening to morning. Default is 2.
Example value: 1

Response Package Example

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "Messages": [
        {
            "FromAccount": "8618655061639",
            "FromAccountRole": 1,
            "MsgBody": [
                {
                    "MsgContent": {
                        "Text": "hello"
                    },
                    "MsgType": "TIMTextElem"
                }
            ],
            "Timestamp": 1730939030138
        }
    ],
    "TotalCount": 26
}

Response Packet Fields

Field
Type
Description
ErrorCode
Integer
Error Code:
0: success.
Non-zero: failure.
ErrorInfo
String
Error message.
ActionStatus
String
Result of request processing.
TotalCount
Integer
Total Message Count
Messages
Array
Queried message list
FromAccount
String
Message-sending account
FromAccountRole
Integer
Account role for sending messages
1: User Message
2: Agent message
3: System management messages
MsgBody
Array
Message body. For details, please refer to Message Format Description.
Timestamp
Integer
Session time, Unix millisecond-level timestamp.

Error Code Description

Unless a network error (for example, 502 error) occurs, the HTTP return code of this API is 200. The actual error code and error information are indicated by ErrorCode and ErrorInfo in the response packet body.
For common error codes (60000 to 79999), see the Error Code document.
The private error codes of this API are as follows:
Error Code
Description
141000
The application is not a desk application.
141002
CLS internal error, retry.
141004
Invalid parameter.
141009
API rate limiting.
141010
The session does not exist.

API Debugging Tool

Debug this interface using the REST API Online Debugging Tool.

Topik sebelumnya: Proactively Contact UserTopik selanjutnya: Query Session Records

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan