更新协作 - 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

协作ID

必需

userID

string

用户ID

必需

detail

string

协作详细信息

可选

不修改的话可以传空

sessionID

string

会话ID

必需

beginTime

integer

预约会话开始时间

可选

不修改的话可以传空

endTime

integer

预约会话结束时间

可选

不修改的话可以传空

extra

string

会话附加信息

可选

不修改的话可以传空

addMembers

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

业务附加信息

必需

deleteUserIDs

array[string]

删除用户ID列表

可选

没有可以为空

示例

{
  "collaborationID": "string",
  "userID": "string",
  "detail": "string",
  "sessionID": "string",
  "beginTime": 0,
  "endTime": 0,
  "extra": "string",
  "addMembers": [
    {
      "userID": "string",
      "confirmState": "CONFIRM_ACCEPT",
      "memberSessionState": "MEMBER_CALLING",
      "medias": [
        0
      ],
      "tools": [
        {
          "kind": 0,
          "extra": "string",
          "userID": "string"
        }
      ],
      "roles": [
        0
      ],
      "deviceType": 0,
      "seqID": 0,
      "extra": "string"
    }
  ],
  "deleteUserIDs": [
    "string"
  ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/update' \
--header 'Content-Type: application/json' \
--data-raw '{
    "collaborationID": "string",
    "userID": "string",
    "detail": "string",
    "sessionID": "string",
    "beginTime": 0,
    "endTime": 0,
    "extra": "string",
    "addMembers": [
        {
            "userID": "string",
            "confirmState": "CONFIRM_ACCEPT",
            "memberSessionState": "MEMBER_CALLING",
            "medias": [
                0
            ],
            "tools": [
                {
                    "kind": 0,
                    "extra": "string",
                    "userID": "string"
                }
            ],
            "roles": [
                0
            ],
            "deviceType": 0,
            "seqID": 0,
            "extra": "string"
        }
    ],
    "deleteUserIDs": [
        "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.UpdateResp",
    "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": ""
        },
        "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 theme",
      "hasMessage": false,
      "hasFile": false,
      "creatorID": "user01",
      "appID": "hileia_core",
      "settings": {
        "stopControl": "STOP_ZERO",
        "closeControl": "CLOSE_AUTO",
        "isMuteIn": true,
        "isCameraOffIn": true,
        "autoRecord": true
      }
    }
  }
}