接口请求域名: trro.intl.tencentcloudapi.com 。
获取会话统计值
默认接口请求频率限制:20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeSessionStatistics。 |
| Version | 是 | String | 公共参数,本接口取值:2022-03-25。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| ProjectId | 是 | String | 项目ID |
| DeviceId | 否 | String | 设备ID |
| StartTime | 否 | Integer | 起始时间,单位:秒 |
| EndTime | 否 | Integer | 结束时间,单位:秒 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SessionNum | Integer | 会话数量 |
| TotalDuration | Integer | 通话时长,单位:分钟 |
| ActiveFieldDeviceNum | Integer | 活跃现场设备数 |
| ActiveRemoteDeviceNum | Integer | 活跃远端设备数 |
| NotBadSessionRatio | Integer | 优良会话占比,单位:% |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: trro.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSessionStatistics
<公共请求参数>
{
"ProjectId": "abcdefg",
"DeviceId": "dev2",
"StartTime": 1670000000,
"EndTime": 1670000000
}
{
"Response": {
"ActiveFieldDeviceNum": 1,
"ActiveRemoteDeviceNum": 1,
"NotBadSessionRatio": 100,
"RequestId": "abcdefg-1d31-47bc-8725-76124984f005",
"SessionNum": 6,
"TotalDuration": 604
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |
文档反馈