Retrieve Records by Conditions
功能说明
App 管理员可以通过该接口获取指定条件的7天内通话记录。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/call_record_http_srv/get_record_by_filter?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 中国: console.tim.qq.com 新加坡: adminapisgp.im.qcloud.com |
v4/call_record_http_srv/get_record_by_filter | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
基础形式
查询7天内所有通话记录,默认查询第一页前10条。
{}
指定条件形式
{"StartTime":0, // 默认为当前时间减7天"EndTime":1740531683, // 默认为当前时间"CallResult":"NormalEnd","CallType":"SingleCall","NumberPerPage":2,"Page":2}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
StartTime | Integer | 选填 | 查找通话记录起始时间,默认为当前时间减7天。如果填写时间小于默认时间,后台会自动调整为默认时间 |
EndTime | Integer | 选填 | 查找通话记录结束时间(秒级),默认为当前时间 |
NumberPerPage | Integer | 选填 | 每页查询数量,默认为:10 |
Page | Integer | 选填 | 查询页数,不填默认为第一页 |
应答包体示例
基础形式
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-d3d6aa216dcc4cf4a4eee19c4942e740-O-Seq-2556133","Response": {"TotalNum": 141,"Page":2,"CallRecordList": [{"CallId": "04c9a0ac-8e38-4a19-be45-349c5ce7911b","Caller_Account": "147","MediaType": "Audio","CallType": "SingleCall","StartTime": 1739960242,"EndTime": 1739960245,"AcceptTime": 1739960244,"CallResult": "NormalEnd","CalleeList_Account": ["147","369"],"RoomId": "roomid-1434","RoomIdType": 2},{"CallId": "055662e1-bc8a-469c-a334-1126c8c17d58","Caller_Account": "3423","MediaType": "Video","CallType": "SingleCall","StartTime": 1739960500,"EndTime": 1739960507,"AcceptTime": 1739960503,"CallResult": "NormalEnd","CalleeList_Account": ["3423","3243"],"RoomId": "roomid-1434","RoomIdType": 2}]}}
应答包字段说明
字段 | 类型 | 说明 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
RequestId | String | 唯一请求 ID,每次请求都会返回,定位问题时需要提供该次请求的 RequestId |
TotalNum | Integer | 此次查询的总数量 |
Page | Integer | 当 Page > 0 时 说明还有数据,将 Page+1 可继续请求之后的数据 |
CallId | String | 通话 ID |
Caller_Account | String | 主叫 用户 ID |
MediaType | String | 媒体类型: Video 视频通话Audio 音频通话 |
CallType | String | 通话类型: SingleCall 一对一通话MultiCall 多人通话 |
StartTime | Integer | 通话发起的时间戳(秒级) |
EndTime | Integer | 通话结束的时间戳(秒级) |
AcceptTime | Integer | 通话接通的时间戳(秒级) |
CallResult | Integer | 通话结果: Cancel 取消:主叫方在接通前取消通话Reject 拒接:被叫方拒接NotAnswer 未接听:被叫方超时未接听NormalEnd 完成:通话接通并正常结束CallBusy 忙线:通话忙线Interrupt 中断:网络等原因导致通话中断 |
CalleeList_Account | Array | 通话成员列表 |
RoomId | String | TRTC 房间 ID |
RoomIdType | Integer | RoomId 类型: 1 数字房间号2 字符串房间号 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 含义说明 |
101001 | 服务器内部错误,请重试 |
101050 | 通话记录不存在 |