查询指定会议内指定设备的实时/历史网络质量数据(带宽、丢包率、抖动、分辨率等),用于会议质量监控与诊断。
默认接口请求频率限制:20次/秒。
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/meeting/participant/quality?enterpriseId=XXX&signature=XXX请求参数说明
参数 | 参数类型 | 参数位置 | 是否必须 | 默认值 | 说明 | 初始平台 |
enterpriseId | String | Query | 是 | - | 外部企业 ID(extId)。sdk-server 会用此 ID 解析为内部 enterpriseId,并校验该企业是否拥有目标 meetingId 的访问权限 | 公有云 分区云5.2-20251226 |
meetingId | String | Body | 是 | - | 会议 ID。需为该企业下存在的有效会议 | 公有云 分区云5.2-20251226 |
device | Device | Body | 是 | - | 目标设备信息,详见子表 | 公有云 分区云5.2-20251226 |
└id | Long | Body | 是 | - | 设备 ID。含义随 type 变化:软终端(type=1)= 用户 ID;硬终端(type=2)= 设备 ID;BRUCE(type=7)= 大鱼号 | 公有云 分区云5.2-20251226 |
└type | Integer | Body | 是 | - | 设备类型。取值:1=SOFT 软终端、2=HARD 硬终端、5=DESK 桌面、6=H323、7=BRUCE 大鱼、8=TVBOX、9=SHUTTLE 车载、10=WECHAT 微信、12=PSTN、15=PSTNGW、17=WEBRTC | 公有云 分区云5.2-20251226 |
└participantId | String | Body | 否 | - | 参会者 ID | 公有云 分区云5.2-20251226 |
└externalUserId | String | Body | 否 | - | 外部用户 ID | 公有云 分区云5.2-20251226 |
└participantNumber | String | Body | 否 | - | 参会者号码。H323/PSTN/PSTNGW/SHUTTLE 类型使用 participantNumber 拼装 callUri | 公有云 分区云5.2-20251226 |
请求示例
{
"meetingId": "MEETING-XXXX-XXXX-XXXX",
"device": {
"id": 123456789,
"type": 2,
"participantId": "P-XXXX",
"externalUserId": "EU-XXXX",
"participantNumber": "01012345678"
}
}响应结果示例(HTTP 200)
[
{
"callId": "CALL-XXXX",
"meetingId": "MEETING-XXXX-XXXX-XXXX",
"bwUpLink": 1500,
"bwDownLink": 2500,
"audioRecvLost": 0,
"audioSendLost": 0,
"videoSendLost": 0,
"videoRecvLost": 0,
"audioDownLinkBw": 64,
"videoDownLinkBw": 1500,
"audioUpLinkBw": 64,
"videoUpLinkBw": 1500,
"videoSendJitter": 5,
"videoRecvJitter": 8,
"audioSendJitter": 2,
"audioSendRtt": 30,
"videoSendRtt": 45,
"videoSendQuality": "1280x720_30",
"videoReceiveQuality": "1280x720_30",
"bwDownLinkExpect": 2000,
"bwUpLinkExpect": 1500,
"sessionName": "示例会议",
"timeStamp": 1700000000000,
"netTag": 1
}
]
响应参数说明
参数 | 参数类型 | 说明 | 初始平台 |
callId | String | 呼叫 ID | 公有云存在 分区云5.2-20260928 |
meetingId | String | 会议 ID | 公有云存在 分区云5.2-20260928 |
bwUpLink | Integer | 上行总带宽(kbps) | 公有云存在 分区云5.2-20260928 |
bwDownLink | Integer | 下行总带宽(kbps) | 公有云存在 分区云5.2-20260928 |
audioRecvLost | Integer | 音频接收丢包率(千分比) | 公有云存在 分区云5.2-20260928 |
audioSendLost | Integer | 音频发送丢包率(千分比) | 公有云存在 分区云5.2-20260928 |
videoSendLost | Integer | 视频发送丢包率(千分比) | 公有云存在 分区云5.2-20260928 |
videoRecvLost | Integer | 视频接收丢包率(千分比) | 公有云存在 分区云5.2-20260928 |
audioDownLinkBw | Integer | 音频下行带宽(kbps) | 公有云存在 分区云5.2-20260928 |
videoDownLinkBw | Integer | 视频下行带宽(kbps) | 公有云存在 分区云5.2-20260928 |
audioUpLinkBw | Integer | 音频上行带宽(kbps) | 公有云存在 分区云5.2-20260928 |
videoUpLinkBw | Integer | 视频上行带宽(kbps) | 公有云存在 分区云5.2-20260928 |
videoSendJitter | Integer | 视频发送抖动(ms) | 公有云存在 分区云5.2-20260928 |
videoRecvJitter | Integer | 视频接收抖动(ms) | 公有云存在 分区云5.2-20260928 |
audioSendJitter | Integer | 音频发送抖动(ms) | 公有云存在 分区云5.2-20260928 |
audioSendRtt | Integer | 音频发送往返时延(ms) | 公有云存在 分区云5.2-20260928 |
videoSendRtt | Integer | 视频发送往返时延(ms) | 公有云存在 分区云5.2-20260928 |
videoSendQuality | String | 视频发送分辨率和帧率(如 "1280x720_30") | 公有云存在 分区云5.2-20260928 |
videoReceiveQuality | String | 视频接收分辨率和帧率(如 "1280x720_30") | 公有云存在 分区云5.2-20260928 |
bwDownLinkExpect | Integer | 期望下行带宽(kbps) | 公有云存在 分区云5.2-20260928 |
bwUpLinkExpect | Integer | 期望上行带宽(kbps) | 公有云存在 分区云5.2-20260928 |
sessionName | String | 会话名称 | 公有云存在 分区云5.2-20260928 |
timeStamp | Long | 质量上报时间戳(毫秒) | 公有云存在 分区云5.2-20260928 |
netTag | Integer | 网络质量(0-无意义,1-优,2-良,3-中,4-差) | 公有云存在 分区云5.2-20260928 |
以下仅列出本接口业务逻辑错误码,其他错误码见 小鱼RESTAPI错误码
错误码 | 描述 |
INVALID_PARAMETER(1001) | 参数错误。触发场景:请求体缺失;meetingId 缺失或为空;device 缺失或为空 |
MEETING_OF_ID_INVALID(4001051) | 会议 ID 无效或当前企业无权访问。触发场景:meetingId 不存在、meetingId 不属于 enterpriseId 对应的企业、跨部门资源校验失败 |
LOGIN_INVALID_DEVICE_TYPE(2017) | 设备类型不支持。触发场景:device.type 取值不在合法枚举内(1/2/5/6/7/8/9/10/12/15/17),UriHelper 解析失败 |