查询网络质量 - ListNetworkQuality

功能介绍

查询会场网络质量。

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/mmc/cqs/media/qos

表1 Query参数
参数	是否必选	参数类型	描述
conferenceid	是	String	会议ID。
confuuid	是	String	会议uuid，创建会议时生成
appid	否	String	appid

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
confToken	是	String	会控Token，通过获取会控token接口获得。

表3 请求Body参数
参数	是否必选	参数类型	描述
users	否	List<UserQosReqInfo>	需要查询用户的用户信息列表，单次查询限制最多50位用户

表4 UserQosReqInfo数据结构
参数	是否必须	类型	描述
pid	否	String	用户pid
accessMediaType	否	String	用户接入媒体类型 MGR：软终端媒体 MGSA：硬终端媒体

表5 状态码说明
HTTP状态码	描述
200	操作成功。
400	参数异常。
401	未鉴权或鉴权失败。
403	权限受限。
500	服务端异常。

响应参数

表6 响应Body参数
参数	参数类型	描述
returnCode	Integer	错误码。
returnDesc	String	结果描述
qosList	List<UserQos>	查询结果集合

表7 UserQos数据结构
参数	参数类型	描述
participantID	String	用户pid
netRate	String	网络质量评级
bandWidthUp	integer	上行总带宽(kbit/s)
bandWidthDown	integer	下行总带宽(kbit/s)
lostPacketRateUp	integer	上行丢包率（千分数）
lostPacketRateDown	integer	下行丢包率（千分数）
delay	integer	时延(ms)
videoQos	MediaQos object	视频QoS
audioQos	MediaQos object	音频QoS
auxQos	MediaQos object	辅流QoS

表8 MediaQos数据结构
参数	参数类型	描述
upList	List<Qos>	客户端-->服务器方向QoS
downList	List<Qos>	服务器-->客户端方向QoS

表9 Qos数据结构
参数	参数类型	描述
networkQuality	String	网络质量评级
codecType	String	编解码类型。 G711 G722 G729 iLBC AACLD OPUS AACLD_DOUBLE AACLD_THEBLE H264BP H264HP H.265
bandWidth	integer	带宽(kbit/s)
lostPacketRate	integer	丢包率（千分数）
delay	integer	时延(ms)
jitter	integer	抖动(ms)
resolutionHeight	integer	音频QoS
resolutionWidth	integer	辅流QoS
frameRate	integer	帧率
codecUserId	string	该媒体流编码会场ID，仅服务器向端侧发送方向涉及(视频)，如路径A-->服务器-->B，即B观看A，该媒体流的codec_user_id为A

请求示例

POST https://{endpoint}/v1/mmc/cqs/media/qos?conferenceid=969271421&appid=605876aefa163e971ba21f8a40097b51&confuuid=cabcf4ec031749f594cdfc26bf0dba9e

{
    "users": [
        {
            "pid": "913e3ce2345e11ef8dec5f2fea0eff1a", 
            "accessMediaType": "MGR"
        }
    ]
}

响应示例

状态码： 200

{
    "returnCode": 0,
    "returnDesc": "Success",
    "qosList": [
        {
            "participantID": "913e3ce2345e11ef8dec5f2fea0eff1a",
            "netRate": "5",
            "bandWidthUp": 98,
            "bandWidthDown": 0,
            "lostPacketRateUp": 0,
            "lostPacketRateDown": 0,
            "delay": 77,
            "videoQos": {
                "upList": [],
                "downList": []
            },
            "audioQos": {
                "upList": [
                    {
                        "codecType": "OPUS",
                        "bandWidth": 81,
                        "lostPacketRate": 0,
                        "delay": 77,
                        "jitter": 10,
                        "resolutionHeight": 0,
                        "resolutionWidth": 0,
                        "frameRate": 0
                    }
                ],
                "downList": []
            },
            "auxQos": {
                "upList": [
                    {
                        "codecType": "H.265",
                        "bandWidth": 17,
                        "lostPacketRate": 0,
                        "delay": 121,
                        "jitter": 11,
                        "resolutionHeight": 0,
                        "resolutionWidth": 0,
                        "frameRate": 2,
                        "codecUserId": "913e3ce2345e11ef8dec5f2fea0eff1a"
                    }
                ],
                "downList": []
            }
        }
    ]
}