服务端 API v2
  • API概览
  • 快速开始
  • 调用方式
  • 房间信令接口
  • 混流接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 回调说明
  • 全局返回码
  • 使用 Postman 调试

全局返回码

更新时间:2022-09-30 16:44

本文档包含 ZEGO 服务端 API 接口相关的所有返回码。使用时,请您注意区分所使用的服务端 API 接口的所属分类。

公共返回码

返回码 说明 处理建议
100000000 请求头部中的 Host 错误。 请确认请求头部 Host 地址是否正确。
100000001 AppId 字段格式错误。 请填写正确的 AppId。
100000002 Timestamp 字段为空。 请填写 Timestamp。
100000003 Timestamp 字段格式错误。 请填写正确 Unix 时间戳(单位秒)。
100000004 签名过期。 请重新生成签名。
100000005 签名错误。 请确认生成签名的参数是否正确。
100000006 Action 为空。 请指定 Action。
100000007 不支持的 Action。 请填写正确的 Action。
100000008 SignatureNonce 字段为空。 请填写 SignatureNonce。
100000009 Signature 字段为空。 请填写 Signature。
100000010 获取 ServerSecret 失败。 请确认 AppId 是否正确。
100000011 获取 App 配置失败。 请确认 AppId 是否正确,或联系 ZEGO 技术支持处理。
100000013 SignatureVersion 字段为空。 请填写 SignatureVersion。
100000014 不支持的 SignatureVersion。 SignatureVersion 仅支持 2.0。
100000015 网关内部错误。 请联系 ZEGO 技术支持处理。
100000016 App 未配置正式环境。 请确认输入参数 isTest 是否选择了正确的环境、或是否开通正式环境。
100000017 App 未开通该服务。 请联系 ZEGO 技术支持处理。

房间信令接口

返回码 说明 处理建议
0 请求成功。 -
2 输入参数错误。 -
3 输入参数长度过长。 请重新输入参数。
8 解码失败。 -
104 房间不存在,与 5024、50001 内部判断逻辑相同。 请确认请求房间 RoomId 是否存在。
105 用户不存在。 请确认请求房间 UserID 是否存在。
121 保存广播消息失败。 -
122 生成 message ID 失败。 请重试,或联系 ZEGO 技术支持处理。
123 设置流信息失败。 请重试,或联系 ZEGO 技术支持处理。
124 删除流信息失败。 请重试,或联系 ZEGO 技术支持处理。
138 流信息不存在。 请重试,或联系 ZEGO 技术支持处理。
151 推送广播消息失败。 请重试,或联系 ZEGO 技术支持处理。
154 获取列表信息失败。 请重试,或联系 ZEGO 技术支持处理。
206 App 请求 QPS 过高被限制。 降低请求频率,或联系 ZEGO 技术支持提高 QPS 限制阈值。
207 房间请求 QPS 过高被限制。 降低请求频率,或联系 ZEGO 技术支持提高 QPS 限制阈值。
1008 消息内容 MessageContent 为空。 请重试,或联系 ZEGO 技术支持处理。
1012 多个用户操作同一个流。 请检查逻辑。
5201 广播消息编码失败。 请重试,或联系 ZEGO 技术支持处理。
5202 生成 message ID 失败。 请重试,或联系 ZEGO 技术支持处理。
5024 房间不存在,与 104、50001 内部判断逻辑相同。 请确认请求房间 RoomId 是否存在。
50001 房间不存在,与 104、5024 内部判断逻辑相同。
  • 当房间内没有用户时,房间会被服务端自动销毁。
  • 当房间内只有一个用户时,该用户退出房间或被踢出房间,房间会被服务端自动销毁。
  • 当用户心跳请求超时 100 秒后,用户会掉线;所有用户都不在房间后,房间会被服务端自动销毁。
