Virtual Avatar
  • iOS : Objective-C
  • Android
  • Overview
  • Client SDKs
  • Demo app
  • Getting started
    • Integrate the SDK
    • Create a virtual avatar
    • ZegoCharacterHelper instructions
  • Guides
  • Best practice
  • Error codes
  • Server APIs
  • Documentation
  • Virtual Avatar
  • Error codes

Error codes

Last updated:2023-03-14 17:18

If errors occur during SDK running, the SDK cannot rectify the errors automatically. Handle the errors by referring to this document.

General error codes

If the ErrorCode field exists in the return result after an API is called, which indicates the API call is abnormal. The sample code and error codes are as follows:

- (void)onError:(ZegoAvatarErrorCode)code desc:(NSString *)desc {
    NSLog(@"onErrorCallBack code:%ld  description:%@", (long)code, desc);
}
Error code Possible cause and solutions
0 Operation succeeded.
5000001 Invalid license format. Ensure that the license is correct.
5000002 License has expired. Please re-generate a license.
5000004 The license does not include authorization of the current platform. Contact ZEGOCLOUD technical support.
5000005 The current application does not support this license.
5000006 Authentication is not performed during AvatarService initialization. During AvatarService initialization, introduce the license. Other operations can be performed only after authentication is successful.
5000201 The license does not include authorization of the Automatic avatar generation feature. Contact ZEGOCLOUD technical support.
5000202 The license does not include authorization of the Manual avatar creation and Styles and materials features. Contact ZEGOCLOUD technical support.
5000203 The license does not include authorization of the facial expression mirroring feature. Contact ZEGOCLOUD technical support.
5000204 No available license. Check whether authentication is successful.
5000205 The file in the specified path does not exist. Check whether the path is correct.
6000001 An error occurred during recording output file creation. Process it based on the error information of the startRecord callback.
6000002 An error occurred during recording. Data of a frame may fail to be recorded. Try again or contact ZEGOCLOUD technical support for processing.
6000003 The current file is being recorded. End the current recording first.
6000004 The set recording width is incorrect. The recording width cannot be greater than the avatarView width.
6000005 The mobile phone hardware does not support recording. Change the device.
6000006 A hardware configuration error occurred during recording. Change the device and try again.

Talking avatar error codes

If the ErrorCode field exists in the return result after the playTextExpression method is called, which indicates the API call is abnormal. The sample code and error codes are as follows:

- (void)onError:(ZegoTextAPIErrorCode)errorCode message:(NSString *_Nullable)message;
Error code Possible cause and solutions
0 Operation succeeded.
4 Invalid request parameter. Please check the request parameter. For more, contact ZEGOCLOUD technical support.
5 Invalid AppID. Please check the AppID you get.
6 Invalid signature. Please check whether the AppID and AppSign match.
8 Failed to verify the AppID. Causes: 1. AppID or AppSign is incorrect. 2. AppID is expired. If the problem persists, contact ZEGOCLOUD technical support.
9 License has expired. The license is only valid for 10 minutes.
10 Not a millisecond timestamp.Please check whether the timestape is correct.
10001 The text of the server request is too long. Please contact ZEGOCLOUD technical support to check the length of limited text.
10002 The passed text is not in UTF-8 code. Please check and make sure the format is UTF-8.
10003 Invalid voice_type. Please contact ZEGOCLOUD technical support to get and refer to the voice type list.
10005 Invalid volume parameter. Please check whether the parameter is correct, it ranges from [0,9].
10006 Invalid speed parameter. Please check whether the parameter is correct, it ranges from [0,9].
20001 Request contains invalid characters, or no valid characters contained. Please check the text. To learn the invalid characters, contact ZEGOCLOUD technical support.
90004 Avatar's Character hasn't been passed during initialization. Please pass in the Character when initializing the ZegoTextAPI.
90005 The playTextExpression parameter is empty. Please check the text parameter.
90006 The playTextExpression parameter is too long. Please check whether the text parameter is less than 1000 characters.

For more error codes, contact the ZEGOCLOUD team.

Page Directory