Global Error Description
Updated: 2021-09-28 14:08:02
Example of Return Information
Request API returns correctly:
{
"code": 200,
"status": "success",
"message": "",
"data": ""
}
Request API Field Validation Error Return
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Request API business logic processing error return:
{
"code": 500,
"status": "fail",
"message": "access forbidden",
"data": ""
}
Meaning of each field:
| Name | Type | Description |
|---|---|---|
| code | Integer | Response status code, with specific correspondences as follows |
| status | String | Response status text information |
| message | String | Response description information. When code is 400 or 500, it assists in describing the error reason. For details, refer to the Error Information Comparison Table |
Error Code Description
| code | status | message |
|---|---|---|
| 200 | success | Indicates successful business processing; this field is an empty string. |
| 40X (X is any digit) | error | Indicates a field validation error; the error message describes the specific erroneous field, e.g., invalid signature. |
| 500 | fail | Indicates a server business logic processing error; the error message provides specific details, e.g., access forbidden. |
Message Detailed Explanation Comparison Table
| message | Explanation |
|---|---|
| undefined error | Unknown error |
| need to login | Not logged in |
| access forbidden | Access forbidden |
| redirect | Needs to redirect to a URL (outputs the redirect URL to data.url) |
| illegal operation | Illegal operation |
| channel id or password error | Incorrect channel ID or password during login |
| conflict with user login | Teacher login conflicts with user login status |
| illegal stream status | Incorrect stream status |
| illegal domain | Illegal liveDomain |
| channel forbid login | Channel login switch is off, login forbidden |
| channel already login | A user is already logged in, please try again later |
| channel in live | The channel is currently live, please try again later |
| channel in no live | The channel is not currently live, please try again later |
| please user pure video scene channel login | Pure video login |
| qps exceeds number of calls | QPS exceeds the call limit |
| invalid date time format | Invalid date format |
| param validate error | Parameter validation error |
| param should not be empty: %s | Parameter value is empty |
| param is not digit: %s | Parameter is not a non-negative integer |
| param is not number: %s | Parameter value is not a number |
| param length is incorrect: %s | Parameter value length is incorrect |
| number range error | Number range error |
| json format error | Parameter is not in JSON format, or missing JSON fields, or incorrect JSON field type |
| param exceeds maximum value of integer: %s | Parameter exceeds the integer value range |
| param is not color | Parameter is not a color value |
| param is not boolean (Y / N) | Parameter is not a boolean value (Y/N) |
| param is not date normal format | Parameter is not in the correct yyyy-MM-dd date format |
| invalid globalEnabledType:%s | Parameter is not a valid GlobalEnabledType |
| invalid date format | General return for incorrect date format |
| date range error | Date range error |
| date error | Date format error |
| array param empty or exist empty element | Array contains empty strings |
| arrays length are not equal | Array lengths are not equal |
| incorrect protocol | Incorrect protocol header |
| 昵称已存在：%s | Nickname already exists |
| invalid email | Invalid email |
| param invalid %s | Invalid parameter |
| invalid role | Incorrect backend role type |
| invalid roomId | Incorrect chat room ID |
| invalid billingPlan | Incorrect live streaming plan type |
| invalid rtc record type | Incorrect live streaming RTC recording type |
| invalid bill trade type | Invalid bill transaction type |
| invalid bill status | Invalid bill status |
| invalid channel list order | Incorrect channel list sort value |
| invalid live scene | Incorrect live streaming scene |
| invalid menu type | Incorrect menu type |
| menu already exist | Menu already exists |
| menu count reached the limit | Menu count has reached the limit |
| illegal menu id: %s | Illegal channel page menu ID |
| invalid marquee type | Incorrect marquee type |
| invalid player logo position | Incorrect player logo image position |
| invalid live player skin | Incorrect live player skin value |
| invalid stream type | Incorrect live streaming stream type |
| invalid warmup type | Incorrect warm-up type |
| invalid menu url content | Incorrect video source type |
| invalid watch skin type | Incorrect viewing page skin type |
| invalid live player type | Incorrect live player type |
| invalid lottery range type | Incorrect lottery candidate type |
| invalid sms service type | Incorrect SMS service provider type |
| invalid watch layout type | Incorrect viewing page layout type |
| invalid watch template type | Incorrect viewing page template type |
| confirm password inconsistency | New password and confirmation password do not match |
| old password error | Incorrect old password |
| invalid donate type | Incorrect donation type |
| invalid advert kind | Incorrect advertisement type AdvertKind |
| invalid advert type | Incorrect advertisement type AdvertType |
| invalid income type | Incorrect income type |
| invalid viewlog type | Incorrect viewing log type |
| invalid disk video lang type | Incorrect disk push stream language type |
| upload file size exceeds the limit | Uploaded file size exceeds the limit |
| upload file format error: %s | Uploaded file format is incorrect |
| channel status not live | Channel is not currently live |
| channel not found. | Channel not found |
| illegal channel id: %s | Illegal channel ID |
| channel is unavailable | Channel is closed |
| kaptcha error | Image CAPTCHA error |
| sms code error | SMS verification code error |
| send sms code too frequent | SMS verification code sent too frequently |
| illegal lottery id: %s | Illegal lottery record ID |
| user not found. | User not found |
| slide verification error | Slide verification error |
| channel count reached the limit | Channel count has reached the limit |
| channel batch count over limit | Number of channels per batch (create/delete) exceeds the limit (currently 100) |
| illegal category id: %s | Illegal channel category ID |
| category count reached the limit | Channel category count has reached the limit |
| category name already exists | A channel category with the same name already exists |
| can't change default category | Cannot modify the default channel category |
| polyv sms enabled close | Polyv SMS service is not allowed |
| disk not exist max rate video | The highest bitrate video for disk push stream does not exist |
| invalid live start time | Incorrect live start time |
| video format error | Incorrect video format for disk push stream, cannot use m3u8 videos |
| video id error | Video ID error |
| can't handle encrypted video | Cannot add encrypted videos for disk push stream |
| video play time error | Incorrect video play time for disk push stream (time is in the past) |
| video play time conflicts | Video play time conflicts for disk push stream |
| can't delete video playing | Cannot delete a video that is currently playing in a disk push stream |
| not pull stream | Current stream type is not pull stream, operation cannot be performed |
| can't change stream type during living | Cannot switch streaming method while live |
| invalid info fields type | Incorrect registration viewing field type |
| invalid auth type | Incorrect viewing condition type |
| info fields is empty | No registration fields have been created for registration viewing |
| none of the info fields are selected | No registration fields have been selected for registration viewing |
| info fields incomplete | Submitted field information is incomplete (field info arrays have different lengths) |
| the name type is unique | At most one field of the name type |
| whitelist is empty | No whitelist records exist when setting whitelist viewing method |
| whitelist excel parse error | Error parsing uploaded whitelist Excel records |
| whitelist excel no data | No data in the uploaded whitelist Excel records |
| invalid main auth | Incorrect primary viewing condition (cannot be share viewing) |
| invalid secondary auth | Incorrect secondary viewing condition (cannot be custom authorization or external authorization) |
| authSettings have the same type | Primary and secondary viewing conditions cannot be the same |
| secondary auth unsupported | Secondary viewing condition cannot be set when the primary condition is custom authorization or external authorization |
| illegal channel account | Illegal sub-channel ID |
| account count reached the limit | Sub-channel count has reached the limit |
| page turn account already exists | A sub-channel with PPT page turning permission already exists |
| monitor account already exists | A sub-account with a monitoring role already exists |
| invitation keyword already exists | A keyword with the same name already exists |
| round tour account already exists | A sub-channel with round-robin permission already exists |
| whitelist name exist | Whitelist name already exists |
| whitelist code exist | Whitelist already exists |
| round tour forbid | Cannot use round-robin function. The lecturer needs to exit the channel first to enable it: http://wiki.igeeker.org/pages/viewpage.action?pageId=36671050 |
| vod user not exist | The live user's VOD account does not exist |
| the user is expired | The live user's VOD account has expired |
| the user space is over | The live user's VOD account has insufficient space |
| record file not exist | Recorded video does not exist |
| record file transfer fail | Failed to transfer recorded video |
| record file format error | Incorrect merged recorded video format |
| record file cannot merge | Recorded files cannot be merged |
| record file m3u8 format not exist | The m3u8 format of the recorded video has not been generated yet |
| record file already transferred | Recorded video has already been transferred |
| vod video has been added: %s | VOD video has been added to the replay list |
| playback videoId error | Replay video ID error |
| playback video unable to sort | Replay video sequence number is at the boundary (first or last), cannot be moved up/down |
| playback video not exist | Replay video not found |
| playback video list is empty | Replay video list is empty |
| update playback video info error | Failed to update replay video information |
| illegal playback type | Incorrect live replay type |
| forbid open debugEnabled | Cannot enable test mode while the channel is live |
| illegal switch type | Illegal switch type |
| the switch in current scene is illegal | Feature switch restriction under the current scene |
| badwords excel parse error | Error parsing uploaded forbidden words Excel records |
| badwords excel no data | No data in the uploaded forbidden words Excel records |
| illegal withdraw id | Incorrect withdrawal order ID |
| account is frozen | Account is frozen |
| invalid withdraw amount | Incorrect withdrawal amount |
| invalid bank card info | Bank card information not yet bound |
| withdraw times over limit | Withdrawal times exceed the limit |
| withdraw info already exist | Bank card information already bound |
| illegal withdraw date | Incorrect withdrawal date |
| illegal operation: %s | Main channel is already pushing stream, stream switching not allowed |
| illegal questionId | Incorrect quiz question ID |
| illegal chat role | Incorrect chat room role |
| illegal banned type | Incorrect mute type |
| goods over limit | Incorrect number of donation items |
| goods name over limit | Item name exceeds the limit |
| goods image length over limit | Item image length exceeds the limit |
| illegal goods image | Illegal item image |
| upload files over limit | Number of uploaded files |
| record file m3u8 download fail | Failed to download the m3u8 of the record file |
| record file m3u8 extract ts message fail | Failed to get ts information from the record file m3u8 |
| record file clip m3u8 upload fail | Failed to upload the clipped m3u8 file |
| record file m3u8 upload fail | Failed to upload the temporary m3u8 file |
| there is only an one record file and not need merge | Only one file exists, no merge needed |
| record file m3u8 not exist | m3u8 file does not exist |
| illegal record file id | |
| illegal playback origin | Illegal replay source |
| invalid playback video | Video that cannot be used for courseware remastering |
| illegal ppt record type | |
| this ppt record task already exist | |
| illegal background url | Incorrect courseware remastering background URL, or transfer failed |
| playback video is using | Replay video in use cannot be deleted |
| check image porn fail | |
| record files 【%s】 missing mp4 | Recorded file missing mp4 |
| only support wx pay | Only WeChat Pay is supported |
| none redpack | Red packets have all been distributed |
| red pack expired | Red packet has expired |
| had join red pack | Already participated in the red packet rain |
| channel status already live | Cannot switch CDN while the channel is live |
| cdn type is not exist | The target CDN type does not exist |
| forbid switch cdn | Account does not have permission to switch CDN |
| trial user pay price over limit | Trial account's paid viewing amount exceeds the limit |
| channel enroll setting error | Incorrect channel registration viewing settings |
| enroll record not found | No registration viewing record found |
| missing required field | Missing required question |
| robot num over limit | Number of virtual users exceeds the limit |
| robot setting operate too frequent:%d | Number of virtual users exceeds the limit |
| whitelist validate error | Whitelist validation error, possibly multiple errors, shown in the returned data |
| illegal whitelist code | Whitelist member code is incorrect, same as channel ID or sub-channel ID |
| both watchEndTime and validTimePeriods has value | Paid viewing: both watchEndTime and validTimePeriods have values |
| img url error: %s | Image URL error |
| invalid account role type | Illegal sub-channel role type |
| guest account count reached the limit | Guest count has reached the limit |
| account role error | Sub-account permission error |
| oss callback params error | OSS callback parameter error |
| illegal oss upload type | Illegal OSS upload type |
| can't delete special menu type | Menu that cannot be deleted |
| menu id can't be empty | Menu ID cannot be empty |
| user pureRtc privilege is closed | User does not have permission for pure RTC pull stream channels |
| pureRtc currently only supports ppt scene | Pure RTC pull stream channels currently only support PPT live scenes |
| invalid bill type | Incorrect bill type |
| appId error | AppId error |
| live userId error | Live userId error |
| appSecret error | AppSecret error |
| user sms is error | User SMS configuration error |
| delete all tuwen live status fail | Cannot delete all text-and-image content while the channel is live |
| illegal tuwen content id | Illegal text-and-image live content ID |
| user tuwen live is closed | User's text-and-image live switch is off |
| content contains bad word:%s | Content contains forbidden words |
| video and channel scene mismatch | VOD video does not match the live channel scene |
| assistant monitorenabled is close | Assistant's monitoring switch is off |
| assistant account count reached the limit | Assistant count has reached the limit |
| transmit channel forbid use web-start | Relay channels cannot use web-based start |
| single receive channel forbid use web-start | Receive channels in single relay mode cannot use web-based start |
| language not support | Unsupported language type |
| translate text over size | Translated text is too long |
| chatTranslateEnabled is close | Chat translation switch is off |
| translate fail | Translation failed |
| openId is empty | WeChat openId is empty |
| sessionId is empty | Session ID is empty |
| no trial condition | Not a trial viewing condition |
| trial watch only apply to mobile weixin | Trial viewing is only available on mobile WeChat |
| viewer info empty | Viewer information is empty |
| channel donate setting error | Incorrect channel donation settings |
| like operate too frequent | Like action sent too frequently |
| record file MP4 not exist | MP4 file of the recorded video does not exist |
| clip time frame format error | Incorrect clip time frame format for recorded video |
| clip time frame over 100 limit | Clip time frame interval exceeds the 100 limit |
| record file clip timeFrame error | Incorrect time interval for temporary file clipping |
| failed to generate the policy | Initialization error |
| channelId is illegal | Illegal channel ID |
| fileId is empty | File ID is empty |
| file is not found | File does not exist |
| file delete occur an error | Error deleting file |
| fileName is empty | File name is empty |
| file type is wrong | Incorrect file type |
| add file record occur an error | Error adding file |
| illegal convert file status | Illegal file status |
| illegal convert type | Illegal conversion type |
| illegal ppt version type | Illegal PPT version type |
| illegal document fileId | Illegal file ID |
| delete ppt occur an error | Error deleting PPT |
| doc not found | Document not found |
| channel session stats can not be found | Live session data not found |
| channel session stats can not be generated | Live session data not yet generated |
| 服务端异常 | Used for unknown server-side errors |
| 系统繁忙 | Used for system errors during remote calls |
| illegal resource type | Incorrect video source type |
| video is not exist | Video does not exist |
| unsupport video | Unsupported video, no mp4 address |
| illegal seqId count | Layout does not match the number of video sequence IDs |
| layout already exist | Layout and video sequence already exist |
| illegal layout type | Incorrect layout template type |
| guide resource not exist | Video resource does not exist |
| guide layout not exist | Video layout does not exist |
| video already exist | VOD video has already been added |
| guide already start | Vision mixer has already started |
