开启加入会话

POST

/session/start/join

请求参数

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

协作ID

必需

sessionID

string

会话ID

可选

userID

string

用户ID

必需

deviceType

integer

用户设备类型

可选

userIDs

array[string]

指定通知的成员

可选

extra

string

会话附加信息

可选

示例

{
    "collaborationID": "string",
    "sessionID": "string",
    "userID": "string",
    "deviceType": 0,
    "userIDs": [
        "string"
    ],
    "extra": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/session/start/join' \
--header 'Content-Type: application/json' \
--data-raw '{
    "collaborationID": "string",
    "sessionID": "string",
    "userID": "string",
    "deviceType": 0,
    "userIDs": [
        "string"
    ],
    "extra": "string"
}'

返回响应

🟢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.StartSessionResp",
        "info": {
            "collaborationID": "36fa64f51bc547789d14c6f333f861f7",
            "state": "COLLABORATION_START",
            "sessionInfo": {
                "sessionID": "32b74604d82c4dceaa1fa357ab5ca3b1",
                "sessionState": "SESSION_GOING",
                "beginTime": "1656661695",
                "endTime": "0",
                "tools": [],
                "starterID": "user01",
                "extra": "",
                "recordState": "RECORD_STATE_UNSPECIFIED"
            },
            "members": {
                "user01": {
                    "userID": "user01",
                    "confirmState": "CONFIRM_UNSPECIFIED",
                    "memberSessionState": "MEMBER_TALKING",
                    "medias": [],
                    "tools": [],
                    "roles": [
                        1
                    ],
                    "deviceType": 2,
                    "seqID": "113",
                    "extra": ""
                },
                "user02": {
                    "userID": "user02",
                    "confirmState": "CONFIRM_UNSPECIFIED",
                    "memberSessionState": "MEMBER_CALLING",
                    "medias": [],
                    "tools": [],
                    "roles": [],
                    "deviceType": 0,
                    "seqID": "111",
                    "extra": ""
                },
                "user03": {
                    "userID": "user03",
                    "confirmState": "CONFIRM_UNSPECIFIED",
                    "memberSessionState": "MEMBER_UNSPECIFIED",
                    "medias": [],
                    "tools": [],
                    "roles": [],
                    "deviceType": 0,
                    "seqID": "112",
                    "extra": ""
                }
            },
            "detail": "test theme",
            "hasMessage": false,
            "hasFile": false,
            "creatorID": "user01",
            "appID": "hileia_core",
            "settings": {
                "stopControl": "STOP_MANUAL",
                "closeControl": "CLOSE_MANUAL",
                "isMuteIn": true,
                "isCameraOffIn": true,
                "autoRecord": true
            }
        }
    }
}

修改于 2023-07-04 09:22:46

开启会话

会话踢出