- 快速入门
- 开发指南
- API
- 认证
- 首页
- 会话控制
- 虚拟会议室
- 历史会议管理
- 会议管理
- 组织架构管理
- 企业设置
- 员工信息
- 资产设备信息
- 会议模 版管理
- 数据统计
- 系统报告
- 管理员日志
- 终端分组管理
- 录制文件管理
- 运维工具
- 呼叫
- 端口监听
- 服务区管理
- 服务器管理
- 终端管理
- 数据平台
根据会议号查询端点和会话信息
GET
/rsc/api/v2/user/sessions/endpoint
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token示例:
Authorization: Bearer ********************
Query 参数
code
string
会议号
示例值:
{{code}}
示例代码
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/endpoint?code={{code}}'
返回响应
🟢200成功
application/json
Body
端点和会话详情
endpoint
端点信息
Any of
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
是否重新入会
id
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>
必需
枚举值:
01
layoutLocked
boolean | null
锁定视频源
audioGain
integer | null
必需
session
会话信息
Any of
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
会议组织者信息
layout
会议布局
virtualRoom
云会议室信息
mediaCapabilityOptions
array[object (MediaCapabilityOptionForm) {3}] | null
会话媒体功能选项
options
会议选项
mode
会议模式
mainVenueId
string | null
可选
recordInfo
录制状态
advancedFeatures
高级功能
endpoints
object
EndpointPageResponse
示例
{
"endpoint": {
"nickname": "",
"avatar": "",
"isMaster": false,
"isAudioMute": false,
"isVideoMute": false,
"isSpeakRequest": false,
"isSpeakerMute": false,
"isLocalRecording": false,
"isRejoin": false,
"id": "",
"userId": "",
"deviceId": "",
"createdTime": "",
"updatedTime": "",
"lastJoinTime": "",
"mediaOpts": {
"audiossrc": "",
"videossrc": [
""
],
"sharessrc": "",
"extState": {}
},
"role": {
"type": 0,
"reason": 0,
"updatedTime": "",
"permissions": [
""
],
"from": {
"endpointId": "",
"userId": "",
"deviceId": ""
}
},
"permissions": [
""
],
"speakRequestTime": "",
"osType": "",
"platformType": "",
"identifier": "",
"multiStreamInfo": {},
"displayStatus": 0,
"layoutLocked": false,
"audioGain": 0,
"state": 0
},
"session": {
"id": "",
"code": "",
"topic": "",
"duration": 0,
"password": "",
"activated": false,
"createdTime": "",
"updatedTime": "",
"owner": {
"userId": "",
"deviceId": "",
"companyId": ""
},
"layout": {
"id": "",
"content": ""
},
"virtualRoom": {
"isUsed": false,
"id": "",
"code": "",
"name": "",
"password": "",
"type": 0,
"option": {
"allowJoinBeforeMaster": false,
"password": "",
"autoMuteType": 0,
"autoCallEnabled": false,
"autoRecordEnabled": false,
"recordLayoutMode": 0,
"recordLayoutTemplate": "",
"bannerEnabled": false,
"bannerInfo": {},
"mediaCapabilityOptions": {
"bitRate": "",
"mediaCrypto": "",
"frameRate": "",
"videoResolution": "",
"videoCodecs": "",
"audioCodecs": "",
"auxiliaryStreamBandwidthWeight": ""
},
"applyMasterEnabled": false,
"masterPassword": "",
"masterPasswordTimes": 0,
"maxEndpointCount": 0,
"joinPermissionRangeType": 0,
"layoutOptions": [
{
"apply": false,
"type": 0,
"content": "",
"index": 0
}
],
"waitingRoomEnabled": false,
"watermarkEnabled": false
},
"uid": "",
"uidType": 0,
"companyId": "",
"venues": [
{
"uid": "",
"uidType": 0,
"displayName": "",
"identifier": "",
"accessType": "",
"groupName": "",
"groupId": "",
"companyId": ""
}
]
},
"mediaCapabilityOptions": [
{
"title": "",
"alias": "",
"options": [
{
"name": "",
"value": ""
}
]
}
],
"options": {
"locked": false,
"unmuteSelfEnabled": false,
"allowSelfChangeNickname": false,
"muted": false,
"whiteBoardOption": 0,
"shareOption": 0,
"markOption": 0,
"turnOnVideoSelfEnabled": false,
"autoMuteType": 0,
"endpointStatusUpdateNoticeType": 0,
"voiceActivationEnabled": false,
"waitingRoomEnabled": false,
"watermarkEnabled": false
},
"mode": {
"viewState": "",
"presenter": "",
"state": 0,
"settings": {
"requireWatermark": false
}
},
"mainVenueId": "",
"recordInfo": {
"status": 0
},
"advancedFeatures": {
"whiteboardType": ""
},
"endpoints": {
"total": 0,
"hasMore": false,
"nextPageFirstJoinTime": "",
"data": [
{
"nickname": "",
"avatar": "",
"isMaster": false,
"isAudioMute": false,
"isVideoMute": false,
"isSpeakRequest": false,
"isSpeakerMute": false,
"isLocalRecording": false,
"isRejoin": false,
"id": "",
"userId": "",
"deviceId": "",
"createdTime": "",
"updatedTime": "",
"lastJoinTime": "",
"mediaOpts": {
"audiossrc": "",
"videossrc": [
""
],
"sharessrc": "",
"extState": {}
},
"role": {
"type": 0,
"reason": 0,
"updatedTime": "",
"permissions": [
""
],
"from": {
"endpointId": "",
"userId": "",
"deviceId": ""
}
},
"permissions": [
""
],
"speakRequestTime": "",
"osType": "",
"platformType": "",
"identifier": "",
"multiStreamInfo": {},
"displayStatus": 0,
"layoutLocked": false,
"audioGain": 0,
"state": 0
}
]
}
}
}