Global Return codes
Note
This document contains all return codes related to ZEGOCLOUD RTC server API interfaces. When using, please pay attention to distinguish the category of the server API interface you are using.
Common Return codes
| Return code | Description | Suggested action |
|---|---|---|
| 100000000 | Host error in request header. | Please confirm whether the Host address in the request header is correct. |
| 100000001 | AppId field format error. | Please fill in the correct AppId. |
| 100000002 | Timestamp field is empty. | Please fill in Timestamp. |
| 100000003 | Timestamp field format error. | Please fill in the correct Unix timestamp (in seconds). |
| 100000004 | Signature expired. | Please regenerate the signature. |
| 100000005 | Signature error. | Please confirm whether the parameters for generating the signature are correct. |
| 100000006 | Action is empty. | Please specify Action. |
| 100000007 | Unsupported Action. | Please fill in the correct Action. |
| 100000008 | SignatureNonce field is empty. | Please fill in SignatureNonce. |
| 100000009 | Signature field is empty. | Please fill in Signature. |
| 100000010 | Failed to get ServerSecret. | Please confirm whether the AppId is correct. |
| 100000011 | Failed to get App configuration. | Please confirm whether the AppId is correct, or contact ZEGOCLOUD Technical Support for assistance. |
| 100000013 | SignatureVersion field is empty. | Please fill in SignatureVersion. |
| 100000014 | Unsupported SignatureVersion. | SignatureVersion only supports 2.0. |
| 100000015 | Gateway internal error. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 100000016 | App is not configured for production environment. | Please confirm whether the input parameter isTest has selected the correct environment or whether the production environment is enabled. |
| 100000017 | App has not enabled this service. | Please contact ZEGOCLOUD Technical Support for assistance. |
Room Signaling Interfaces
| Return code | Description | Suggested action |
|---|---|---|
| 0 | Request successful. | - |
| 1 | Request failed. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 2 | Input parameter error. | - |
| 3 | Input parameter length too long. | Please re-enter the parameter. |
| 8 | Decoding failed. | - |
| 9 | Permission to use the current interface has not been granted. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 104 | Room does not exist, with the same internal judgment logic as 5024, 50001. | Please confirm whether the requested RoomId exists. |
| 105 | User does not exist. | Please confirm whether the requested UserID exists. |
| 121 | Failed to save broadcast message. | - |
| 122 | Failed to generate message ID. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 123 | Failed to set Stream information. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 124 | Failed to delete Stream information. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 138 | Stream information does not exist. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 151 | Failed to send broadcast message. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 154 | Failed to get list information. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 206 | App request QPS too high and was limited. | Reduce request frequency, or contact ZEGOCLOUD Technical Support to increase QPS limit threshold. |
| 207 | Room request QPS too high and was limited. | Reduce request frequency, or contact ZEGOCLOUD Technical Support to increase QPS limit threshold. |
| 1008 | Message content MessageContent is empty. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 1012 | Multiple users operating on the same Stream. | Please check the logic. |
| 5201 | Broadcast message encoding failed. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 5202 | Failed to generate message ID. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 5024 | Room does not exist, with the same internal judgment logic as 104, 50001. | Please confirm whether the requested RoomId exists. |
| 50001 | Room does not exist, with the same internal judgment logic as 104, 5024. Note
| Please confirm whether the requested RoomId exists. |
| 50003 | Failed to find User online information. | Please confirm whether the requested UserId is online. |
| 50011 | User list length too long. | Please check whether the number of users in the request packet exceeds the limit. |
| 50012 | Message length exceeds limit. | Please check whether the parameter length exceeds the limit. |
| 50013 | Failed to send custom message. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 50123 | The number of ban rules currently within the validity period exceeds the limit. | Please reduce the number of rules. |
| 50124 | The rule to be deleted does not exist. | Please check parameter settings. |
Stream Mixing and Transcoding Interfaces
| Return code | Description | Suggested action |
|---|---|---|
| 0 | Request successful. | - |
| 110200001 | Failed. | Please retry. |
| 110200002 | Input parameter error. | Please check whether the parameter is in JSON format, or refer to the Message information for handling. |
| 110200003 | Authentication failed. | Please confirm whether the Authentication information is correct or has expired. For details, please refer to the "Signature Mechanism" in Calling Method. |
| 110200004 | Failed to parse input parameters. | Please check whether the Stream Mixing parameters are correct. |
| 110200005 | Failed to acquire distributed lock when starting Stream Mixing. | The same UserId is starting Stream Mixing too frequently, please try again later. |
| 110200006 | Failed to acquire distributed lock when stopping Stream Mixing. | The same UserId is stopping Stream Mixing too frequently, please try again later. |
| 110200007 | Failed to update Stream Mixing request. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 110200008 | Stream Mixing start protocol conversion failed. | Please check whether the Stream Mixing parameters are correct. |
| 110200012 | Failed to close other Stream Mixing tasks of the Stream Mixing initiator. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 110200013 | Failed to update Stream Mixing ownership. | Please retry, or contact ZEGOCLOUD Technical Support. |
| 110200014 | Stream Mixing stop protocol conversion failed. | Please check whether the Stream Mixing parameters are correct. |
| 110200015 | Stream Mixing stop request forwarding failed. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 110200140 | MixInput and MixOutput have the same Stream ID. | Please remove the duplicate Stream ID and retry. |
| 110200141 | Image protocol currently only supports: https, http, preset-id. | Please confirm whether the current image protocol is correct. |
| 110200142 | Failed to get image. | Please check whether the image address is correct or whether the image size exceeds 1 MB. |
| 110200150 | The input Stream for Stream Mixing or single-stream transcoding does not exist. | Please confirm whether the input StreamId or StreamUrl exists. If not, remove the non-existent Stream and retry; or Publish stream to the non-existent Stream and retry. |
| 110200151 | Stream Mixing or single-stream transcoding task failed. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 110200153 | Stream Mixing input Stream error. | Please check whether the contents of the Stream Mixing input Stream are correct. |
| 110200154 | Stream Mixing output Stream error. | Please check whether the contents of the Stream Mixing output Stream are correct. |
| 110200155 | Stream Mixing input Stream format error. | Please check whether the format of each parameter in the Stream Mixing input Stream is correct. |
| 110200156 | Stream Mixing output Stream format error. | Please check whether the format of each parameter in the Stream Mixing output Stream is correct. |
| 110200157 | Stream Mixing permission not enabled. | Please confirm whether the project to which the currently used AppId belongs has enabled the Stream Mixing service permission in the ZEGO Console. For details, please refer to Project Management - Service Configuration - Stream Mixing. |
| 110200158 | Stream Mixing input Stream count exceeds limit. | Multiple input Streams are supported, with a default upper limit of 9. Please confirm whether the limit is exceeded. |
| 110200159 | Stream Mixing dispatch failed. | Please retry, or contact ZEGOCLOUD Technical Support for assistance. |
| 110200160 | Non-owner stopped Stream Mixing. | Please use the corresponding UserId to stop Stream Mixing. |
| 110200161 | Stream Mixing output Stream width value error, value range is [0, 3000]. | Please confirm the Width value. |
| 110200170 | Watermark parameter error. | Please check whether the Stream Mixing watermark parameters are correct. |
| 110200171 | Watermark parameter is empty. | Please check whether the Stream Mixing watermark image is empty. |
| 110200172 | Extended parameter error. | Please check whether the extended parameters are correct. |
| 110200175 | Input Stream duplicate. | Please confirm whether each input StreamId or StreamUrl in the MixInput parameter is globally unique. |
| 110200176 | Output Stream duplicate. | Please remove duplicate output Streams from the MixOutput list. |
| 110200177 | Focus voice exceeds limit. | Please check the number of focus voices, with an upper limit of 4. |
| 110200178 | Output Stream count exceeds limit. | Multiple output Streams are supported, with a default upper limit of 3. Please confirm whether the limit is exceeded. |
| 110200179 | Text watermark related error. | Please handle according to the returned suggestion. |
| 110200184 | Stream Mixing start parameter parsing failed. | Please check whether the parameter content is valid according to the returned prompt information. |
| 110200185 | Stream Mixing stop parameter parsing failed. | Please check whether the Stream Mixing parameters are correct. |
| 110200190 | Stream Mixing start request overload. | Requests too frequent, please try again later. |
| 110200191 | Stream Mixing stop request overload. | Requests too frequent, please try again later. |
| 110200194 | Stream Mixing request overload. | Requests too frequent, please try again later. |
| 110209001 | Stream Mixing task does not exist. | Please verify whether the Stream Mixing task is in progress. If the Stream Mixing task is actually in progress, please contact ZEGOCLOUD Technical Support. |
| 110240002 | Token is illegal. | Please fill in the correct Token. |
Media Service Interfaces
| Return code | Description | Suggested action |
|---|---|---|
| 0 | Request successful. | - |
| 1 | Request failed. | - |
| 2 | Parameter error. | - |
| 3 | Authentication failed. | Please check whether the Authentication parameters are correct. |
| 1010、5007 | Interface call frequency too high. | Please reduce interface request frequency. |
| 1001 | Dispatch failed. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 1002 | Publish stream node is empty. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 1003 | Play stream node is empty. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 1005 | App is not online. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 1006 | Invalid parameter. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 3000 | Invalid App. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 3001、5000、5001、5002、5006 | Internal error. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 3002 | Timestamp error. | Please regenerate a new Timestamp. |
| 3003 | App is not configured with Token. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 5003、40005 | Authentication failed. | Please check whether the Signature is correct. |
| 5004、30001 | Invalid CDN address. | Please check whether the request parameter CDNUrl is correct. |
| 5005 | Invalid request. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 30002 | Interface call frequency too high. | Please reduce interface request frequency. |
| 30003 | Internal error. | Please contact ZEGOCLOUD Technical Support for assistance. |
| 30004 | Parameter isTest error. | Please check whether the common request parameter isTest is correct. |
| 30005 | Invalid AppId. | Please check whether the AppId is correct. |
| 30006 | Invalid StreamId list. | Please check whether the StreamId[] is correct. |
| 30009 | Invalid StreamId, Stream name is not standard. | Please check whether the StreamId conforms to the Stream name encoding specification. |
| 30010 | Invalid dispatch action. | Please check whether the Type is correct. |
| 30011 | Invalid client IP address. | Please check whether the ClientIP is correct. |
| 41001 | Live broadcast save failed. | Please check whether the live broadcast exists. If it exists, please retry. If retry fails, please contact ZEGOCLOUD Technical Support. |
| 41002 | Channel save failed. | Please check whether the channel exists. If it exists, please retry. If retry fails, please contact ZEGOCLOUD Technical Support. |
| 41003 | Live broadcast does not exist. | Please check whether the live broadcast exists. If it exists, please retry. If retry fails, please contact ZEGOCLOUD Technical Support. |
| 41004 | Query failed, StreamId does not exist. | Please check whether the StreamId is correct or whether the "permission to query Stream status history information" has expired. |
| 41006 | Query successful, the queried Stream exists but is in closed state. Only returned within the validity period of enabling "permission to query Stream status history information". | - |
| 42001 | Failed to disable live broadcast. | Please retry. If retry fails, please contact ZEGOCLOUD Technical Support. |
| 42002 | Failed to resume live broadcast. | Please retry. If retry fails, please contact ZEGOCLOUD Technical Support. |
| 42003 | Failed to batch disable live broadcasts. | Please retry. If retry fails, please contact ZEGOCLOUD Technical Support. |
| 42004 | Failed to batch resume live broadcasts. | Please retry. If retry fails, please contact ZEGOCLOUD Technical Support. |
| 43001 | Failed to create Recording index file. | Please retry. If retry fails, please contact ZEGOCLOUD Technical Support. |
Media File Interfaces
| Return code | Description | Suggested action |
|---|---|---|
| 0 | Request successful. | - |
| 2 | Input parameter error. | - |
| 3 | Relevant permission not enabled. | Please contact ZEGOCLOUD Technical Support. |
| 4 | CDN type mismatch. | Please check parameters. |
| 5 | Configuration error. | Please contact ZEGOCLOUD Technical Support. |
| 6 | Requests too frequent. | Please try again later. |
| 7 | Authentication failed. | Please check whether the Authentication parameters are correct. |
| 1000 | Request failed. | Please contact ZEGOCLOUD Technical Support. |
| 41003 | File does not exist. | Please confirm whether the file format, file ID, etc. are correct. |
Audio/Video Stream Moderation Interfaces
For related common return codes, please refer to Room Signaling Interfaces. Interface-related return codes are as follows:
| Return code | Description | Suggested action |
|---|---|---|
| 50006、50007 | HTTP request failed. | Please try again later, or contact ZEGOCLOUD Technical Support. |
| 50009 | Moderation failed. | Please try again later, or contact ZEGOCLOUD Technical Support. |
| 50117 | Configuration error, Shumei permission not enabled. | Please contact ZEGOCLOUD Technical Support to enable Shumei-related permissions. |