文档反馈
文档反馈

返回结果

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 鉴权失败。
404 cid 对应的房间不存在,请检查 cid 正确性。
429 请求个数超过频控限制。
500 服务器内部错误。

请输入您的建议或问题(至少5个字符,至多500个字符)

×

反馈成功

非常感谢您的反馈,我们会继续努力做得更好。