获取企业指定当前正在召开的会议的详细信息(包含参会方质量、当前会议质量)。
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/currentMeeting/{conferenceNumber}/detail?enterpriseId=XXX&needQuality=false&pageIndex=XXX&pageSize=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | |
signature | String | Query | 签名鉴权2.0:否 | 无 | API签名,参见签名规则 | |
needQuality | boolean | Query | 否 | false | 是否需要返回整体会议质量结果 | 3.9 |
conferenceNumber | String | Path | 是 | 无 | 云会议室号 | 3.9 |
pageIndex | int | Query | 否 | 0 | 页码,从0开始 | 5.2 |
pageSize | int | Query | 否 | 20 | 每页查询数量,最大50 | 5.2 |
注: 长时间未调用该api时的第一次调用视为订阅,api返回结果的某些字段为null,延迟5s后再次调用视为正常访问,所有字段正常返回。
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"meetingRoomNumber": "9000123456",
"meetingName": "小鱼的云会议室",
"startTime": 1529376322457,
"recording": true,
"recordStartTime": 1542361749643,
"participantCount": 1,
"participants": [
{
"participantId": "100121036",
"participantDeviceType": "TVBOX",
"joinTimeBegin": 1529376322456,
"joinTimeEnd": -1,
"callId": "xxxxxxx",
"displayName": "小鱼呼叫设备",
"callNumber": "637037",
"quality": {
"videoQuality": {
"videoSendLost": 0,
"videoRecvLost": 0,
"videoDownLinkBw": 0,
"videoUpLinkBw": 2648,
"videoSendJitter": 1,
"videoRecvJitter": 0,
"videoSendRtt": 0,
"videoSendFrameRate": 0,
"videoSendResolution": null,
"videoRecvFrameRate": 0,
"videoRecvResolution": null
},
"audioQuality": {
"audioRecvLost": 0,
"audioSendLost": 0,
"audioDownLinkBw": 28,
"audioUpLinkBw": 71,
"audioSendJitter": 0,
"audioSendRtt": 0
}
},
"contentQuality": {
"videoSendQuality": "xxxxxx",
"videoReceQuality": "xxxxxx",
"andioUpLinkBw": "xxxxxx",
"videoUpLinkBw": "xxxxxx",
"andioDownLinkBw": "xxxxxx",
"andioDownLinkBw": "xxxxxx"
},
"bwUpLink": 100,
"bwDownLink": 100,
"bwDownLinkExpect": 100,
"bwUpLinkExpect": 100,
"peopleRadioScore": 1,
"peopleVideoScore": 1,
"netTag": 1
}
],
"quality": {
"audioCurrentScore": 100,
"videoCurrentScore": -1,
"callCollectionPoorNum": -2,
"peopleRadioScore": 1,
"peopleVideoScore": 0,
"contentVideoScore": 0,
"meetingScore": 1,
"audioScore": -2,
"videoScore": -2,
"score": -2
},
"meetingId": "xxxxxx",
"page": 0,
"pageTotal": 1,
"rowsTotal": 1,
"rows": 1
}
返回参数说明
参数 | 说明 | 初始平台 |
page | 当前页 | all |
pageTotal | 总页数 | all |
rowsTotal | 总条数 | all |
rows | 当前页的条数 | all |
meetingRoomNumber | 云会议号 | all |
meetingName | 会议名称 | all |
startTime | 会议开始时间,Unix时间戳(毫秒数) | all |
participantCount | 当前参会人数 | all |
recording | 是否在录制中 | all |
recordStartTime | 开始录制时间 | all |
meetingId | 会议id | all |
participants | 参会端列表 | all |
└participantId | 参会端ID | all |
└participantDeviceType | all | |
└joinTimeBegin | 参会端入会时间 | all |
└joinTimeEnd | 参会端出会时间 | all |
└callId | 参会端呼叫ID(不必关心) | all |
└displayName | 参会端名称 | all |
└callNumber | 参会端呼叫号码 | all |
└quality | 参会端质量信息 | all |
└└videoQuality | 会议视频质量 | all |
└└└ videoSendLost | 视频发送丢包率 | all |
└└└ videoRecvLost | 视频接收丢包率 | all |
└└└ videoDownLinkBw | 视频下行带宽(单位kbit/s) | all |
└└└ videoUpLinkBw | 视频上行带宽(单位kbit/s) | all |
└└└ videoSendJitter | 视频发送抖动(单位10ms) | all |
└└└ videoRecvJitter | 视频接收抖动(单位10ms) | all |
└└└ videoSendRtt | 视频发送往返时延(单位10ms) | all |
└└└ videoSendFrameRate | 视频发送帧率(0-60) | all |
└└└ videoSendResolution | 视频发送分辨率(180p, 360p, 720p,1080p) | all |
└└└ videoRecvFrameRate | 视频接收帧率 | all |
└└audioQuality | 会议音频质量 | all |
└└└ audioSendLost | 音频发送丢包率 | all |
└└└ audioRecvLost | 音频接收丢包率 | all |
└└└ audioDownLinkBw | 音频下行带宽(单位kbit/s) | all |
└└└ audioUpLinkBw | 音频上行带宽(单位kbit/s) | all |
└└└ audioSendJitter | 音频发送抖动(单位10ms) | all |
└└└ audioSendRtt | 音频发送延迟(单位10ms) | all |
└└bwUpLink | 可用上行带宽(单位kbps) | all |
└└bwDownLink | 可用下行带宽(单位kbps) | all |
└└bwUpLinkExpect | 期望上行带宽(单位kbps) | all |
└└bwDownLinkExpect | 期望下行带宽(单位kbps) | all |
└└peopleRadioScore | 音频质量(0-无意义的值,1-优, 2-良, 3-中, 4-差) | 5.2(2025-0328) |
└└peopleVideoScore | 视频质量(0-无意义的值,1-优, 2-良, 3-中, 4-差) | 5.2(2025-0328) |
└└netTag | 网络质量(0-无意义的值,1-优, 2-良, 3-中, 4-差) | 5.2(2025-0328) |
quality(外层) | 整体会议质量,表示整个会议的质量 | all |
└meetingId | 会议ID | all |
└audioCurrentScore | 会议当前音频分数 | all |
└videoCurrentScore | 会议当前视频分数 | all |
└peopleRadioScore | 人像音频等级 | all |
└peopleVideoScore | 人像视频等级 | all |
└contentVideoScore | 共享视频等级 | all |
└meetingScore | 会议质量等级 | all |
└callCollectionPoorNum | 弃用字段 | all |
└audioScore | 弃用字段, 推荐使用同级参数audioCurrentScore | all |
└videoScore | 弃用字段, 推荐使用同级参数videoCurrentScore | all |
└score | 弃用字段, 推荐使用同级参数meetingScore | all |
contentQuality | 共享内容质量 | 5.2(2023-0329) |
└ videoSendQuality | 视频发送分辨率/帧率 | 5.2(2023-0329) |
└ videoReceQuality | 视频接受分辨率/帧率 | 5.2(2023-0329) |
└ andioUpLinkBw | 码率: 音频可用上行带宽 | 5.2(2023-0329) |
└ videoUpLinkBw | 码率: 视频可用上行带宽 | 5.2(2023-0329) |
└ andioDownLinkBw | 码率: 音频可用下行带宽 | 5.2(2023-0329) |
└ andioDownLinkBw | 码率: 视频可用下行带宽 | 5.2(2023-0329) |