HiAR文档中心
  1. 协作
HiAR文档中心
  • HiAR开放平台
  • HiAR能力地图
  • 新手开发指南
    • 第一步、创建应用
    • 第二步、能力签约
    • 第三步、API调用
      • API接入说明
      • SDK接入说明
  • 虚实映射层
    • AR算法、对象识别等
    • HRS数据相关
  • 空间构建层
    • 地图服务
      • 高程服务
        • 产品介绍
        • 接入指南
        • API列表
          • 获取当前经纬度的高度
          • 获取选择范围内的高程信息
      • 瓦片服务
        • 产品介绍
        • 接入指南
        • API列表
          • 获取地图瓦片展示相关参数
    • SpaceCore
  • 虚实交互层
    • 设备内参服务
      • 产品介绍
      • 接入指南
      • API列表
        • 添加设备内参
        • 根据id获取设备内参
        • 批量查询设备内参
        • 修改设备内参
        • 删除设备内参
    • H100 SDK
  • 通信协作层
    • Toolkit OpenAPI
      • 服务端接口
        • 协作
          • 查询需要订阅协作
            GET
          • 退出协作
            POST
          • 关闭协作
            POST
          • 获取全量信息
            GET
          • 取消协作
            POST
          • 确认协作
            POST
          • 删除成员
            POST
          • 按成员查询协作
            POST
          • 查询协作
            POST
          • 添加成员
            POST
          • 加入协作
            POST
          • 更新协作
            POST
          • 创建协作
            POST
          • 设备退出
            POST
          • 设备加入
            POST
        • 会话
          • 会话中邀请
          • 离开会话
          • 心跳
          • 会话邀请应答
          • 加入会话
          • 开启会话
          • 开启加入会话
          • 会话踢出
          • 结束会话
        • 媒体和消息
          • 变更成员媒体设备
          • 批量打开成员媒体设备
          • 批量关闭成员媒体设备
          • 变更全局协作工具
          • 发送消息
          • 查询消息
          • 变更成员协作工具
        • 角色
          • 删除角色
          • 添加角色
          • 转移角色
          • 申请角色
          • 响应角色申请
        • 附件
          • 删除附件
          • 添加附件
          • 查询附件
          • 更新附件
        • 录制和通话记录
          • 开启录制
          • 停止录制
          • 设置合成视频画面布局
          • 标注事件
          • 获取直播地址
          • 根据协作ID查询协作记录
          • 根据AppID查询协作记录
          • 获取操作记录
          • 根据用户查询协作记录
          • 根据附加信息查询协作记录
        • 安全校验
          • 获取声网鉴权token
          • 获取token
          • 查询用户在线状态
        • 消息服务
          • 发送消息
          • 发送请求消息
          • 发送响应消息
  • 空间能力层
    • 亮眼AR套件
      • 产品介绍
      • 接入指南
      • Demo及说明
      • Android接入
      • Windows接入
    • Pinnotes
  • 现实应用层
    • 人员管理服务
      • 产品介绍
      • 接入指南
      • 常见问题
      • 人员管理服务产品介绍
      • API列表
        • 查询人员列表
        • 新增成员
        • 移除人员
        • 根据ID查询人员信息
        • 编辑人员信息
    • 安防行业数据同步服务
    • 小程序插件
      • 亮风台 HRS 预览小程序插件
  • 常见Q&A
    • 错误码
  1. 协作

查询协作

POST
/query
服务端接口/协作
通过协作ID查询协作信息,支持批量查询。
grpc 接口:rpc Query(QueryReq) returns (QueryResp)

请求参数

Header 参数
trace
string 
可选
示例值:
{% mock 'string' , 'abcdefghijklmnopqrstuvwxyz1234567890' , 10 , 10 %}
appid
string 
可选
示例值:
{{appid}}
X-HIAR-OPENAPI-APPID
string 
可选
示例值:
{{appid}}
X-HIAR-OPENAPI-Nonce
string 
可选
示例值:
{{openapi-nonce}}
X-HIAR-OPENAPI-DATE
string 
可选
示例值:
{{openapi-date}}
X-HIAR-OPENAPI-SIGNATURE
string 
可选
示例值:
{{openapi-signature}}
Body 参数application/json
ids
array[string]
协作ID列表
必需
示例
{
    "ids": [
        "string"
    ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/query' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ids": [
        "string"
    ]
}'

返回响应

🟢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.QueryResp",
        "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
                }
            }
        ]
    }
}
上一页
按成员查询协作
下一页
添加成员
Built with