返回码说明

WEB系统返回码说明

  • 请求响应状态
code message
0 success
9002 未获得控制权限,请先申请控制权限
9004 未注册用户,请先用户场景注册
10000 未知错误
10006 格式错误,请检查信令协议格式
10007 连接失败,当前用户不存在
10008 连接失败,当前场景不存在
10009 连接失败,心跳超时请重新创建连接
  • 协议执行状态
resultType resultMessage
0 success
9000 输入的字符非法
9001 权限不足,拒绝访问
9002 未获得控制权限,请先申请控制权限
9003 登录状态已过期,请重新登录
9004 未注册用户,请先用户场景注册
10000 未知错误
10001 参数错误
10002 请求次数过于频繁,流控限制
10003 当前访问人数过多,请稍后重试
10004 函数不存在
10005 模块不存在
40001 当前他人正在控制中,请稍后重试
40002 当前场景暂无法控制,请稍后重试
50001 appId、appSecret不正确或已被禁用
70001 第三方请求异常,请稍后再试
返回值参数
参数名称 参数类型 是否必须 备注
code number TRUE 请求响应状态,0 – 成功,其他- 失败
message string TRUE 返回信息
requestParam object TRUE 请求结构
requestParam.module string TRUE 请求组件
requestParam.function string TRUE 请求函数
requestParam.token string FALSE 请求唯一值或用户身份令牌
requestParam.arguments JSONArray FALSE 请求参数
responseData object TRUE 响应数据
responseData.resultType number FALSE 协议执行状态,0 – 成功,其他- 失败
responseData.resultMessage string FALSE 协议执行状态
responseData.resultInfo T FALSE 返回信息,下述所有事件返回值将在此结构下
返回值示例
{
    "code": 0,
    "message": "success",
    "requestParam": {
        "arguments": [],
        "function": "retriveStatus",
        "module": "SystemStatus"
    },
    "responseData": {
        "resultInfo": {
            "mem": 62.99840510366826,
            "stream": [
                {
                    "streamHint": 1,
                    "streamSize": 0
                },
                {
                    "streamHint": 2,
                    "streamSize": 0
                },
                {
                    "streamHint": 3,
                    "streamSize": 0
                },
                {
                    "streamHint": 4,
                    "streamSize": 0
                },
                {
                    "streamHint": 5,
                    "streamSize": 0
                },
                {
                    "streamHint": 6,
                    "streamSize": 0
                },
                {
                    "streamHint": 7,
                    "streamSize": 0
                }
            ],
            "fps": 55,
            "cpu": 5,
            "gpu": 21,
            "network": {
                "state": 2,
                "speed": [
                    {
                        "downloadSpeed": 15262,
                        "uploadSpeed": 344430
                    }
                ]
            }
        },
        "resultMessage": "success",
        "resultType": 0
    }
}
文档更新时间: 2023-12-24 10:53   作者:北京-WEB-ckk
上一篇:
下一篇: