查询实时规模

更新时间不可用

获取实时的通话人数和频道数。

GET
https://api.sd-rtn.com/beta/realtime/usage/by_time_20sec

鉴权

Authorization

使用声网 RESTful API 的凭证。发送请求时,你需要使用声网提供的客户 ID 和客户密钥生成一个使用 Base64 算法编码的凭证,并填入 HTTP 请求头部的 Authorization 字段。详见使用 HTTP 认证。

查询参数

startTsnumber
必填

查询的时间范围起点,Unix 时间戳(秒)。响应中会包含起点所在的时间窗口。

endTsnumber
必填

查询的时间范围终点,Unix 时间戳(秒)。响应中不会包含终点所在的时间窗口。

appidstring
必填

你的项目使用的 App ID。

productTypestring
必填

要查询的产品类型,支持设为以下值:

  • Native:指 Android、iOS、macOS、Windows 平台的声网 RTC SDK。
  • WebRTC:指 Web 平台的声网 RTC SDK。
metricstring
必填

要查询的指标,支持设为以下值:

  • userCount:通话人数,一个用户 ID 在一个频道中计为一人,在多个频道中计为多人。
  • channelCount:频道数,从有用户加入频道到所有用户离开频道计为一个通话频道。
dimensionunknown

统计维度,仅支持单维度指定。仅在 metric 为 userCount 时生效。支持设为以下值:

  • country:国家。
  • region:地区。
  • net:网络类型。
  • sdk:SDK 版本。
  • os:操作系统。
  • device:设备型号。 你可以通过获取实时规模 TOP 20 分组获取当前 dimension 下的 TOP 值,再根据业务需要从中选取几个值,来作为下次请求时传入 dimensionValues 的值。
dimensionValuesunknown

统计维度的值 ,即对 dimension 中设定的维度指定取值,仅在传入 dimension 时有效。所有值必须用双引号包括,并以逗号分隔。

cnamestring

频道名称。如果不填,代表查询该项目的整体指标。

响应

OK

响应 Body

codenumber

响应状态码。200 表示请求成功,详见响应状态码。

messagestring

错误消息。

dataarray<object>

由指标数据、维度和 Unix 时间戳(秒)组成的数组。

请求示例

Example Request
curl --request GET \
  --url "https://api.sd-rtn.com/beta/realtime/usage/by_time_20sec?startTs=1631837410&endTs=1631837470&appid=string&productType=string&metric=string" \
  --header 'Authorization: Basic <credentials>'

响应示例

{
  "code": 200,
  "message": null,
  "data": [
    {
      "userCount": 236,
      "sdk": "3.6.1.1",
      "ts": 1631837400
    },
    {
      "userCount": 82,
      "sdk": "4.1.1",
      "ts": 1631837400
    },
    {
      "userCount": 235,
      "sdk": "3.6.1.1",
      "ts": 1631837420
    },
    {
      "userCount": 85,
      "sdk": "4.1.1",
      "ts": 1631837420
    },
    {
      "userCount": 252,
      "sdk": "3.6.1.1",
      "ts": 1631837440
    },
    {
      "userCount": 90,
      "sdk": "4.1.1",
      "ts": 1631837440
    }
  ]
}