加入协作 - HiAR文档中心

请求参数

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

collaborationID

string

必需

member

object

必需

userID

string

用户ID

必需

confirmState

enum<string>

参加确认状态

必需

枚举值:

CONFIRM_ACCEPTCONFIRM_REJECT

memberSessionState

enum<string>

会话中成员状态

必需

枚举值:

MEMBER_CALLINGMEMBER_TALKINGMEMBER_LEFTMEMBER_TIMEOUTMEMBER_BUSYMEMBER_OFFLINEMEMBER_KICKOUTMEMBER_DECLINE

medias

array[integer]

用户媒体设备

必需

tools

array[object (协作工具) {3}]

用户协作工具

必需

roles

array[integer]

角色列表

必需

deviceType

integer

设备类型

必需

seqID

integer

媒体ID

必需

用于加入媒体引擎的UserID

extra

string

业务附加信息

必需

示例

{
    "collaborationID": "0d0a155b356c41859f980dd56c4cfc96",
    "member": {
        "userID": "user02",
        "confirmState": "CONFIRM_ACCEPT"
    }
}

示例代码

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

必需

info

object

协作信息

必需

示例

{
    "code": 0,
    "message": "",
    "data": {
        "@type": "type.googleapis.com/hileia_core_collaboration.v1.JoinResp",
        "info": {
            "collaborationID": "f1fe8ecdc0a3481a8cb84bee63204965",
            "state": "COLLABORATION_START",
            "sessionInfo": {
                "sessionID": "c3d6cd1519e54ed0a64741b4bed83ac2",
                "sessionState": "SESSION_SCHEDULE",
                "beginTime": "1656730800",
                "endTime": "1656734400",
                "tools": [],
                "starterID": "",
                "extra": "",
                "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_ACCEPT",
                    "memberSessionState": "MEMBER_UNSPECIFIED",
                    "medias": [],
                    "tools": [],
                    "roles": [],
                    "deviceType": 0,
                    "seqID": "110",
                    "extra": ""
                },
                "user03": {
                    "userID": "user03",
                    "confirmState": "CONFIRM_UNSPECIFIED",
                    "memberSessionState": "MEMBER_UNSPECIFIED",
                    "medias": [],
                    "tools": [],
                    "roles": [],
                    "deviceType": 0,
                    "seqID": "105",
                    "extra": ""
                },
                "user04": {
                    "userID": "user04",
                    "confirmState": "CONFIRM_UNSPECIFIED",
                    "memberSessionState": "MEMBER_UNSPECIFIED",
                    "medias": [],
                    "tools": [],
                    "roles": [],
                    "deviceType": 0,
                    "seqID": "109",
                    "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
            }
        }
    }
}