Retrieve Records Based on Conditions
Administrators can access call records based on specified conditions through this interface.
Note:
The RESTful API is currently in beta. You can query call data created within the past seven days.
API description
Sample request URL
https://xxxxxx/v1/records/get_records_by_filter?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The table below only lists the parameters modified when calling this API and their description. For more information, please refer to REST API Overview.
Parameter | Description |
xxxxxx | The reserved domain for the country/region where the SDKAppID is located: callkit-intl.trtc.tencent-cloud.com |
v1/records/get_records_by_filter | Request API |
sdkappid | SDKAppID assigned by the console when creating an application |
identifier | Using the Admin account of Chat |
usersig | The Signature generated by the App Administrator account, for detailed operations, please refer to Generating UserSig |
random | Enter a random 32-bit unsigned integer, range 0 to 4294967295 |
contenttype | The request format fixed value is json |
Maximum calling frequency
200 queries/sec.
Sample request packets
Basic form
Create room
{"startTimestamp": 1618705638,"endTimestamp": 1618705738,"callResult": "normal_end","callType": "single","numberPerPage": 20,"page": 2}
Request packet fields
Field | Type | Attribute | Description |
startTimestamp | Integer | Mandatory | Call start timestamp (in seconds) |
endTimestamp | Integer | Optional | Call end Timestamp (in seconds), if not specified, the default is 7 days |
callResult | String | Optional | Call result, if not specified, defaults to all results |
callType | String | Optional | Call type, if not specified, defaults to all types |
numberPerPage | Integer | Optional | Number of queries per page, default is: 100 |
page | Integer | Optional | Query page number, if not specified, defaults to the first page |
Response Packet Field Example
{"errorCode": 0,"errorMessage": "Success","requestId": "8ba14f64a1d92d38705eec775e1f3deb","data": {"totalNum": 3,"page": 2,"callRecordList": [{"callId": "2ae7d549-c441-4a9b-87c0-61810fe19581","sdkAppId": 88888888,"mediaType": "video","roomId": "456","startCallTs": 1688709003,"acceptTs": 1688709003,"endTs": 1689150030,"caller": "123","totalUserNumber": 0,"callType": "single","callResult": "offline","callees": ["111","123"]},{"callId": "2ae7d549-c441-4a9b-87c0-61810fe19582","sdkAppId": 88888888,"mediaType": "video","roomId": "456","startCallTs": 1688709303,"acceptTs": 1688709303,"endTs": 1689150030,"caller": "123","totalUserNumber": 0,"callType": "single","callResult": "offline","callees": ["111","123"]},{"callId": "2ae7d549-c441-4a9b-87c0-61810fe19583","sdkAppId": 88888888,"mediaType": "video","roomId": "456","startCallTs": 1688709903,"acceptTs": 1688709903,"endTs": 1689150030,"caller": "123","totalUserNumber": 0,"callType": "single","callResult": "offline","callees": ["111","123"]}]}}
Response Packet Field Description
Field | Type | Description |
errorCode | Integer | Error code, 0 indicates success |
errorMessage | String | Error message |
requestId | String | Unique Request ID |
totalNum | Integer | Total Quantity for This Query |
page | Integer | When page > 0 it indicates that there is more data, incrementing page by 1 will request subsequent data. |
callRecordList | Array | Please refer to: Single Call Record Description |
Single Call Record Description
Field | Type | Description |
callId | String | Unique ID of the call |
sdkAppId | Integer | Your sdkAppId |
mediaType | String | Media type video Video Callaudio Audio Call |
roomId | String | Room ID of the call |
startCallTs | Integer | Call Initiation Timestamp (in seconds) |
acceptTs | Integer | Call Connection Timestamp (in seconds) |
endTs | Integer | Call End Timestamp (in seconds) |
caller | String | Caller userId |
totalUserNumber | Integer | Total Number of Participants in the Call |
callType | String | Call type single One-on-one callgroup Group Call |
callResult | String | Call Result: cancel Cancel: The caller cancelled the call before connection.reject Declined call: The callee rejected.not_answer Not Answered: The callee did not answer in time.normal_end Completed: The call was connected and ended normally.call_busy Busy: The line was busy during the call.interrupt Interrupts: The call was interrupted due to network or other reasons. |
callees | Array | List of callee user IDs who participated in the call |
Note:
The callResult field may display all types for one-on-one calls only, while group chats only have
normal_end.Error codes
Unless there is a network error (e.g., a 502 error), the HTTP return code for this interface is always 200. The actual error code and error message are conveyed through errorCode and errorMessage in the response body.
For common error codes (70000 to 79999), please see Error Code.
Error code | Description |
0 | Request succeeded |
50001 | The current application needs to purchase the TUICallKit Group Call Version Package to use |
70011 | No records found |
Unknown error code |