1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeUserEvent。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-mumbai 。 |
CommId | 是 | String | 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取(查询历史房间列表)。 示例值:1400xxxxxx_3568_1588055615 |
StartTime | 是 | Integer | 查询开始时间,本地unix时间戳,单位为秒(如:1590065777) 注意:支持查询14天内的数据 示例值:1590065777 |
EndTime | 是 | Integer | 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) 注意:查询时间大于房间结束时间,以房间结束时间为准。 示例值:1590065777 |
UserId | 是 | String | 用户UserId 示例值:user_66319581 |
RoomId | 是 | String | 房间号(如:223) 示例值:1711 |
SdkAppId | 是 | Integer | 用户SdkAppId(如:1400xxxxxx) 示例值:1400xxxxxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | Array of EventList | 返回的事件列表,若没有数据,会返回空数组。 示例值:"Data": [ { "Content": [ |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询详细事件
查询用户某次通话内的进退房,视频开关等详细事件
输入示例
POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserEvent
<公共请求参数>
{
"StartTime": 1590065777,
"EndTime": 1590065877,
"CommId": "1400188366_218695_1590065777",
"UserId": "user_2045351",
"SdkAppId": 1400353843,
"RoomId": "1400"
}
输出示例
{
"Response": {
"Data": [
{
"Content": [
{
"Type": 0,
"Time": 1589975272790,
"EventId": 32793,
"ParamOne": -1,
"ParamTwo": -1
}
],
"PeerId": "hyder11"
},
{
"Content": [
{
"Type": 0,
"Time": 1589975212877,
"EventId": 32793,
"ParamOne": -1,
"ParamTwo": -1
}
],
"PeerId": "user_20453511"
},
{
"Content": [
{
"Type": 0,
"Time": 1589975202782,
"EventId": 32769,
"ParamOne": -1,
"ParamTwo": -1
},
{
"Type": 0,
"Time": 1589975202782,
"EventId": 32791,
"ParamOne": -1,
"ParamTwo": -1
},
{
"Type": 0,
"Time": 1589975202782,
"EventId": 32768,
"ParamOne": -1,
"ParamTwo": -1
},
{
"Type": 0,
"Time": 1589975202782,
"EventId": 32788,
"ParamOne": -1,
"ParamTwo": -1
},
{
"Type": 0,
"Time": 1589975202782,
"EventId": 32793,
"ParamOne": -1,
"ParamTwo": -1
}
],
"PeerId": "user_66319581"
}
],
"RequestId": "093bffd3-9d27-45ca-8410-c61c0e4cdcb8"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.EsQueryError | ES查询异常。 |
InternalError.HttpParaseFalied | http请求解析失败。 |
InternalError.InterfaceErr | 接口错误。 |
InternalError.MethodErr | 不支持的方法。 |
InvalidParameter | 参数错误。 |
InvalidParameter.BodyParamsError | body 解析参数失败。 |
InvalidParameter.EndTs | EndTs参数错误。 |
InvalidParameter.SdkAppid | 不能操作的SdkAppid。 |
InvalidParameter.StartTs | StartTs参数错误。 |
InvalidParameter.StartTsOversize | 查询开始时间超过文档限制。 |
InvalidParameter.UrlParamsError | Url解析参数失败。 |
InvalidParameter.UserId | UserId参数错误。 |
MissingParameter | 缺少参数错误。 |
MissingParameter.AppId | 缺少AppId参数。 |
MissingParameter.CommId | 缺少CommId参数。 |
MissingParameter.CommIdOrSdkAppId | 缺少SdkAppId参数或CommID参数。 |
MissingParameter.EndTs | 缺少endTS_s参数。 |
MissingParameter.RoomId | 缺少RoomId参数。 |
MissingParameter.StartTs | 缺少startTS_s参数。 |
MissingParameter.UserId | 缺少UserId参数。 |