公共参数

  • 公共参数包括 公共请求参数、公共返回参数以及公共错误码部分。

公共请求参数

  • 是指每个接口都需要使用到的请求参数。
参数 类型 是否必选 含义
app_id string 是 应用ID，微吼云会给开发者应用颁发应用标识和秘钥信息 控制台->对应应用->设置->应用信息
signed_at string 是 当前UTC时间戳，从1970年1月1日0点0分0秒开始到现在的秒数
sign string 是 签名结果串，关于签名的计算方法，请参见 签名机制。

公共返回参数

  • 用户发送的每次接口调用请求，无论成功与否，系统都会返回一个code给用户。
  • 如无特殊说明，接口中的出参均为data中的数据
参数 类型 是否必选 含义
code int 是 返回结果的状态码 （200 成功）
msg string 是 当返回结果的状态码不为200时，包含的错误信息
data json 是 返回的结果集
  • JSON
{
    "code": 200,  // 返回结果状态码
    "msg": "",      // 错误信息
    "data": {       // 返回结果数据
        "room_id": "lss_69178ce4"
    }
}

公共错误码

参数 类型 含义
10001 int 应用ID不能为空
10002 int 鉴权时间不能为空
10003 int 鉴权签名不能为空
20001 int 应用查询为空
20003 int 开发者不存在
30004 int 接口鉴权失败
30003 int 当前开发者尚未通过认证