会话中邀请

POST

/session/invite

服务端接口/会话

请求参数

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

邀请者

必需

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

业务附加信息

必需

示例

{
  "collaborationID": "string",
  "sessionID": "string",
  "userID": "string",
  "members": [
    {
      "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"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/session/invite' \
--header 'Content-Type: application/json' \
--data-raw '{
    "collaborationID": "string",
    "sessionID": "string",
    "userID": "string",
    "members": [
        {
            "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"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object | null

必需

@type

string

必需

value

object

必需

示例

{
  "code": 0,
  "message": "",
  "data": {
    "@type": "type.googleapis.com/google.protobuf.Empty",
    "value": {}
  }
}

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

设备加入

离开会话