返回结果

更新时间: 2023/03/07 06:30:42

API 返回结果的格式统一。header 中返回 2xx HTTP 状态码代表接口调用成功;header 中返回 4xx 或 5xx HTTP 状态码代表接口调用失败。调用失败时,部分接口会同时在 body 中返回该调用的相关错误信息供您排查问题。

正常返回示例

接口调用成功后会返回接口返回参数,这样的返回为正常返回。正常返回的 HTTP header 中的状态码为 2xx。

正常返回示例如下:

{ 
    "code": 200,         
    "cid": 12345        
}

异常返回示例

接口调用出错后,会返回错误码、错误信息,这样的返回为异常返回。HTTP header 中的状态码为 4xx 或者 5xx。部分接口会在 body 中返回具体的业务错误码和错误信息供您排查问题。

您可以根据接口调用后返回的错误码,参考 header 中的 HTTP 状态码业务错误码排查错误。当您无法排查错误时,可以提交工单联系技术支持人员。

异常返回示例如下:

header 中的 HTTP 状态码

状态码(code) 说明
200 API 调用成功。
400 请求无效。
401 接口鉴权失败。请检查请求 header 中的 CheckSum 字段是否正确。
402 房间推流任务数量超过限制。
404 cid 对应的房间不存在,请检查 cid 正确性。
429 请求个数超过频控限制。
500 服务器内部错误。
此文档是否对你有帮助?
有帮助
去反馈
  • 正常返回示例
  • 异常返回示例
  • header 中的 HTTP 状态码