返回结果

更新时间: 2022/03/30 02:41:29

NERoom Restful API 返回结果的格式统一,格式结构说明如下表所示。

字段 类型 说明
code int 错误码。0表示成功,其他错误码请参见错误码
msg String 业务结果描述,Success表示成功。
ts Long NERoom 服务器处理该请求的完成时间。
该时间为 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数。
cost String NERoom 服务器处理该请求的耗时。
requestId String 请求的唯一标识。
data Object 返回结果。

正常返回示例

接口调用成功后,正常返回示例如下。

java{ 
    "code": 0,
    "msg": "Success",
    "ts": 1648021056815,
    "cost": "489ms",
    "requestId": "7c4b6d9c3e9d42*****cc6e3a4d995",
    "data":{}    
}

异常返回示例

接口调用出错后,会返回错误码、错误信息,您可根据错误码来判断异常原因。

java{
    "code": 401,
    "msg": "Bad checksum:8d710597f32459326a0***",
    "ts": 1648036813259,
    "cost": "3ms",
    "requestId": "64daaec950***fd85304fee1f0e"
}
此文档是否对你有帮助?
有帮助
去反馈
  • 正常返回示例
  • 异常返回示例