按成员查询协作
POST
/user/query
服务端接口/协作
请求参数
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
userID
string
用户ID
beginTime
integer
查询开始时间
endTime
integer
查询结束时间
limit
integer
查询数量限制
offset
integer
查询偏移量
history
boolean
是否查询历史数据
示例
{
"userID": "string",
"beginTime": 0,
"endTime": 0,
"limit": 0,
"offset": 0,
"history": true
}示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/user/query' \
--header 'Content-Type: application/json' \
--data-raw '{
"userID": "string",
"beginTime": 0,
"endTime": 0,
"limit": 0,
"offset": 0,
"history": true
}'返回响应
🟢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
}
}
]
}
}修改于 2023-07-04 09:22:46