文档

DescribeCall - 查询单次通信详情

更新时间:

本接口用于查询单次通信详情。例如:您可以查询通讯状态、用户详情等信息。

接口说明

使用说明

本接口用于查询单次通信详情。例如:您可以查询通讯状态、用户详情等信息。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AppIdstring

APP ID。

testappid
ChannelIdstring

频道 ID。

testid
CreatedTslong

创建频道时间,支持查询最近 30 天的数据。使用 UNIX 时间戳表示,单位:秒。

说明 创建频道时间必须与实际创建时间完全一致(精确到秒)。您可以通过调用接口 DescribeCallList 查看创建频道时间(返回的 CreatedTS 参数)。
1614936817
DestroyedTslong

释放频道时间,使用 UNIX 时间戳表示,单位:秒。参数为空表示获取当前时间。

说明 如果传入的频道释放时间超过真实的释放时间,将返回从创建时间开始到真实释放时间之间的数据。
1614936817
ExtDataTypestring

查询的扩展。取值:USER_DURATION_STAT:用户时长统计数据类型。

USER_DURATION_STAT
QueryExpInfoboolean

是否查询通信体验信息,不传默认是 true。

false

返回参数

名称类型描述示例值
object

返回结果。

CallInfoobject

通信基本信息。

AppIdstring

App ID。

testappid
ChannelIdstring

频道 ID。

123456
CallStatusstring

通信状态。取值:

  • IN:进行中。
  • OUT:已结束。
IN
CreatedTslong

创建频道时间,使用 UNIX 时间戳表示,单位:秒。

1615860711
DestroyedTslong

释放频道时间,使用 UNIX 时间戳表示,单位:秒。

1615860811
Durationlong

频道持续时长,单位:秒。

100
UserDetailListobject []

用户详情列表。

UserIdstring

用户 ID。

testuserid
Rolesarray

用户角色。

string

用户角色,取值:

  • SENDER:发布端。
  • RECEIVER:订阅端。
SENDER
Locationstring

地理位置信息,例如:北京市-北京市。

浙江省-杭州市
OnlinePeriodsobject []

在线时段信息。

JoinTslong

加入频道时间,使用 UNIX 时间戳表示,单位:秒。

1614936817
LeaveTslong

离开频道时间,使用 UNIX 时间戳表示,单位:秒。

1614936817
CreatedTslong

第一次加入频道的时间,使用 UNIX 时间戳表示,单位:秒。

1614936817
DestroyedTslong

最后一次离开频道的时间,使用 UNIX 时间戳表示,单位:秒。通信未结束时值为空。

1614936817
OnlineDurationlong

在线时长,单位:秒。

0
Durationlong

通信时长,首次进入到最后离开,单位:秒。

0
SdkVersionstring

SDK 版本,如 1.0.0、1.1.1 等

1.0.0
SdkVersionListarray

SDK 版本列表,如 1.0.0、1.1.1 等

string

SDK 版本列表,例如 1.0.0、1.1.1 等。

1.0.0
Osstring

平台类型:若用户客户端为 WEB 则是浏览器类型,若客户端为 NATIVE 则是操作系统类型。

iOS
OsListarray

平台类型:若用户客户端为 WEB 则是浏览器类型,若客户端为 NATIVE 则是操作系统类型。

string

浏览器或操作系统类型,例如 Chrome、iOS、Android 等。

iOS
Networkstring

网络类型,如 WiFi,4G 等。

4G
NetworkListarray

网络类型,如 WiFi,4G 等。

string

网络类型,例如 WiFi,4G 等。

4G
CallExpstring

通话体验。取值:

  • GOOD:良好。
  • BAD:欠佳。
GOOD
DurMetricStatDataobject

时长统计数据。

PubAudiolong

发布音频时长,单位:秒。

0
SubAudiolong

订阅音频时长,单位:秒。

0
PubVideo360long

发布 360P 视频时长,单位:秒。

0
SubVideo360long

订阅 360P 视频时长,单位:秒。

0
PubVideo720long

发布 720P 视频时长,单位:秒。

0
SubVideo720long

订阅 720P 视频时长,单位:秒。

0
PubVideo1080long

发布 1080P 视频时长,单位:秒。

0
SubVideo1080long

订阅 1080P 视频时长,单位:秒。

0
PubVideoScreenSharelong

发布屏幕共享时长,单位:秒。

0
SubVideoScreenSharelong

订阅屏幕共享时长,单位:秒。

0
RequestIdstring

请求 ID。

231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

JSON格式

{
  "CallInfo": {
    "AppId": "testappid",
    "ChannelId": "123456",
    "CallStatus": "IN",
    "CreatedTs": 1615860711,
    "DestroyedTs": 1615860811,
    "Duration": 100
  },
  "UserDetailList": [
    {
      "UserId": "testuserid",
      "Roles": [
        "SENDER"
      ],
      "Location": "浙江省-杭州市",
      "OnlinePeriods": [
        {
          "JoinTs": 1614936817,
          "LeaveTs": 1614936817
        }
      ],
      "CreatedTs": 1614936817,
      "DestroyedTs": 1614936817,
      "OnlineDuration": 0,
      "Duration": 0,
      "SdkVersion": "1.0.0",
      "SdkVersionList": [
        "1.0.0"
      ],
      "Os": "iOS",
      "OsList": [
        "iOS"
      ],
      "Network": "4G",
      "NetworkList": [
        "4G"
      ],
      "CallExp": "GOOD",
      "DurMetricStatData": {
        "PubAudio": 0,
        "SubAudio": 0,
        "PubVideo360": 0,
        "SubVideo360": 0,
        "PubVideo720": 0,
        "SubVideo720": 0,
        "PubVideo1080": 0,
        "SubVideo1080": 0,
        "PubVideoScreenShare": 0,
        "SubVideoScreenShare": 0
      }
    }
  ],
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code错误码错误信息描述
400ApiParamErrorAPI %s.Api参数错误
403BizCreatedTsErrorA business CreatedTs error occurred.参数会议创建时间不准确。
403BizAppErrorA business application permission error occurred.业务应用权限错误
403BizUidErrorA business UID error occurred.业务主账号错误
500ServerInternalErrorAn internal error occurred.服务器内部错误

访问错误中心查看更多错误码。