- 快速入门
- 开发指南
- API
- 认证
- 首页
- 会话控制
- 虚拟会议室
- 历史会议管理
- 会议管理
- 组织架构管理
- 企业设置
- 员工信息
- 资产设备信息
- 会议模 版管理
- 数据统计
- 系统报告
- 管理员日志
- 终端分组管理
- 录制文件管理
- 运维工具
- 呼叫
- 端口监听
- 服务区管理
- 服务器管理
- 终端管理
- 数据平台
获取会话详情
GET
/rsc/api/v2/user/sessions/{sessionId}
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token示例:
Authorization: Bearer ********************
Path 参数
sessionId
string
会话 id
示例值:
{{sessionId}}
Header 参数
x-endpoint-id
string
操作人端点Id
示例值:
{{endpointId}}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/rsc/api/v2/user/sessions/{{sessionId}}' \
--header 'x-endpoint-id: {{endpointId}}'
返回响应
🟢200成功
application/json
Body
会话详情
id
string | null
会话 id
code
string | null
会议号
topic
string | null
会议主题
duration
integer | null
会议时长
password
string | null
会议密码
activated
boolean | null
必需
createdTime
string | null
会议创建时间
updatedTime
string | null
会议更新时间
owner
会议组织者信息
Any of
userId
string | null
用户 id
deviceId
string | null
设备 id
companyId
string | null
企业 id
layout
会议布局
Any of
id
string | null
会话布局 id
content
string | null
会话布局内容
virtualRoom
云会议室信息
Any of
isUsed
boolean | null
必需
id
string <int64> | null
云会议室id
code
string | null
会议号
name
string | null
会议室名称
password
string | null
必需
见 TSMB-5634 安卓手机端取这个路径下的密码
type
enum<integer> | enum<null>
必需
枚举值:
123
option
会议室设置
uid
string | null
用户id
uidType
enum<integer> | enum<null>
设备id
枚举值:
0123
companyId
string | null
企业id
venues
array[object (MeetingVenueResponse) {8}]
会场列表
mediaCapabilityOptions
array[object (MediaCapabilityOptionForm) {3}] | null
会话媒体功能选项
title
string
可选
alias
string
可选
options
array[object (Option) {2}]
可选
options
会议选项
Any of
locked
boolean | null
是否锁定会议
unmuteSelfEnabled
boolean | null
必需
allowSelfChangeNickname
boolean | null
必需
muted
boolean | null
必需
「已废弃」
whiteBoardOption
enum<integer> | enum<null>
必需
枚举值:
01
shareOption
enum<integer> | enum<null>
共享设置
枚举值:
01
markOption
enum<integer> | enum<null>
批注设置
枚举值:
01
turnOnVideoSelfEnabled
boolean | null
必需
autoMuteType
enum<integer> | enum<null>
必需
枚举值:
012
endpointStatusUpdateNoticeType
enum<integer> | enum<null>
必需
枚举值:
012
voiceActivationEnabled
boolean | null
必需
mode
会议模式
Any of
viewState
enum<string> | enum<null>
必需
枚举值:
VIDEOSHAREWHITE_BOARD
presenter
string | null
可选
state
enum<integer> | enum<null>
必需
枚举值:
012
settings
会议模式选项
mainVenueId
string | null
可选
recordInfo
录制状态
Any of
status
enum<integer> | enum<null>
必需
枚举值:
1234
advancedFeatures
高级功能
Any of
whiteboardType
string | null
白板类型
endpoints
object (EndpointPageResponse)
会中端点信息
total
integer | null
必需
hasMore
boolean | null
是否还有更多的数据
nextPageFirstJoinTime
string <int64> | null
必需
data
array[object (EndpointResponse) {26}] | null
成员列表
示例
{
"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
}
]
}
}