功能说明
管理员可通过该接口获取指定 callId 的通话记录。
说明:
REST API 目前处于内测期,您可以查询创建时间在7天内的通话数据。
接口调用说明
请求URL示列
https://xxxxxx/v1/records/get_record_by_callId?sdkappid=88888888&identifier=administrator&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 中国站: callkit.trtc.tencent-cloud.com |
v1/records/get_record_by_callId | 请求接口 |
sdkappid | 创建应用时控制台分配的 SDKAppID |
identifier | 使用 IM 的管理员账号 |
usersig | |
random | 请输入随机的32位无符号整数,取值范围 0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
20次/秒。
请求包示例
{"callId": "2ae7d549-c441-4a9b-87c0-61810fe19582"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
callId | String | 必填 | 通话唯一 ID |
应答包体示例
{"errorCode": 0,"errorMessage": "Success","requestId": "3fdc344c7a67461c6af3cfc3e77744b5","data": {"callId": "2ae7d549-c441-4a9b-87c0-61810fe19582","sdkAppId": 88888888,"mediaType": "video","roomId": "123456","startCallTs": 1688705638,"acceptTs": 1688705641,"endTs": 1688705668,"caller": "alice","totalUserNumber": 2,"callType": "single","callResult": "normal_end","callees": ["bob1","bob2"]}}
应答包字段说明
字段 | 类型 | 说明 |
errorCode | Integer | 错误码,0为成功 |
errorMessage | String | 错误信息 |
requestId | String | 请求的唯一 ID |
callId | String | 通话的唯一 ID |
sdkAppId | Integer | 您的 sdkAppId |
mediaType | String | 媒体类型 video 视频通话audio 音频通话 |
roomId | String | 通话的房间 ID |
startCallTs | Integer | 通话发起的时间戳(秒级) |
acceptTs | Integer | 通话接通的时间戳(秒级) |
endTs | Integer | 通话结束的时间戳(秒级) |
caller | String | 主叫 userId |
totalUserNumber | Integer | 参与通话的总人数 |
callType | String | 通话类型: single 一对一通话group 群组通话 |
callResult | String | 通话结果: cancel 取消:主叫方在接通前取消通话。reject 拒接:被叫方拒接。not_answer 未接听:被叫方超时未接听。normal_end 完成:通话接通并正常结束。call_busy 忙线:通话忙线。interrupt 中断:网络等原因导致通话中断。 |
callees | Array | 被叫且参与通话的 userId 列表 |
说明:
callResult 字段仅一对一通话可能显示所有类型,群聊仅有
normal_end
。 错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 errorCode、errorMessage 来表示的。
公共错误码(70000到79999)请参见 错误码。
错误码 | 含义说明 |
0 | 请求成功 |
50001 | 当前应用需要购买 TUICallKit 群组通话版套餐包方可使用 |
70011 | 未找到任何记录 |
未知错误码 |