按成员查询协作 - HiAR文档中心

根据用户 ID 查询和该用户相关的所有协作。查询结果按会话开始时间逆序排序。

grpc 接口：rpc QueryByUser(QueryByUserReq) returns (QueryByUserResp)

请求参数

Header 参数

trace

string

可选

示例值:

{% mock 'string' , 'abcdefghijklmnopqrstuvwxyz1234567890' , 10 , 10 %}

appid

string

可选

示例值:

X-HIAR-OPENAPI-APPID

string

可选

示例值:

X-HIAR-OPENAPI-Nonce

string

可选

示例值:

X-HIAR-OPENAPI-DATE

string

可选

示例值:

X-HIAR-OPENAPI-SIGNATURE

string

可选

示例值:

Body 参数application/json

userID

string

用户ID

必需

beginTime

integer

查询开始时间

可选

秒为单位的时间戳

endTime

integer

查询结束时间

可选

秒为单位的时间戳

limit

integer

查询数量限制

可选

默认10

offset

integer

查询偏移量

可选

history

boolean

是否查询历史数据

可选

示例

{
    "userID": "string",
    "beginTime": 0,
    "endTime": 0,
    "limit": 0,
    "offset": 0,
    "history": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object | null

必需

@type

string

必需

infos

array[object (协作信息) {10}]

协作信息列表

必需

示例

{
    "code": 0,
    "message": "",
    "data": {
        "@type": "type.googleapis.com/hileia_core_collaboration.v1.QueryByUserResp",
        "infos": [
            {
                "collaborationID": "f1fe8ecdc0a3481a8cb84bee63204965",
                "state": "COLLABORATION_START",
                "sessionInfo": {
                    "sessionID": "c3d6cd1519e54ed0a64741b4bed83ac2",
                    "sessionState": "SESSION_SCHEDULE",
                    "beginTime": "1688180400",
                    "endTime": "1688184000",
                    "tools": [],
                    "starterID": "",
                    "extra": "media configs",
                    "recordState": "RECORD_STATE_UNSPECIFIED"
                },
                "members": {
                    "user01": {
                        "userID": "user01",
                        "confirmState": "CONFIRM_ACCEPT",
                        "memberSessionState": "MEMBER_UNSPECIFIED",
                        "medias": [],
                        "tools": [],
                        "roles": [
                            1
                        ],
                        "deviceType": 0,
                        "seqID": "103",
                        "extra": ""
                    },
                    "user02": {
                        "userID": "user02",
                        "confirmState": "CONFIRM_UNSPECIFIED",
                        "memberSessionState": "MEMBER_UNSPECIFIED",
                        "medias": [],
                        "tools": [],
                        "roles": [],
                        "deviceType": 0,
                        "seqID": "104",
                        "extra": ""
                    },
                    "user03": {
                        "userID": "user03",
                        "confirmState": "CONFIRM_UNSPECIFIED",
                        "memberSessionState": "MEMBER_UNSPECIFIED",
                        "medias": [],
                        "tools": [],
                        "roles": [],
                        "deviceType": 0,
                        "seqID": "105",
                        "extra": ""
                    }
                },
                "detail": "test theme1",
                "hasMessage": false,
                "hasFile": false,
                "creatorID": "user01",
                "appID": "hileia_core",
                "settings": {
                    "stopControl": "STOP_ZERO",
                    "closeControl": "CLOSE_AUTO",
                    "isMuteIn": true,
                    "isCameraOffIn": true,
                    "autoRecord": true
                }
            }
        ]
    }
}