创建协作 - 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

userID

string

创建者用户ID

必需

beginTime

integer

预约会话开始时间

必需

秒为单位的时间戳

endTime

integer

预约会话结束时间

必需

秒为单位的时间戳

members

array [object {9}]

协作成员列表

必需

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

业务附加信息

必需

detail

string

协作详细信息

可选

根据业务设置（可为JSON字符串）

extra

string

会话附加信息

可选

例如：媒体引擎配置

ruleSettings

object

规则配置

可选

roleRights

array [object {2}]

角色权限控制

可选

roleControl

boolean

是否使用角色控制

可选

numberLimit

integer

人数控制

可选

stopControl

enum<string>

会话停止控制

可选

枚举值:

STOP_ONESTOP_ZEROSTOP_MANUAL

closeControl

enum<string>

协作关闭控制

可选

枚举值:

CLOSE_AUTOCLOSE_MANUAL

mediaControl

object

媒体设备控制

可选

toolControl

object

协作工具控制

可选

confirmControl

boolean

协作确认控制

可选

isMuteIn

boolean

是否进入时静音

可选

isCameraOffIn

boolean

是否进入时关摄像头

可选

autoRecord

boolean

是否自动录制

可选

示例

{
  "userID": "7",
  "endTime": 740877763601,
  "members": [
    {
      "userID": "63",
      "confirmState": "CONFIRM_REJECT",
      "deviceType": 30,
      "roles": [
        38,
        68
      ]
    },
    {
      "userID": "25",
      "confirmState": "CONFIRM_REJECT",
      "deviceType": 34,
      "roles": [
        61,
        76,
        13,
        70
      ]
    },
    {
      "userID": "95",
      "confirmState": "CONFIRM_ACCEPT",
      "roles": [
        73,
        11,
        49,
        12,
        26
      ],
      "deviceType": 81
    },
    {
      "userID": "63",
      "roles": [
        82,
        49,
        84
      ],
      "confirmState": "CONFIRM_ACCEPT",
      "deviceType": 25
    },
    {
      "userID": "86",
      "deviceType": 61,
      "confirmState": "CONFIRM_REJECT",
      "roles": [
        60,
        49,
        40,
        92
      ]
    }
  ],
  "beginTime": 19926238735,
  "detail": "sit in officia incididunt",
  "extra": "sint voluptate nisi amet deserunt",
  "ruleSettings": {
    "stopControl": "STOP_ZERO",
    "isCameraOffIn": false,
    "mediaControl": {
      "audioLimit": 57,
      "audios": [
        60,
        87
      ],
      "videoLimit": 38,
      "mediaSet": [
        70,
        24,
        22,
        91
      ],
      "mutex": [
        {
          "medias": [
            49,
            65,
            42,
            55
          ]
        },
        {
          "medias": [
            66,
            98,
            10
          ]
        }
      ],
      "videos": [
        26,
        48
      ]
    },
    "numberLimit": 79,
    "autoRecord": true,
    "toolControl": {
      "toolSet": [
        43,
        81
      ],
      "mutex": [
        {
          "tools": [
            81,
            20,
            13,
            8,
            29
          ]
        }
      ]
    },
    "isMuteIn": true,
    "roleRights": [
      {
        "role": 33,
        "rights": [
          "RIGHT_CANCE"
        ]
      },
      {
        "role": 14,
        "rights": [
          "RIGHT_AL",
          "RIGHT_STAR",
          "RIGHT_DELETE_MEMBER",
          "RIGHT_KICKOU"
        ]
      }
    ],
    "confirmControl": false,
    "closeControl": "CLOSE_MANUAL",
    "roleControl": true
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userID": "7",
    "endTime": 740877763601,
    "members": [
        {
            "userID": "63",
            "confirmState": "CONFIRM_REJECT",
            "deviceType": 30,
            "roles": [
                38,
                68
            ]
        },
        {
            "userID": "25",
            "confirmState": "CONFIRM_REJECT",
            "deviceType": 34,
            "roles": [
                61,
                76,
                13,
                70
            ]
        },
        {
            "userID": "95",
            "confirmState": "CONFIRM_ACCEPT",
            "roles": [
                73,
                11,
                49,
                12,
                26
            ],
            "deviceType": 81
        },
        {
            "userID": "63",
            "roles": [
                82,
                49,
                84
            ],
            "confirmState": "CONFIRM_ACCEPT",
            "deviceType": 25
        },
        {
            "userID": "86",
            "deviceType": 61,
            "confirmState": "CONFIRM_REJECT",
            "roles": [
                60,
                49,
                40,
                92
            ]
        }
    ],
    "beginTime": 19926238735,
    "detail": "sit in officia incididunt",
    "extra": "sint voluptate nisi amet deserunt",
    "ruleSettings": {
        "stopControl": "STOP_ZERO",
        "isCameraOffIn": false,
        "mediaControl": {
            "audioLimit": 57,
            "audios": [
                60,
                87
            ],
            "videoLimit": 38,
            "mediaSet": [
                70,
                24,
                22,
                91
            ],
            "mutex": [
                {
                    "medias": [
                        49,
                        65,
                        42,
                        55
                    ]
                },
                {
                    "medias": [
                        66,
                        98,
                        10
                    ]
                }
            ],
            "videos": [
                26,
                48
            ]
        },
        "numberLimit": 79,
        "autoRecord": true,
        "toolControl": {
            "toolSet": [
                43,
                81
            ],
            "mutex": [
                {
                    "tools": [
                        81,
                        20,
                        13,
                        8,
                        29
                    ]
                }
            ]
        },
        "isMuteIn": true,
        "roleRights": [
            {
                "role": 33,
                "rights": [
                    "RIGHT_CANCE"
                ]
            },
            {
                "role": 14,
                "rights": [
                    "RIGHT_AL",
                    "RIGHT_STAR",
                    "RIGHT_DELETE_MEMBER",
                    "RIGHT_KICKOU"
                ]
            }
        ],
        "confirmControl": false,
        "closeControl": "CLOSE_MANUAL",
        "roleControl": true
    }
}'

返回响应

🟢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.CreateResp",
    "info": {
      "collaborationID": "f1fe8ecdc0a3481a8cb84bee63204965",
      "state": "COLLABORATION_START",
      "sessionInfo": {
        "sessionID": "c3d6cd1519e54ed0a64741b4bed83ac2",
        "sessionState": "SESSION_SCHEDULE",
        "beginTime": "1688180400",
        "endTime": "1688184000",
        "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_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
      }
    }
  }
}