Return codes
Public return codes
| Code | Description | Possible reasons | Suggested actions |
|---|---|---|---|
| 0 | Request successful. | - | - |
| 1 | Request failed. | Server busy. | Please try again later. |
| 2 | Input parameter error. | Input parameter error. | Please enter the correct parameters. |
| 3 | Authentication failed. | Authentication failed. | Please contact ZEGO technical support. |
| 7 | The number of requests per second exceeds the system setting value. | Service request overload. | Please try again later. |
| 50014 | Login failed. | UserName exceeds the limit. | Please confirm the UserName length, the maximum length is 256 bytes. |
| 51102 | User does not exist. | User not logged in ZIM. | User needs to log in ZIM. |
| 105001 | Request failed. | Request DB failed. | Please contact ZEGO technical support. |
| 100000000 | Host error in request URL header. | Host error in URL address. | Please confirm whether the request URL is correct. |
| 100000001 | AppId field format error. | AppId field format error. | Please confirm whether AppId is entered correctly. |
| 100000002 | Timestamp field is empty. | Timestamp is empty. | Please fill in the Timestamp. |
| 100000003 | Timestamp field format error. | Timestamp format error. | Please check whether the timestamp format is correct. |
| 100000004 | Signature expired. | Signature expired. | Please try again. |
| 100000005 | Signature error. | Signature expired. | Please try again. |
| 100000006 | Action is empty. | Action is empty. | Please confirm whether the request URL is correct. |
| 100000007 | Unsupported Action. | Action error. | Please confirm whether the request URL is correct. |
| 100000008 | SignatureNonce field is empty. | SignatureNonce field is empty. | Please try again. |
| 100000009 | Signature field is empty. | Signature field is empty. | Please try again. |
| 100000010 | Get ServerSecret failed. | Internal error. | Please contact ZEGOCLOUD Technical Support. |
| 100000011 | Get App configuration failed. | Internal error. | Please contact ZEGOCLOUD Technical Support. |
| 100000012 | Read HTTP packet body failed. | Internal error. | Please contact ZEGOCLOUD Technical Support. |
| 100000013 | SignatureVersion field is empty. | SignatureVersion field is empty. | Please try again. |
| 100000014 | Unsupported SignatureVersion. | Unsupported SignatureVersion. | Please confirm whether SignatureVersion is correct. |
| 100000015 | Gateway internal error. | Internal error. | Please contact ZEGO technical support. |
| 100000016 | App not configured for formal environment. | App not configured for formal environment. | Please confirm whether AppId is configured for formal environment. |
| 100000017 | App not enabled for this service. | App not enabled for this service. | Please contact ZEGOCLOUD Technical Support. |
Business-specific return codes
| Code | Description | Possible reasons | Suggested actions |
|---|---|---|---|
| 660000001 | Business-specific error. | Server error. | Please try again, or contact ZEGO technical support. |
| 660000002 | Input parameter error. | Input parameter error. | Please check the input parameters. |
| 660000003 | Logic processing error. | Server processing exception. | Please try again, or contact ZEGO technical support. |
| 660000011 | User count exceeds limit. | Input user list is too large. | Please check the input user list. |
| 660200001 | User ID does not exist, or user has logged out. | User ID does not exist, or user has logged out. | Please confirm whether the user ID exists or the user has logged out of ZIM service. |
| 660000012 | UserID length exceeds limit. | UserID maximum length is 32 bytes. | Please confirm UserID length. |
| 660000022 | Message not found, possibly because the message has been deleted or does not exist. | Please check whether the message has been deleted, and whether MsgSeq is correct. | |
| 660000023 | Message has been withdrawn. | Please confirm whether the message has been withdrawn. - If confirmed, the message has been withdrawn, do not process. - If confirmed, the message has not been withdrawn, please contact ZEGO technical support to troubleshoot the problem. | |
| 660000024 | Message withdrawal time exceeded. | If you need to withdraw messages within a longer period of time, please contact ZEGO technical support for configuration. | |
| 660000025 | Failed to send the message after IsBase64 is set to 1 in MessageBody when calling the server-side interface to send signaling messages. | Message content is not base64 encoded. | Please confirm: - Whether IsBase64 needs to be 1, that is, whether a binary type signaling message needs to be sent. - Whether the Message content is base64 encoded. |
| 660000026 | The message to be withdrawn does not match FromUserId. | Please check whether the FromUserId field is correct. | |
| 660000027 | The message saving room message configuration is not enabled, so the message cannot be withdrawn. | Please open ZIM Ultimate Edition service. | |
| 660000028 | This feature is not supported by ZIM free edition users. | Please contact ZEGO technical support to upgrade the package. | |
| 660300001 | Room does not exist. | The input RoomId does not exist or the room has been destroyed. | Please confirm whether the input RoomId is correct or the room has been destroyed. |
| 660300002 | User not in room. | The input UserId does not exist or is not in the room. | Please confirm whether the input UserId is correct. |
| 660300005 | The frequency of calling the interface exceeds the AppID level limit. | Please try again later, or refer to the relevant documentation to understand the call frequency. | |
| 660300006 | The frequency of calling the interface exceeds the group/room limit. | Please try again later, or refer to the relevant documentation to understand the call frequency. | |
| 660300007 | Get room failed. | Internal error. | Please contact ZEGO technical support. |
| 660300008 | Get room user list failed. | The room user list is empty, usually due to the room delay destruction period. | Do not process. |
| 660300012 | User not in specified room. | User not in specified room. | Do not process. |
| 660300014 | Room already exists. | Check if the room has been created. | |
| 660300015 | Room count exceeds limit. | Check if the room count exceeds the limit, or contact technical support to expand. | |
| 660400001 | Message size exceeds limit. | Input message is too large. | Please check the input message size. |
| 660500002 | Operator user not registered. | Operator user not logged in SDK. | Please let the operator register ZIM service first. |
| 660500003 | The frequency of calling the SendMessageToAllUsers interface exceeds the limit. | The frequency of calling the interface exceeds the limit. | Default 1 time/second, 100 times per 24 hours, please try again later. |
| 660500004 | Text audit request error. | Text audit request error. | Please contact ZEGO technical support. |
| 660500005 | The text message sent has not passed the audit. | The text message sent has not passed the audit. | Please do not send this message. |
| 660500006 | Image audit request error. | Image audit request error. | Please contact ZEGO technical support. |
| 660500007 | The image message sent has not passed the audit. | The image message sent has not passed the audit. | Please do not send this message. |
| 660500009 | Your business background determines that this message should be "silent sent". | After receiving the "message sending before callback", your business background returns 2, and this message is silently sent. | Do not process. |
| 660500010 | Your business background determines that this message should not be sent. | After receiving the "message sending before callback", your business background returns 3, and this message is rejected. | Do not process. |
| 660600001 | Group does not exist. | The input GroupId does not exist. | Please confirm whether the input GroupId is correct. |
| 660600003 | Query group member list error. | Server processing exception. | Please contact ZEGO technical support. |
| 660600004 | The frequency of calling the QueryGroupMemberList interface exceeds the limit. | The frequency of calling the interface exceeds the limit. | The call frequency is 20 times/second, please do not exceed the limit. |
| 660600005 | The frequency of calling the KickoutGroupUser interface exceeds the limit. | The frequency of calling the interface exceeds the limit. | The call frequency is 20 times/second, please do not exceed the limit. |
| 660600006 | Query group list data error. | Server processing exception. | Please contact ZEGO technical support. |
| 660600007 | The frequency of calling the QueryAppGroupList interface exceeds the limit. | The frequency of calling the interface exceeds the limit. | The call frequency is 1 time/second, please try again later. |
| 660600008 | The user to be removed is not in the group. | The user has left the group. | Do not process. |
| 660600009 | Get group related information failed. | The group may not exist. | Please confirm whether the GroupID is correct. If correct, please contact ZEGO technical support. |
| 660600010 | The frequency of calling the CreateGroup interface exceeds the limit. | The frequency of calling the interface exceeds the limit. | Please try again later. |
| 660600011 | Group already exists. | The GroupID of the existing group is used. | Please use other GroupID. |
| 660600012 | Group count exceeds limit. | The number of groups created has reached the package limit. | Please upgrade the package. |
| 660600013 | Group owner does not exist. | The user ID of the group owner is incorrect. | Please check whether the user ID of the group owner is correct. |
| 660600014 | Modify group owner list error. | Modify group owner list error. | Please contact ZEGO technical support. |
| 660600015 | ZIM service execution db operation error. | ZIM service execution db operation error. | Please contact ZEGO technical support. |
| 660600016 | Group member count exceeds limit. | The maximum number of users added at one time when creating a group is 100. | |
| 660600020 | The Key or Value length of the attribute is incorrect. | The length limit of Key is 16 bytes, and the length limit of Value is 1024 bytes. | Please check the length of the related parameters. |
| 660600021 | Send message parameter error. | Send message parameter error. | Please check the parameters. |
| 660600022 | Send multimedia message, get redirect address failed. | Send multimedia message, get redirect address failed. | Please contact ZEGO technical support to handle. |
| 660600023 | Message length exceeds limit. | Message length exceeds limit. | Please reduce the message length. |
| 660600024 | The user is not in the group. | Please check the user or add the user as a group member. | |
| 660600029 | Role cannot be set to 1. | Please modify Role. | |
| 660600030 | FromUserId cannot be equal to ToUserId. | Please modify ToUserId. | |
| 660600032 | FromUserId does not have permission. | FromUserId needs to be the group owner or administrator. | |
| 660600033 | All specified users' operations failed. | Please check UserIds. | |
| 660700001 | The frequency of calling the UserRegister interface exceeds the limit. | The frequency of calling the interface exceeds the limit. | Please try again later. |
| 660700002 | User already exists. | The UserID of the request is already registered. | Please avoid registering the same UserID again. |
| 660700006 | UserName length exceeds limit. | UserName length maximum is 256 bytes. | Please confirm UserName length. |
| 660700007 | UserAvatar address length exceeds limit. | UserAvatar address length maximum is 500 bytes. | Please confirm UserAvatar length. |
| 660700008 | Get user information error. | User ID error. | Please check whether the User ID is correct. |
| 660700012 | User does not exist. | Please register the user first. | |
| 660700013 | Query user information error. | Please contact ZEGO technical support. | |
| 660700015 | User not registered. | Please register the user first. | |
| 660700016 | Synchronize user information error. | Please contact ZEGO technical support. | |
| 660700017 | Update user information error. | Please contact ZEGO technical support. | |
| 660800001 | When setting a single chat session as top, the user corresponding to the ConvID of the target session is not registered. | Please confirm whether the user corresponding to the ConvId is registered: - If confirmed, please contact ZEGO technical support to troubleshoot. - If confirmed, please register this user. | |
| 660800002 | When clearing the unread message count of a session, the session does not exist, or the session does not apply to this interface (not one of the latest 1000 sessions). | Please confirm whether the session ID is correct. | |
| 660800019 | The number of single batch operations exceeds the limit. | Please reduce the number of single batch operations. | |
| 660800020 | Cannot add FromUserId as a friend, that is, the UserId in FriendInfos cannot be the same as FromUserId. | Please modify the UserId in FriendInfos that is the same as FromUserId. | |
| 660800021 | FriendAlias or Wording exceeds the length limit. | Please reduce the length of the related fields. | |
| 660800022 | The user ID related parameters in the parameters are repeated. | Please delete or modify the duplicate parameters. | |
| 660800023 | The Key value of Attributes does not belong to k0 ~ k4. | Please modify the Key value. | |
| 660800024 | The total length of all Key and Value of Attributes exceeds the length limit. | Please reduce the length of the related fields. | |
| 660800025 | All friends are not registered, interface call failed. | Please register the target user first. | |
| 660800026 | Friend attribute parameter error. | Please check the input parameters. | |
| 660800027 | The target user is already a friend, no need to add again. | Do not process. | |
| 660800028 | The number of friends of FromUserId has reached the upper limit. | Do not process. | |
| 660800030 | The user's do not disturb list exceeds the length limit, default 500. | Please shorten the list, or contact technical support to increase the upper limit, the maximum is 1000. | |
| 660800032 | Attributes has duplicate Key. | Please modify Key. | |
| 660800033 | The string in UserIds cannot be the same as FromUserId | Please modify the string in UserIds that is the same as FromUserId. | |
| 660800034 | The target user is not a friend of FromUserId. | Please add this user as a friend first if you need to modify the remark for this user. | |
| 660800037 | The user has been blacklisted, no need to repeat the operation. | Do not process. | |
| 660800038 | Cannot blacklist FromUserId or remove FromUserId from the blacklist. | Please modify UserIds. | |
| 660800039 | The number of input users exceeds the limit. | Please shorten the input user list. | |
| 660800040 | The blacklist of FromUserId has reached the upper limit, cannot blacklist more users. | Do not process. | |
| 660800041 | Blacklist all specified users failed. | Please refer to the SubCode of the response parameter ErrList for processing. | |
| 660800042 | All specified users failed to remove from the blacklist. | Please refer to the SubCode of the response parameter ErrList for processing. | |
| 660800043 | This user has been removed from the blacklist. | Do not process. | |
| 660800044 | This user is not in the blacklist. | Do not process. | |
| 660800045 | The message sender has been blacklisted by the message receiver, causing message sending failure. | Do not process. | |
| 660800046 | The passed timestamp is greater than the current time. | Can be left blank, the default is the current time. | |
| 660800048 | The length of the top list exceeds the limit (100, not configurable). | Do not process. | |
| 660800051 | The session has been set to do not disturb, cannot be set to do not disturb again. | Do not process. | |
| 660800052 | The session has been cancelled from do not disturb, cannot be cancelled again. | Do not process. | |
| 660800053 | Query session list failed. | Please contact ZEGO technical support. | |
| 660900003 | All called users need to be registered. | Please check the registration status of the called users or try again later. | |
| 660900004 | Get call information failed. | Please check whether the call exists or try again later. | |
| 660900005 | The call has ended, cannot be operated. | Do not process. | |
| 660900006 | The call invitation has timed out, cannot be operated. | Do not process. | |
| 660900007 | The length of the called user list exceeds the limit. | Please shorten the length of the called user list, or contact ZEGO technical support to increase the upper limit. | |
| 660900008 | The call does not have an invitation operation user, cannot be operated. | Do not process. | |
| 661000001 | The editing time has exceeded the limit. | If you need to edit earlier historical messages, please contact ZEGO technical support for configuration. | |
| 661000005 | Edit failed. | Please contact ZEGO technical support. |