获取在线用户列表

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Authorization

string

必需

login成功返回的token

Body 参数application/json

page

number

分页,从零开始

必需

pageSize

number

分页大小

必需

filter

object

过滤条件

可选

match

string

可选

模糊匹配用户账号/用户姓名

id

string

用户ID

可选

gid

string

所属用户组ID

可选

device

enum<number>

可选

0:全部，1：有设备能力，2：没有设备能力

枚举值:

012

order

enum<string>

排序

可选

枚举值:

+id-id+time-time

示例

{
    "page": 0,
    "pageSize": 0,
    "filter": {
        "match": "string",
        "id": "string",
        "gid": "string",
        "device": 0
    },
    "order": "+id"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://192.168.88.32:9781/bvcsp/v1/user/online_list' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page": 0,
    "pageSize": 0,
    "filter": {
        "match": "string",
        "id": "string",
        "gid": "string",
        "device": 0
    },
    "order": "+id"
}'

返回响应

🟢200成功

application/json

Body

code

number

错误码

必需

msg

string

结果描述

必需

pageInfo

object (pageInfo)

分页结果信息

可选

page

number

分页,从零开始

必需

pageSize

number

分页大小

必需

totalCount

number

条目总数

必需

data

array [object {12}]

用户设备列表

可选

id

string

用户ID

必需

gid

string

所属组ID

必需

name

string

用户名称

必需

deviceID

string

设备ID

可选

deviceName

string

设备名称

可选

ipid

number

登录标识

必需

addr

string

地址信息

必需

onlineTime

string

上线时间

必需

classID

number

设备分类

可选

className

string

分类名称

可选

channels

array[object (channel) {4}]

通道列表

可选

gps

object (gps_time)

上报或设置的位置

可选

示例

{
    "code": 0,
    "msg": "string",
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "totalCount": 0
    },
    "data": [
        {
            "id": "string",
            "gid": "string",
            "name": "string",
            "deviceID": "string",
            "deviceName": "string",
            "ipid": 0,
            "addr": "string",
            "onlineTime": "string",
            "classID": 0,
            "className": "string",
            "channels": [
                {
                    "index": 0,
                    "mediaDir": 1,
                    "ptz": 0,
                    "name": "string"
                }
            ],
            "gps": {
                "lng": 0,
                "lat": 0,
                "time": 0
            }
        }
    ]
}