请确认请求房间 RoomId 是否存在。
50003 查找用户在线信息失败。 请确认请求用户 UserId 是否在线。
50011 用户列表长度过长。 请检查请求包中的用户个数是否超过限制。
50012 消息长度超过限制。 请检查参数长度是否超过限制。
50013 发送自定义消息失败。 请重试,或联系 ZEGO 技术支持处理。

混流接口

返回码 说明 处理建议
0 请求成功。 -
110200001 失败。 请重试。
110200002 输入参数错误。 请检查参数是否为 JSON 格式。
110200003 鉴权失败。 请确认鉴权信息是否正确或过期,详情请参考 签名机制
110200004 解析输入参数失败。 请检查混流参数是否正确。
110200005 混流开始获取分布式锁失败。 同一个 UserId 开始混流请求过于频繁,请稍后再试。
110200006 混流结束获取分布式锁失败。 同一个 UserId 停止混流请求过于频繁,请稍后再试。
110200007 更新混流请求失败。 请重试,或联系 ZEGO 联系技术支持处理。
110200008 混流开始协议转换失败。 请检查混流参数是否正确。
110200012 关闭混流发起者其他混流任务失败。 请重试,或联系 ZEGO 联系技术支持处理。
110200013 更新混流归属失败。 请重试,或联系 ZEGO 联系技术支持。
110200014 混流结束协议转换失败。 请检查混流参数是否正确。
110200015 混流结束请求转发失败。 请重试,或联系 ZEGO 联系技术支持处理。
110200140 MixInput 与 MixOutput 存在相同流 ID。 请去除相同的流 ID,并重试。
110200141 图片协议目前只支持:https,http,preset-id。 请确认当前使用的图片协议是否正确。
110200142 图片获取失败。 请检查图片地址是否正确、或者图片大小是否超过 1 MB。
110200150 混流输入流不存在。 请确认输入流 StreamId 或 StreamUrl 是否存在。如不存在,移除该条不存在的流并重试;或对该条不存在的流进行推流并重试。
110200151 混流失败。 请重试,或联系 ZEGO 技术支持处理。
110200153 混流输入流错误。 请检查混流输入流各项内容是否正确。
110200154 混流输出流错误。 请检查混流输出流各项内容是否正确。
110200155 混流输入流格式错误。 请检查混流输入流各项参数的格式是否正确。
110200156 混流输出流格式错误。 请检查混流输出流各项参数的格式是否正确。
110200157 混流权限未开。 请确认当前使用的 AppId 所属项目,是否在 ZEGO 控制台 上开启了混流服务的权限,详情请参考 项目管理 - 服务配置 中的“混流”。
110200158 混流输入流条数过限。 输入流支持多条,默认上限为 9 条,请确认是否超出限制。
110200159 混流 dispatch 失败。 请重试,或联系 ZEGO 技术支持处理。
110200160 非所有者关闭混流。 请使用对应的 UserId 停止混流。
110200161 混流输出流的宽度数值错误,取值范围为 [0, 3000]。 请确认 Width 取值。
110200170 水印参数错误。 请检查混流水印参数是否正确。
110200171 水印参数为空。 请检查混流水印图是否为空。
110200172 扩展参数错误。 请检查扩展参数是否正确。
110200175 输入流重复。 请确认 MixInput 参数中,各输入流 StreamId 或 StreamUrl 是否是全局唯一。
110200176 输出流重复。 请去除 MixOutput 列表中重复的输出流。
110200177 焦点语音超出限制。 请检查焦点语音数量,上限为 4 个。
110200178 输出流超出数量限制。 输出流支持多条,默认上限为 3 条,请确认是否超出限制。
110200179 文字水印相关错误。 请根据返回的 suggestion 处理。
110200184 混流开始参数解析失败。 请根据返回提示信息,检查参数内容是否合法。
110200185 混流结束参数解析失败。 请检查混流参数是否正确。
110200186 获取房间流列表失败。 请检查房间是否存在流信息。
110200190 混流开始请求过载。 请求过于频繁,请稍后再试。
110200191 混流结束请求过载。 请求过于频繁,请稍后再试。
110200194 混流请求过载。 请求过于频繁,请稍后再试。
110240002 token 非法。 请填写正确的 Token。

