错误码和状态码

更新时间: 2024/03/25 11:00:40

在服务端 API 调用失败后,会在 Header 中返回异常状态码,一般为 4xx 或者 5xx;部分接口会在 Body 中返回具体的业务错误码或状态码,以及错误信息供您排查问题。

Header 中的状态码

服务端 API HTTP Header 中的状态码如下:

状态码(code) 说明
200 API 调用成功。
400 请求无效。
401 接口鉴权失败。请检查请求 header 中的 CheckSum 字段是否正确。
402 房间推流任务数量超过限制。
404 cid 对应的房间不存在,请检查 cid 正确性。
429 请求个数超过频控限制。
464 uid 对应的用户不在房间中。
500 服务器内部错误。

Body 中的错误码

服务端 API HTTP Body 中的错误码如下:

房间管理相关错误码

错误码 错误原因
200 操作成功。
400 请求不是一个合法的 json。
403 非法操作或没有权限。
404 对象不存在。
414 参数错误,比如自行生成 Token 时,curTime 单位有误,应该为毫秒。
417 房间名已存在。
456 房间已过期。
500 服务器内部错误。
503 服务器繁忙。
514 服务不可用。

录制文件相关错误码

错误码 错误原因
200 操作成功。
403 非法操作或没有权限。
404 对象不存在。
414 参数错误。
416 API 调用频率超出限制。
500 服务器内部错误。

Body 中的状态码

云端播放状态码

在云端播放方案中,调用创建云端播放任务等相关服务端接口时,会返回状态码 code,通知当前云端播放任务的状态。
其中,当云端播放任务状态异常时,返回 body 中会包含错误详情(errMsg)供您排查信息,常见状态码如下。

状态码(code) errMsg 说明
200 - 状态正常。
400 open url error 打开 URL 失败。
401 open codec error 打开解码器失败。
402 stream interrupt 读取文件数据中断。

云端录制状态码

在云端录制方案中,调用创建云端录制任务等相关服务端接口时,会返回状态码 status,通知当前云端录制任务的状态。

状态码(status) 说明
0 尚未开始云端录制。
1 已创建房间、开始录制。
2 dump 录制切片。
3 通话结束,录制服务结束。
4 开始转码。
5 录制完成。

旁路推流状态码

在旁路推流方案中,调用创建旁路推流任务等相关服务端接口时,会返回状态码 code,通知当前旁路推流任务的状态。
其中,当云端播放任务状态异常时,返回 body 中会包含错误详情(reason)供您排查信息,常见状态码如下。

状态码(code) 状态原因(reason) 说明
500 - 初始值。
505 stream push succeeded 推流成功。
506 stream push failed 推流失败。
511 stop pushing stream 推流结束。
510 no record permission 应用无互动录制权限。
512 pic download failed 背景图片下载失败。
512 pic diskIo failed 图片读取失败。
512 read pic failed 图片读取失败。
512 pic format error 图片格式错误。
512 decode pic failed 图片解码失败。
513 "invalid room task parameter: " + 字段 推流任务参数错误。
此文档是否对你有帮助?
有帮助
去反馈
  • Header 中的状态码
  • Body 中的错误码
  • 房间管理相关错误码
  • 录制文件相关错误码
  • Body 中的状态码
  • 云端播放状态码
  • 云端录制状态码
  • 旁路推流状态码