tencent cloud

DescribeSessionDetail
Last updated: 2025-11-11 10:19:57
DescribeSessionDetail
Last updated: 2025-11-11 10:19:57

1. API Description

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

This API is used to query call detail.

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: DescribeSessionDetail.
Version Yes String Common Params. The value used for this API: 2020-02-10.
Region No String Common Params. This parameter is not required.
SdkAppId Yes Integer App ID (required). can be used to view https://console.tencentcloud.com/ccc.
SessionId Yes String Specifies the session id of the call.
StartTimestamp Yes Integer Start timestamp. Unix second-level timestamp. supports up to nearly 180 days.
EndTimestamp Yes Integer End timestamp, Unix second-level timestamp. the interval range between end time and start time is less than 90 days.

3. Output Parameters

Parameter Name Type Description
Caller String Calling number.
Callee String Called number.
CallType Integer Call type. valid values: 1 (outgoing call), 2 (incoming call), 3 (audio dial-in), 5 (predictive outbound call), 6 (internal call).
StartTimeStamp Integer Start timestamp. Unix second-level timestamp.
RingTimestamp Integer Ring timestamp. UNIX second-level timestamp.
AcceptTimestamp Integer Answer timestamp. UNIX second-level timestamp.
EndedTimestamp Integer End timestamp, UNIX second-level timestamp.
QueuedTimestamp Integer Queue entry time. Unix second-level timestamp.
StaffUserId String Agent account.
EndStatus Integer Refers to the EndStatus field in the DescribeTelCdr api.
QueuedSkillGroupId Integer Queue skill group ID.
QueuedSkillGroupName String Queue skill group name.
RecordURL String Recording url with authentication and valid period. obtain and pull within a short time frame. do not persist this link.
CustomRecordURL String Specifies the COS link for recording transfer to a third party.
AsrURL String Recording text information link with authentication and valid period. retrieve it within a short time frame. do not persist this link.
VoicemailRecordURL Array of String Voicemail recording url.
VoicemailAsrURL Array of String Voicemail recording text information url. purchase the offline speech recognition package through the console and enable the offline speech recognition switch.
IVRKeyPressed Array of IVRKeyPressedElement IVR key information.
PostIVRKeyPressed Array of IVRKeyPressedElement Satisfaction rate keystroke information.
HungUpSide String Hang-Up side. valid values: seat, user, system.
UUI String Customer custom data (User-to-User Interface).
Events Array of SessionEvent List of events during a call.
ServeParticipants Array of ServeParticipant List of service participants.
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 Querying Call Detail Example

This example shows you how to query call detail.

Input Example

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

{
    "SdkAppId": 1400000000,
    "SessionId": "0f507d5d-e1e4-436e-a655-1d6c75a79b4f",
    "StartTimestamp": 1756372067,
    "EndTimestamp": 1756893037
}

Output Example

{
    "Response": {
        "AcceptTimestamp": 1756892204,
        "AsrURL": "https://tccc.qcloud.com/tcccadmin/cdr/getAsrText?key=PEbNJ4mQ723VpLFHvMinns4n8Pnq1nmySYbmD7tljzGXyrb6jvtOBGbrQBAg%3D%3D-k-fKVP3WIlGpg8m9LMW4jEkQ%3D%3D-k-Hz86ZdIwexo5JKCsB%2BGeybDY6nqSjwcpbXifo%2B%2FNDf9LzO9%IZHUrajgyWkRDUWxLNWxVQkF3N0N6V1VKZnlhVWljWmNVV01HR2NPL2NyRlBKeW92NFcwV0ZvUklibFl1RExOdkFaSkFONmlqOWxrQWlCMTFrNmNZWVgrQWdObEJ3OTZzTjJwTWk0UEZ2cS9tZXc9PSIsIm5vbmNlIjoiMDd1aFNLRDFmSTV4enQzNyX9",
        "CallType": 1,
        "Callee": "0086158xxxxxxxx",
        "Caller": "00860755xxxxxxxx",
        "CustomRecordURL": "https://example.cos.ap-guangzhou.tencentcos.cn/record/2025/09/03/17/1756892231_f460fff5-0cad-8424-e904ef6a76d2.mp3",
        "EndStatus": 1,
        "EndedTimestamp": 1756892230,
        "Events": [
            {
                "EventType": "StaffHold",
                "StaffEventDetail": {
                    "Staffs": [
                        {
                            "Mail": "foo@tencent.com",
                            "StaffNumber": "20012"
                        }
                    ]
                },
                "Timestamp": 1756892209
            },
            {
                "EventType": "StaffUnhold",
                "StaffEventDetail": {
                    "Staffs": [
                        {
                            "Mail": "foo@tencent.com",
                            "StaffNumber": "20012"
                        }
                    ]
                },
                "Timestamp": 1756892217
            },
            {
                "EventType": "StaffMute",
                "StaffEventDetail": {
                    "Staffs": [
                        {
                            "Mail": "foo@tencent.com",
                            "StaffNumber": "20012"
                        }
                    ]
                },
                "Timestamp": 1756892220
            },
            {
                "EventType": "StaffUnmute",
                "StaffEventDetail": {
                    "Staffs": [
                        {
                            "Mail": "foo@tencent.com",
                            "StaffNumber": "20012"
                        }
                    ]
                },
                "Timestamp": 1756892224
            }
        ],
        "HungUpSide": "user",
        "IVRKeyPressed": [],
        "PostIVRKeyPressed": [],
        "QueuedSkillGroupId": 0,
        "QueuedSkillGroupName": "",
        "QueuedTimestamp": 0,
        "RecordURL": "https://tccc.qcloud.com/tcccadmin/getRecord/PEbNJ4mQ723VpLFHvMinns4n8Pnq1nmySYbmD7tljzGXyrb6jDk+I%+Fd6MhhwvtOBGbrQBAg==-k-fKVP3WIlGpg8m9LMW4jEkQ==-k-nhmzd124T8YIkIsnUjieNBmvkGzu6mYJxMPYpb9zwZc4bsUdV%=/eyJ0b2tlbklkRW52IjoicW5icGdyOG1NaTdWOFo2c3F3N3UxSDdDVUYzYi9ZRzhqUE1heGJRY0pFdG9tZkJmNW9CNDdpNG1ZaWIzMXFNZW1XNzh2MWdqdm4wUE9JRkoxMFdRLzgvTXFDVEtzSFlOdVIzYTZPN295VDUvaHdoU2lXVVZNWlNOdlJTdXk5UWEwUGZjZ0RQbFo4Z0RubVd3SzNLTld0NTdTVmxQS3lVdEVEMGtCeGtnZzlIbHpDSnN3VllkN290R1ZTVjBpVHQ5eTRPRll4a0ErL2ZHYXpUMEpvcWZyckhtcVJVbnRYSTNQazJ4N0RPSTdvZ1F6VTNwUlBTTXNPU1hhNUF2S0g3YVRTRk44Yk9lTHowcmtTMXlFSVVRIiwibm9uY2UiOiJvVlBmQW9yU1NqMDNwWEZTIn0=/000-2529533707-11368-dd792000e656498092f0672dd10f1954-000-1756892321.mp3",
        "RequestId": "d6053004-779e-4cea-bbff-aa689b5fb9ff",
        "RingTimestamp": 1756892201,
        "ServeParticipants": [
            {
                "AcceptTimestamp": 1756892204,
                "CustomRecordURL": "https://example.cos.ap-guangzhou.tencentcos.cn/record/2025/09/03/17/1756892231_8a76adc6-e70c-459d-8921-56c88d91f840.mp3",
                "EndStatusString": "ok",
                "EndedTimestamp": 1756892230,
                "Mail": "foo@tencent.com",
                "Phone": "",
                "RecordId": "8a76adc6-e70c-459d-8921-56c88d91f840",
                "RecordURL": "https://tccc.qcloud.com/tcccadmin/getRecord/PEbNJ4mQ723VpLFHvMinns4n8Pnq1nmySYbmD7tljzGXyrb6jDk+I%2Fte3zvgZBju2cQ+Fd6MhhwvtOBGbrQBAg==-k-fKVP3WIlGpg8m9LMW4jEkQ==-k-nhmzd124T8YIkIsnUjieNBmvkGzu6mYJxMPYpb9zwZc4bsUdV%2FRydVMnwbuKd1DLNvTC8LpUTz2ToslvXs4onjeAOlY=/eyJ0b2tlbklkRW52IjoiSjlkVXNhWlB4cGRydEJydEN6UEQ0dVBZNVBKTTM3ZjdoWjA3N05Ob3BFaVRQenlkVjRZK2tQNmpPWlN0Vjh2VFg1ZGJNcUFZK0RCckhMbHRnMks5ZGw1cWQwRzN5VURBQmdKeTZSYnVvcjYzejNTeXZxWHhZNGpEQUdYRkJ6NU9lMWZYbFB6akh0TEhRMFJhL0VvcTFlR1g2VDhiejVUUVJLNkk2Q3NMNDRRSUsvcDZ0QmlLV08xLzFCOW9RNXZIbk1zZmpzYXViem1Zb05RengvL1VuMERXcm9qeHNLby9RYzdLejhjVEtqZGE5dGtSVlJhK1hGZU90Q2pEMUNsbmdqYUhWd0pxVDNaQjMxMlZYeWNaIiwibm9uY2UiOiJWZkNxbU5teG1mcjVFeW1QIn0=/000-3989151499-12368-6808000033894582a618470286620405-000-1756892101.mp3",
                "RingTimestamp": 1756892198,
                "Sequence": 0,
                "SkillGroupId": 2522,
                "SkillGroupName": "foo-tel",
                "StartTimestamp": 1756892198,
                "TransferFrom": "",
                "TransferFromType": "",
                "TransferTo": "",
                "TransferToType": "",
                "Type": "staffSeat"
            }
        ],
        "StaffUserId": "foo@tencent.com",
        "StartTimeStamp": 1756892198,
        "UUI": "",
        "VoicemailAsrURL": [],
        "VoicemailRecordURL": []
    }
}

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
FailedOperation.SessionNotExists Session does not exist.
InternalError An internal error occurs.
InternalError.DBError Internal database access failure.
InvalidParameterValue Invalid Parameter
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback