tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTelCdr

Last updated: 2024-09-09 17:57:55

1. API Description

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

This API is used to access phone service records and recordings.

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: DescribeTelCdr.
Version Yes String Common Params. The value used for this API: 2020-02-10.
Region No String Common Params. This parameter is not required for this API.
StartTimeStamp Yes Integer Start timestamp, Unix Timestamp in Seconds. Supports up to the past 180 days.
EndTimeStamp Yes Integer End timestamp, Unix Timestamp in Seconds. The range between the end time and start time is less than 90 days.
Limit No Integer Maximum number of returned entries (deprecated).
Offset No Integer Offset (deprecated).
SdkAppId No Integer Application ID (required) can be found at https://console.tencentcloud.com/ccc.
PageSize No Integer Page size (required), up to 100.
PageNumber No Integer Page number (required), starting from 0.
Phones.N No Array of String Filter by Phone Number.
SessionIds.N No Array of String Filter by SessionId.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of call records.
TelCdrList Array of TelCdrInfo Call record.
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 Sample Code for Accessing Phone Call Record

Input Example

https://ccc.tencentcloudapi.com/?Action=DescribeTelCdr
&SdkAppId=1400000000
&StartTimeStamp=1590547606
&EndTimeStamp=1590147606
&PageSize=10
&PageNumber=0
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 2,
        "TelCdrList": [
            {
                "ProtectedCaller": "abc",
                "EndStatus": 1,
                "SessionId": "abc",
                "CustomRecordURL": "abc",
                "RecordId": "abc",
                "SkillGroupId": 100,
                "Direction": 0,
                "StartTimestamp": 1590547606,
                "AsrUrl": "abc",
                "HungUpSide": "abc",
                "ServeParticipants": [
                    {
                        "TransferTo": "abc",
                        "TransferFromType": "abc",
                        "EndStatusString": "abc",
                        "RecordURL": "abc",
                        "TransferToType": "abc",
                        "AcceptTimestamp": 0,
                        "RecordId": "abc",
                        "TransferFrom": "abc",
                        "EndedTimestamp": 0,
                        "Sequence": 0,
                        "Phone": "abc",
                        "SkillGroupName": "abc",
                        "Mail": "abc",
                        "RingTimestamp": 0,
                        "Type": "abc",
                        "StartTimestamp": 0,
                        "CustomRecordURL": "abc",
                        "SkillGroupId": 0
                    }
                ],
                "PostIVRKeyPressed": [
                    {
                        "Key": "abc",
                        "Label": "abc"
                    }
                ],
                "EndStatusString": "abc",
                "UUI": "abc",
                "QueuedSkillGroupId": 100,
                "RingTimestamp": 1590547606,
                "AcceptTimestamp": 1590547606,
                "EndedTimestamp": 1590547606,
                "Caller": "abc",
                "CallerLocation": "abc",
                "Time": 1590547606,
                "Callee": "abc",
                "SeatUser": {
                    "Name": "abc",
                    "Phone": "abc",
                    "UserId": "abc",
                    "Nick": "abc",
                    "StaffNumber": "abc",
                    "Mail": "abc",
                    "SkillGroupNameList": [
                        "abc"
                    ]
                },
                "RecordURL": "abc",
                "QueuedTimestamp": 1610627284,
                "ProtectedCallee": "abc",
                "IVRDuration": 5,
                "SkillGroup": "abc",
                "Duration": 60,
                "IVRKeyPressed": [
                    "5"
                ],
                "IVRKeyPressedEx": [
                    {
                        "Key": "abc",
                        "Label": "abc"
                    }
                ],
                "Remark": "abc",
                "QueuedSkillGroupName": "abc",
                "VoicemailRecordURL": [
                    "abc"
                ]
            },
            {
                "ProtectedCaller": "abc",
                "EndStatus": 1,
                "SessionId": "abc",
                "CustomRecordURL": "abc",
                "RecordId": "abc",
                "SkillGroupId": 100,
                "Direction": 0,
                "StartTimestamp": 1590547630,
                "AsrUrl": "abc",
                "HungUpSide": "abc",
                "ServeParticipants": [
                    {
                        "TransferTo": "abc",
                        "TransferFromType": "abc",
                        "RecordURL": "abc",
                        "TransferToType": "abc",
                        "AcceptTimestamp": 0,
                        "RecordId": "abc",
                        "TransferFrom": "abc",
                        "EndedTimestamp": 0,
                        "Sequence": 0,
                        "Phone": "abc",
                        "EndStatusString": "abc",
                        "SkillGroupName": "abc",
                        "Mail": "abc",
                        "RingTimestamp": 0,
                        "Type": "abc",
                        "StartTimestamp": 0,
                        "CustomRecordURL": "abc",
                        "SkillGroupId": 0
                    }
                ],
                "PostIVRKeyPressed": [
                    {
                        "Key": "abc",
                        "Label": "abc"
                    }
                ],
                "EndStatusString": "abc",
                "UUI": "abc",
                "QueuedSkillGroupId": 100,
                "RingTimestamp": 1590547606,
                "AcceptTimestamp": 1590547606,
                "EndedTimestamp": 1590547606,
                "Caller": "abc",
                "CallerLocation": "abc",
                "Time": 1590547630,
                "Callee": "abc",
                "SeatUser": {
                    "Name": "abc",
                    "Nick": "abc",
                    "UserId": "abc",
                    "Phone": "abc",
                    "StaffNumber": "abc",
                    "Mail": "abc",
                    "SkillGroupNameList": [
                        "abc"
                    ]
                },
                "RecordURL": "abc",
                "QueuedTimestamp": 1610627284,
                "ProtectedCallee": "abc",
                "IVRDuration": 5,
                "SkillGroup": "abc",
                "Duration": 62,
                "IVRKeyPressed": [
                    "5"
                ],
                "IVRKeyPressedEx": [
                    {
                        "Key": "abc",
                        "Label": "abc"
                    }
                ],
                "Remark": "abc",
                "QueuedSkillGroupName": "abc",
                "VoicemailRecordURL": [
                    "abc"
                ]
            }
        ],
        "RequestId": "abc"
    }
}

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 An internal error occurs.
InternalError.DBError Internal database access failure.
InvalidParameter.InstanceNotExist The instance does not exist.
InvalidParameterValue parameter value is invalid.
InvalidParameterValue.InstanceNotExist The instance does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy