调用DescribeCallList分页查询时间范围内创建的通信信息。
接口说明
使用说明
本接口用于查询时间范围内创建的通信信息。例如:您可以查询通讯时长、状态、用户数等信息。
QPS 限制
本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | APP ID。 | testappid |
StartTs | long | 是 | 查询的开始时间,使用 UNIX 时间戳表示,单位:秒。 | 1615806196 |
EndTs | long | 是 | 查询的结束时间,使用 UNIX 时间戳表示,单位:秒。 | 1615892596 |
ChannelId | string | 否 | 频道 ID。 | 311 |
UserId | string | 否 | 用户 ID。 | c906531af5f9**** |
CallStatus | string | 否 | 通信状态。取值:
| OUT |
OrderBy | string | 否 | 排序字段。取值:
| BAD_EXP_USER_COUNT_DESC |
QueryMode | string | 否 | 查询模式。取值:
| ALL |
PageNo | integer | 是 | 页码。最小 1, 最大 200。 | 1 |
PageSize | integer | 是 | 每页数量,最小 1, 最大 200。 | 10 |
返回参数
示例
正常返回示例
JSON
格式
{
"PageNo": 1,
"PageSize": 10,
"TotalCnt": 1,
"CallList": [
{
"AppId": "testappid",
"ChannelId": "311",
"CallStatus": "OUT",
"CreatedTs": 1615806196,
"DestroyedTs": 1615806296,
"Duration": 100,
"UserCnt": 5,
"BadExpUserCnt": 0
}
],
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ApiParamError | API %s. | Api参数错误 |
403 | BizAppError | A business application permission error occurred. | 业务应用权限错误 |
403 | BizUidError | A business UID error occurred. | 业务主账号错误 |
500 | ServerInternalError | An internal error occurred. | 服务器内部错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-12-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|