tencent cloud

Cloud Contact Center

Announcement
What's New
Cloud Contact Center Terminology Update
What is Tencent Cloud Contact Center
Overview
Feature List
Terms Introduction
Handling Firewall Restrictions
AI Voicebot
Billing Guide
Voice Call Billing Overview
Desk Billing Overview
View Billing
Refund Policy
New User Guide
Voice Guide
Desk Guide
Use Case
Inbound: Customer Experience
Outbound: Telemarketing
Auto Dialer: Voice Notification
Integration Use Case (SDK）
Administrator Guide
Voice Guide
Desk Guide
Member Guide
Voice Guide
Desk Guide
AI Voice Agent Guide
Introducing AI Voice Agent
AI Voice Agent Practical Tutorial
Set Up Your AI Voice Agent
Activate AI Voice Agent Call
AI Voice Agent Call Logs
Developer Guide
SDK Development Guide
Data Push
Voice API Reference
History
Introduction
API Category
Making API Requests
Agent APIs
Skill Group APIs
Number APIs
Dual Call APIs
Predictive Outbound Call APIs
SIP Phone APIs
Call Service Record APIs
Billing APIs
Other APIs
Outbound Call APIs
Speech Intelligent Agent APIs
Data Types
Error Codes
Desk API Reference
API Reference
Callback Configuration
FAQs
Data Deletion Guide
Legal
Privacy Policy
Data Processing And Security Agreement
Service Level Agreements
TENCENT CLOUD CONTACT CENTRE TERMS OF USE
Glossary
Contact Us
DokumentasiCloud Contact CenterDesk API ReferenceAPI ReferenceSession APIsQuery Session Records

Query Session Records

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

API Call Description

Through this API to query session records.

Sample Request URL

https://console.tim.qq.com/v4/desk_http_svc/describe_im_cdr_list?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 see REST API Introduction.
Parameter
Description
v4/desk_http_svc/describe_im_cdr_list
Request API.
sdkappid
Assigned SDKAppID in the IM console when creating an application.
identifier
Must be an App administrator account. For more details, see App Administrator.
usersig
Generated signature of the App administrator account. For specific operations, see Generate UserSig.
random
Enter a random 32-bit unsigned integer in the range of [0,4294967295].
contenttype
The request format has a fixed value of json.

Sample Request Packet

{
    "StartTimestamp": 1730390400,
    "EndTimestamp": 1730476799,
    "ClientUserId": "1299314544",
    "Limit": 10,
    "Offset": 0
}

Request Packet Fields

Field
Type
Required
Description
StartTimestamp
Integer
Required
Start time, Unix second-level timestamp
EndTimestamp
Integer
Required
End time, Unix second-level timestamp
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
ClientUserId
String
Optional.
Specified User ID to Query

Response Packet Body Example

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "TotalCount": 1,
    "IMCdrList": [
        {
            "SessionId": "a97d3e1f-a88b-403b-9b3a-7bc6554ea05d",
            "AgentGroupId": "3067",
            "AgentGroupName": "Online customer service"
            "AgentId": "shannon@qq.com",
            "ChannelType": "SDK",
            "ClientUserId": "1299314544",
            "ClientUserNickName": "Shannong"
            "Duration": 10,
            "EndStatus": "AgentEndedSession",
            "SatisfactionSelected": 5,
            "Timestamp": 1730443136
        }
    ]
}

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 record count
IMCdrList
Array
Session service record list
SessionId
String
Session ID of the session
AgentGroupId
String
Agent Group ID
AgentGroupName
String
Agent Group Name
AgentId
String
Agent ID
ChannelType
String
Integration method
SDK: SDK integration, corresponding to the "Application/Client" integration on the smart customer service management console
Web (H5): Web integration, corresponding to the "web page (H5)" integration on the intelligent customer service management side
ClientUserId
String
User ID
ClientUserNickName
String
User Nickname
Duration
Integer
Session duration, in seconds.
EndStatus
String
Session end status
'AgentEndedSession' Agent ended session
'UserEndedSession' User ended session
'UserTimeout' User reply has timed out.
'AgentTimeout' Agent reply has timed out
'ChatbotReception' Chatbot served user.
'NoAgentsOnline' no agent online
'TimeoutTransfer' No available agent, transfer has timed out.
'ManualTransfer' Manual Transfer
'UserAbandonedDuringQueueing' Abandoned during queue.
SatisfactionSelected
Integer
User satisfaction star rating (1 - 5), for example: 5 represents a five-star rating.
Timestamp
Integer
Session time, Unix second-level timestamp

Error Code Description

Unless a network error (for example, 502 error) occurs, the HTTP return code of this API is always 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 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
Internal error, retry.
141004
Invalid parameter.
141009
API rate limiting.

API Debugging Tool

Debug this interface using the REST API online debugging tool.

Topik sebelumnya: Query the Chat Record of the Specified SessionTopik selanjutnya: Querying User Session Status

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan