加入会话

POST

/rsc/api/v2/user/sessions/actions/join

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

x-endpoint-id

string

操作人端点Id

必需

Body 参数application/json

sessionInfo

会话信息

必需

Any of

SessionInfoForm

null

topic

string | null

会议主题

可选

<= 30 字符

code

string | null

可选

会议号,创建会议的时候，该字段为 null

password

string | null

会议密码

可选

mediaOpts

媒体参数

必需

Any of

EndpointMediaOptsForm

null

isVideoMute

boolean | null

是否关闭视频

必需

默认值:

true

isAudioMute

boolean | null

是否静音

必需

默认值:

true

endpointInfo

端点信息

必需

Any of

EndpointInfoForm

null

nickname

string | null

成员昵称

必需

<= 100 字符

headImage

string | null

成员头像链接

必需

<= 255 字符

deviceSn

string | null

设备的 sn 号

必需

<= 128 字符

默认值:

UUID.randomUUID().toString()

endpointId

string | null

可选

端点id，UUID格式，目前该字段仅用于sip设备的IVR入会

extState

可选

加入端点的自定义状态

deviceId

string

设备id

可选

accessType

enum<string>

接入类型

可选

枚举值:

未知SVCH.323SIP

默认值:

{value: SVC}

context

端点入会的上下文

可选

Any of

EndpointJoinContextForm

null

callId

string | null

呼叫记录id

可选

returnEndpointSize

integer

返回的端点数量

可选

>= 0<= 1000

默认值:

示例

{
    "sessionInfo": {
        "topic": "string",
        "code": "string",
        "password": "string"
    },
    "mediaOpts": {
        "isVideoMute": true,
        "isAudioMute": true
    },
    "endpointInfo": {
        "nickname": "string",
        "headImage": "string",
        "deviceSn": "UUID.randomUUID().toString()",
        "endpointId": "string",
        "extState": {},
        "deviceId": "string",
        "accessType": "{value: SVC}"
    },
    "context": {
        "callId": "string"
    },
    "returnEndpointSize": 20
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/rsc/api/v2/user/sessions/actions/join' \
--header 'x-endpoint-id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sessionInfo": {
        "topic": "string",
        "code": "string",
        "password": "string"
    },
    "mediaOpts": {
        "isVideoMute": true,
        "isAudioMute": true
    },
    "endpointInfo": {
        "nickname": "string",
        "headImage": "string",
        "deviceSn": "UUID.randomUUID().toString()",
        "endpointId": "string",
        "extState": {},
        "deviceId": "string",
        "accessType": "{value: SVC}"
    },
    "context": {
        "callId": "string"
    },
    "returnEndpointSize": 20
}'

返回响应

🟢201成功

application/json

Body

端点和会话详情

meetingId

string | null

会议id

必需

sdp

string | null

媒体信息

必需

endpoint

端点信息

必需

Any of

EndpointResponse

null

端点和会话详情

nickname

string | null

昵称

必需

avatar

string | null

头像

必需

isMaster

boolean | null

是否主持人

必需

isAudioMute

boolean | null

是否静音

必需

isVideoMute

boolean | null

是否关闭摄像头

必需

isSpeakRequest

boolean | null

是否举手

必需

isSpeakerMute

boolean | null

是否关闭扬声器

必需

isLocalRecording

boolean | null

是否开启本地录制

必需

isRejoin

boolean | null

是否重新入会

必需

string | null

端点 id

必需

userId

string | null

用户 id

可选

deviceId

string | null

设备 id

可选

createdTime

string | null

创建时间

必需

updatedTime

string | null

更新时间

必需

lastJoinTime

string <int64> | null

最后加入时间

必需

mediaOpts

端点媒体参数

必需

role

端点角色

必需

permissions

array[string] | null

权限列表

必需

speakRequestTime

string | null

举手时间

必需

osType

enum<string> | enum<null>

系统

必需

枚举值:

unknownandroidiosipadosmacoswindowslinux

platformType

enum<string> | enum<null>

平台

必需

枚举值:

unknownmobilepcpadboardmhbrowsersipmcu-sipmcu-h323h323pstnwebvx50

identifier

string | null

账号标识

必需

multiStreamInfo

object | null

多路流信息

可选

displayStatus

enum<integer> | enum<null>

必需

显示状态（0-空闲，1-系统通话中）

枚举值:

layoutLocked

boolean | null

锁定视频源

必需

audioGain

integer | null

必需

音频增益设置，范围为 -20~20，默认值为 0

serverOpts

服务端信息

必需

Any of

EndpointServerOptsResponse

null

端点和会话详情

socketUrl

string | null

socket 地址

必需

socketNsp

string | null

必需

socket 命名空间

dataServer

string | null

数据服务地址

必需

pushUrl

string | null

推流地址

必需

audioPullUrl

string | null

音频拉流地址

必需

session

会话信息

必需

Any of

SessionResponse

null

端点和会话详情

string | null

会话 id

必需

code

string | null

会议号

必需

topic

string | null

会议主题

必需

duration

integer | null

会议时长

必需

password

string | null

会议密码

必需

activated

boolean | null

必需

会议是否激活，true已经激活，false还未激活

createdTime

string | null

会议创建时间

必需

updatedTime

string | null

会议更新时间

必需

owner

会议组织者信息

必需

layout

会议布局

必需

virtualRoom

云会议室信息

必需

mediaCapabilityOptions

array[object (MediaCapabilityOptionForm) {3}] | null

会话媒体功能选项

必需

options

会议选项

必需

mode

会议模式

必需

mainVenueId

string | null

可选

主会场端点 id,没有主会场则为 null

recordInfo

录制状态

必需

advancedFeatures

高级功能

必需

endpoints

object

EndpointPageResponse

可选

端点和会话详情

features

会话高级功能

必需

Any of

SessionAdvancedFeaturesResponse

null

端点和会话详情

whiteboardType

string | null

白板类型

必需

layout

object (LayoutResponse)

会话布局

可选

string | null

id 主键

必需

apply

boolean | null

是否应用中

必需

type

enum<integer>

广播类型

可选

枚举值:

-1012

content

string | null

布局内容

必需

index

integer | null

顺序

必需

createdTime

string | null

创建时间

必需

updatedTime

string | null

更新时间

必需

applyTime

string | null

应用时间

必需

示例

{
  "meetingId": 0,
  "sdp": "",
  "endpoint": {
    "nickname": "",
    "avatar": "",
    "isMaster": false,
    "isAudioMute": false,
    "isVideoMute": false,
    "isSpeakRequest": false,
    "isSpeakerMute": false,
    "isLocalRecording": false,
    "isRejoin": false,
    "id": "",
    "userId": "",
    "deviceId": "",
    "createdTime": "",
    "updatedTime": "",
    "lastJoinTime": 0,
    "mediaOpts": {
      "audiossrc": "",
      "videossrc": [
        ""
      ],
      "sharessrc": "",
      "extState": {}
    },
    "role": {
      "type": 0,
      "reason": 0,
      "updatedTime": "",
      "permissions": [
        ""
      ],
      "from": {
        "endpointId": "",
        "userId": "",
        "deviceId": ""
      }
    },
    "permissions": [
      ""
    ],
    "speakRequestTime": "",
    "osType": "",
    "platformType": "",
    "identifier": "",
    "multiStreamInfo": {},
    "displayStatus": 0,
    "videoSourceLocked": false,
    "audioGain": 0
  },
  "serverOpts": {
    "socketUrl": "",
    "socketNsp": "",
    "dataServer": "",
    "pushUrl": "",
    "audioPullUrl": ""
  },
  "session": {
    "id": "",
    "code": "",
    "topic": "",
    "duration": 0,
    "password": "",
    "activated": false,
    "createdTime": "",
    "updatedTime": "",
    "owner": {
      "userId": "",
      "deviceId": "",
      "companyId": ""
    },
    "layout": {
      "id": "",
      "content": ""
    },
    "virtualRoom": {
      "isUsed": false,
      "id": 0,
      "code": "",
      "name": "",
      "password": "",
      "type": 0,
      "option": {
        "changeNameEnable": false,
        "unmuteSelfEnable": false,
        "muted": false,
        "whiteBoardOption": 0,
        "shareOption": 0,
        "markOption": 0,
        "maxEndpointCount": 0,
        "masterPassword": "",
        "masterPasswordTimes": 0,
        "joinPermissionRange": {
          "type": 0,
          "users": [
            {
              "userId": "",
              "deviceId": "",
              "companyId": "",
              "name": "",
              "identifier": "",
              "type": 0
            }
          ]
        },
        "allowJoinBeforeMaster": false,
        "autoMuteType": 0,
        "recordOption": {
          "autoStartRecord": false
        },
        "autoCallEnabled": false
      },
      "owner": {
        "userId": "",
        "deviceId": "",
        "companyId": ""
      }
    },
    "mediaCapabilityOptions": [
      {
        "alias": "",
        "optionValue": ""
      }
    ],
    "options": {
      "locked": false,
      "unmuteSelfEnabled": false,
      "allowSelfChangeNickname": false,
      "muted": false,
      "whiteBoardOption": 0,
      "shareOption": 0,
      "markOption": 0,
      "turnOnVideoSelfEnabled": false,
      "autoMuteType": 0,
      "endpointStatusUpdateNoticeType": 0,
      "voiceActivationEnabled": false
    },
    "mode": {
      "viewState": "",
      "presenter": "",
      "state": 0,
      "settings": {
        "requireWatermark": false
      }
    },
    "mainVenueId": "",
    "recordInfo": {
      "status": 0
    },
    "advancedFeatures": {
      "whiteboardType": ""
    },
    "endpoints": {
      "total": 0,
      "hasMore": false,
      "nextPageFirstJoinTime": 0,
      "data": [
        {
          "nickname": "",
          "avatar": "",
          "isMaster": false,
          "isAudioMute": false,
          "isVideoMute": false,
          "isSpeakRequest": false,
          "isSpeakerMute": false,
          "isLocalRecording": false,
          "isRejoin": false,
          "id": "",
          "userId": "",
          "deviceId": "",
          "createdTime": "",
          "updatedTime": "",
          "lastJoinTime": 0,
          "mediaOpts": {
            "audiossrc": "",
            "videossrc": [
              ""
            ],
            "sharessrc": "",
            "extState": {}
          },
          "role": {
            "type": 0,
            "reason": 0,
            "updatedTime": "",
            "permissions": [
              ""
            ],
            "from": {
              "endpointId": "",
              "userId": "",
              "deviceId": ""
            }
          },
          "permissions": [
            ""
          ],
          "speakRequestTime": "",
          "osType": "",
          "platformType": "",
          "identifier": "",
          "multiStreamInfo": {},
          "displayStatus": 0,
          "videoSourceLocked": false,
          "audioGain": 0
        }
      ]
    }
  },
  "features": {
    "whiteboardType": ""
  },
  "layout": {
    "id": "",
    "content": ""
  }
}

🟠403开启等候室异常

关闭会话

隐身入会