媒体服务接口

返回码 说明 处理建议
0 请求成功。 -
1 请求失败。 -
2 参数错误。 -
3 鉴权失败。 请检查鉴权参数是否正确。
1010、5007 接口调用频率过高。 请降低接口请求频率。
1001 调度失败。 请联系 ZEGO 技术支持处理。
1002 推流节点为空。 请联系 ZEGO 技术支持处理。
1003 拉流节点为空。 请联系 ZEGO 技术支持处理。
1005 App 不在线。 请联系 ZEGO 技术支持处理。
1006 无效参数。 请联系 ZEGO 技术支持处理。
3000 无效的 App。 请联系 ZEGO 技术支持处理。
3001、5000、5001、5002、5006 内部错误。 请联系 ZEGO 技术支持处理。
3002 Timestamp 时间戳错误。 请重新生成新的 Timestamp。
3003 App 未配置 Token。 请联系 ZEGO 技术支持处理。
5003、40005 鉴权失败。 请检查签名 Signature 是否正确。
5004、30001 无效的 CDN 地址。 请检查请求参数 CDNUrl 是否正确。
5005 无效请求。 请联系 ZEGO 技术支持处理。
30002 接口调用频率过高。 请降低接口请求频率。
30003 内部错误。 请联系 ZEGO 技术支持处理。
30004 参数 isTest 错误。 请检查公共请求参数 isTest 是否正确。
30005 无效的 AppId。 请检查 AppId 是否正确。
30006 无效的 StreamId 列表。 请检查 StreamId[] 是否正确。
30009 无效的 StreamId。 请检查 StreamId 是否正确。
30010 无效的调度动作。 请检查 Type 是否正确。
30011 无效的客户端 IP 地址。 请检查 ClientIP 是否正确。
41001 直播保存失败。 请检查直播是否存在。如果存在,请重试,重试无效请 ZEGO 联系技术支持。
41002 频道保存失败。 请检查频道是否存在。如果存在,请重试,重试无效请 ZEGO 联系技术支持。
41003 直播不存在。 请检查直播是否存在。如果存在,请重试,重试无效请 ZEGO 联系技术支持。
41004 流已不存在。 请检查流是否存在。如果存在,请重试,重试无效请 ZEGO 联系技术支持。
42001 禁用直播失败。 请重试,重试无效请 ZEGO 联系技术支持。
42002 恢复直播失败。 请重试,重试无效请 ZEGO 联系技术支持。
42003 批量禁用直播失败。 请重试,重试无效请 ZEGO 联系技术支持。
42004 批量恢复直播失败。 请重试,重试无效请 ZEGO 联系技术支持。
43001 创建录制索引文件失败。 请重试,重试无效请 ZEGO 联系技术支持。

媒体文件接口

返回码 说明 处理建议
0 请求成功。 -
2 输出参数错误。 -
3 未开通相关权限。 请联系 ZEGO 技术支持。
4 CDN 类型不匹配。 请检查参数。
5 配置错误。 请联系 ZEGO 技术支持。
6 请求过于频繁。 请稍后重试。
7 鉴权失败。 请检查鉴权参数是否正确。
1000 请求失败。 请联系 ZEGO 技术支持。
41003 资源不存在。 请确认资源格式、资源列表是否正确。

音视频流审核接口

相关公共返回码,请参考 房间信令接口。接口相关返回码如下:

返回码 说明 处理建议
50006、50007 HTTP 请求失败。 请稍后重试,或 ZEGO 联系技术支持。
50009 审核失败。 请稍后重试,或 ZEGO 联系技术支持。
50117 配置错误。 请 ZEGO 联系技术支持。