返回结果

OpenAPI 默认返回 JSON 数据，返回非 JSON 格式的接口会在文档中明确说明。

注意：目前只要请求被服务端正常处理了，响应的 HTTP 状态码 通常为200。例如返回的消息体里的错误码是设备指令超时，但 HTTP 状态码为200，而不是400。

通常只要请求被服务端正常处理了，无论结果是成功还是失败，返回 Body 中结构体均为：

{
  "code": 0,
  "data": { ... },
  "message": "OK"
}

No schema defined

字段	类型	允许为 NULL	名称	说明
code	number	否	错误码	错误码等于0时代表该请求调用成功，出现大于0时代表调用失败。
data	object	是	响应数据	接口的响应数据。不同的接口返回的数据结构需要参见接口文档中的定义。允许为 NULL 代表没有数据需要返回。注意：调用失败的情况下通常都为 NULL，但成功调用也可能为 NULL。
message	string	否	消息说明	如果是失败的情况，会显示出这个错误码的具体原因。随着业务发展或者体验优化，此文本可能会经常变更，开发者不能直接依赖

请求接口成功的 HTTP 状态码为 200，其中响应的结构体中 code 字段为 0，参考开始直播接口成功为例：

{
  "code": 0,
  "data": {
    "expire_ts": 0,
    "publish_uid": "string",
    "url": "string",
    "url_type": "string"
  },
  "message": "OK"
}

失败的情况返回的 HTTP 状态码会有多种情况，均表达服务端正常处理请求但是请求结果为失败的情况。

服务端正常处理请求，但是处理的结果为失败，错误码大于0的6位数字。

参考向设备发送指令超时，错误码为 212018 参考如下：

{
  "code": 212018,
  "data": null,
  "message": "OK"
}

身份认证不通过，请检查 X-User-Token 是否正确。

{
  "code": 200401,
  "data": null,
  "message": "Unauthorized"
}

接口鉴权不通过，确定用户访问资源的过程是否有权限。

{
  "code": 200403,
  "data": {
    "path": "string"
  },
  "message": "Forbidden"
}

Data 中的参数说明：

字段	类型	允许为 NULL	名称	说明
path	string	否	接口路径	鉴权不通过的路径信息