全域錯誤說明
更新時間：2021-09-28 14:08:02
回傳資訊範例
請求API正確返回：
{
"code": 200,
"status": "success",
"message": "",
"data": ""
}
請求 API 欄位驗證錯誤回傳：
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
請求API業務邏輯處理錯誤返回：
{
"code": 500,
"status": "fail",
"message": "access forbidden",
"data": ""
}
各欄位含義：
| 名稱 | 類型 | 含義 |
|---|---|---|
| code | Integer | 回應狀態碼，具體對應關係如下 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊，當 code 為 400 或 500 時，輔助描述錯誤原因，具體參考錯誤資訊對照表 |
錯誤碼描述
| code | status | message |
|---|---|---|
| 200 | success | 表示業務處理成功，該欄位為空字串 |
| 40X（X為任意數字） | error | 表示欄位驗證錯誤，錯誤訊息表示具體的錯誤欄位描述資訊，例如 簽名不可用（invalid signature.） |
| 500 | fail | 表示伺服器業務邏輯處理錯誤，錯誤訊息為具體的業務邏輯處理錯誤資訊，例如權限不足（access forbidden） |
Message 詳細資訊解釋對照表
| message | 含義解釋 |
|---|---|
| undefined error | 未知錯誤 |
| need to login | 未登入 |
| access forbidden | 禁止存取 |
| redirect | 需要重新導向到某個 URL（輸出重新導向 URL 到 data.url 中） |
| illegal operation | 非法的操作 |
| channel id or password error | 登入時，頻道號或密碼錯誤 |
| conflict with user login | 教師登入時，與使用者登入狀態衝突 |
| illegal stream status | 串流狀態錯誤 |
| illegal domain | 非法的 liveDomain |
| channel forbid login | 頻道的登入開關關閉，禁止登入 |
| channel already login | 已有使用者登入，請稍後再試 |
| channel in live | 該頻道正在直播，請稍後再試 |
| channel in no live | 該頻道不在直播，請稍後再試 |
| please user pure video scene channel login | 純影片登入 |
| qps exceeds number of calls | qps 超出呼叫數量 |
| invalid date time format | 非法的日期格式 |
| param validate error | 參數驗證錯誤 |
| param should not be empty: %s | 參數值為空 |
| param is not digit: %s | 參數不是非負整數 |
| param is not number: %s | 參數值不是數字 |
| param length is incorrect: %s | 參數值長度不正確 |
| number range error | 數值範圍錯誤 |
| json format error | 參數不是 json 格式，或者缺少 json 欄位，或者 json 欄位類型錯誤 |
| param exceeds maximum value of integer: %s | 參數超過了整數數值範圍 |
| param is not color | 參數不是顏色值 |
| param is not boolean (Y / N) | 參數不是布林值 (Y/N) |
| param is not date normal format | 參數不是正確的 yyyy-MM-dd 日期格式 |
| invalid globalEnabledType:%s | 參數不是正確的 GlobalEnabledType |
| invalid date format | 日期格式錯誤通用回傳 |
| date range error | 日期範圍錯誤 |
| date error | 日期格式錯誤 |
| array param empty or exist empty element | 陣列中存在空字串 |
| arrays length are not equal | 陣列長度不相等 |
| incorrect protocol | 錯誤協定頭 |
| 暱稱已存在：%s | 暱稱重複 |
| invalid email | 非法電子郵件 |
| param invalid %s | 參數非法 |
| invalid role | 錯誤的後台角色類型 |
| invalid roomId | 錯誤的聊天室房間號 |
| invalid billingPlan | 錯誤的直播方案類型 |
| invalid rtc record type | 錯誤的直播 rtc 錄製類型 |
| invalid bill trade type | 非法帳單交易類型 |
| invalid bill status | 非法帳單狀態 |
| invalid channel list order | 錯誤的頻道列表排序值 |
| invalid live scene | 錯誤的直播場景 |
| invalid menu type | 錯誤的選單類型 |
| menu already exist | 選單已經存在 |
| menu count reached the limit | 選單數達到上限 |
| illegal menu id: %s | 非法的頻道頁面選單 Id |
| invalid marquee type | 跑馬燈類型錯誤 |
| invalid player logo position | 錯誤的播放器 logo 圖片位置 |
| invalid live player skin | 錯誤的直播播放器面板值 |
| invalid stream type | 錯誤的直播方式串流類型 |
| invalid warmup type | 錯誤的暖場類型 |
| invalid menu url content | 錯誤的影片來源類型 |
| invalid watch skin type | 錯誤的觀看頁面板類型 |
| invalid live player type | 錯誤的直播播放器類型 |
| invalid lottery range type | 錯誤的抽獎候選人類型 |
| invalid sms service type | 錯誤的簡訊服務商類型 |
| invalid watch layout type | 錯誤的觀看頁佈局類型 |
| invalid watch template type | 錯誤的觀看頁模板類型 |
| confirm password inconsistency | 新密碼和確認密碼不一致 |
| old password error | 舊密碼錯誤 |
| invalid donate type | 錯誤的打賞類型 |
| invalid advert kind | 錯誤的廣告類型 AdvertKind |
| invalid advert type | 錯誤的廣告類型 AdvertType |
| invalid income type | 錯誤的收入類型 |
| invalid viewlog type | 錯誤的觀看日誌類型 |
| invalid disk video lang type | 錯誤的硬碟推流語言類型 |
| upload file size exceeds the limit | 上傳的檔案大小超過限制 |
| upload file format error: %s | 上傳檔案的格式錯誤 |
| channel status not live | 頻道暫無直播 |
| channel not found. | channel 沒有找到 |
| illegal channel id: %s | 非法的頻道號 |
| channel is unavailable | 頻道已關閉 |
| kaptcha error | 圖片驗證碼錯誤 |
| sms code error | 簡訊驗證碼錯誤 |
| send sms code too frequent | 簡訊驗證碼發送頻繁 |
| illegal lottery id: %s | 非法的抽獎記錄 ID |
| user not found. | user 沒有找到 |
| slide verification error | 滑動驗證錯誤 |
| channel count reached the limit | 頻道數達到上限 |
| channel batch count over limit | 批次建立、刪除頻道時，每批次的頻道數超過限制（目前為 100） |
| illegal category id: %s | 非法的頻道分類 ID |
| category count reached the limit | 頻道分類數達到上限 |
| category name already exists | 已存在同名的頻道分類 |
| can't change default category | 不能修改預設頻道分類 |
| polyv sms enabled close | 不允許使用保利威簡訊服務 |
| disk not exist max rate video | 硬碟推流最高碼率的影片不存在 |
| invalid live start time | 錯誤的直播開始時間 |
| video format error | 硬碟推流的影片格式錯誤，不能使用 m3u8 的影片 |
| video id error | 影片 ID 錯誤 |
| can't handle encrypted video | 硬碟推流影片，不能加入加密影片 |
| video play time error | 硬碟推流影片，播放時間錯誤（為過去的時間） |
| video play time conflicts | 硬碟推流影片，播放時間段衝突 |
| can't delete video playing | 硬碟推流影片，無法刪除直播中的影片 |
| not pull stream | 目前串流類型不是拉流，無法進行操作 |
| can't change stream type during living | 直播狀態時不能切換直播方式 |
| invalid info fields type | 登記觀看欄位類型錯誤 |
| invalid auth type | 錯誤的觀看條件類型 |
| info fields is empty | 登記觀看沒有建立登記欄位 |
| none of the info fields are selected | 登記觀看沒有勾選登記欄位 |
| info fields incomplete | 提交欄位資訊不完整（各欄位資訊陣列長度不一致） |
| the name type is unique | 名字類型的欄位最多只有一個 |
| whitelist is empty | 設定白名單觀看方式時，沒有白名單記錄 |
| whitelist excel parse error | 上傳的白名單表格記錄解析錯誤 |
| whitelist excel no data | 上傳的白名單表格記錄沒有資料 |
| invalid main auth | 主要觀看條件錯誤（不能為分享觀看） |
| invalid secondary auth | 次要觀看條件錯誤（不能為自定授權觀看或外部授權） |
| authSettings have the same type | 主要觀看條件和次要觀看條件不能相同 |
| secondary auth unsupported | 主要條件為自訂授權或者外部授權時，不能設定次要觀看條件 |
| illegal channel account | 非法的子頻道號 |
| account count reached the limit | 子頻道的數量達到上限 |
| page turn account already exists | 已存在子頻道開啟 PPT 翻頁權限 |
| monitor account already exists | 已經存在其他監聽角色的子帳號 |
| invitation keyword already exists | 已存在相同的關鍵字 |
| round tour account already exists | 已存在子頻道開啟輪訓權限 |
| whitelist name exist | 白名單名稱已存在 |
| whitelist code exist | 白名單已存在 |
| round tour forbid | 無法使用輪巡功能，開啟輪巡功能需要講師先退出頻道：http://wiki.igeeker.org/pages/viewpage.action?pageId=36671050 |
| vod user not exist | 直播用戶的點播帳號不存在 |
| the user is expired | 直播用戶的點播帳號已過期 |
| the user space is over | 直播用戶的點播帳號空間不足 |
| record file not exist | 錄製影片不存在 |
| record file transfer fail | 錄製影片轉存失敗 |
| record file format error | 合併的錄製影片格式錯誤 |
| record file cannot merge | 錄製檔案無法合併 |
| record file m3u8 format not exist | 錄製影片的 m3u8 格式還未產生 |
| record file already transferred | 錄製影片已經轉存過 |
| vod video has been added: %s | 點播影片已經加入到回放清單 |
| playback videoId error | 回放影片 ID 錯誤 |
| playback video unable to sort | 回放影片序號在邊界（最前或最後），無法上移/下移排序 |
| playback video not exist | 回放影片沒有找到 |
| playback video list is empty | 回放影片沒有找到 |
| update playback video info error | 更新回放影片資訊失敗 |
| illegal playback type | 錯誤的直播回放類型 |
| forbid open debugEnabled | 頻道直播時不能開啟測試模式 |
| illegal switch type | 非法的開關類型 |
| the switch in current scene is illegal | 場景下的功能開關限制 |
| badwords excel parse error | 上傳的嚴禁詞表格記錄解析錯誤 |
| badwords excel no data | 上傳的嚴禁詞表格記錄沒有資料 |
| illegal withdraw id | 提現訂單號錯誤 |
| account is frozen | 帳戶被凍結 |
| invalid withdraw amount | 提現金額錯誤 |
| invalid bank card info | 尚未綁定銀行卡資訊 |
| withdraw times over limit | 提現次數超過限制 |
| withdraw info already exist | 已經綁定過銀行卡資訊 |
| illegal withdraw date | 提現日期錯誤 |
| illegal operation: %s | 主頻道已經在推流，不允許切流 |
| illegal questionId | 錯誤的答題題目 ID |
| illegal chat role | 錯誤的聊天室角色 |
| illegal banned type | 錯誤的禁言類型 |
| goods over limit | 錯誤打賞道具數量 |
| goods name over limit | 道具名稱超過限制 |
| goods image length over limit | 道具圖片長度超過限制 |
| illegal goods image | 非法道具圖片 |
| upload files over limit | 上傳檔案個數 |
| record file m3u8 download fail | 下載 recordfile 的 m3u8 失敗 |
| record file m3u8 extract ts message fail | 取得 recordfile m3u8 的 ts 資訊失敗 |
| record file clip m3u8 upload fail | 上傳暫存檔案剪輯後的 m3u8 檔案失敗 |
| record file m3u8 upload fail | 上傳暫存 m3u8 檔案失敗 |
| there is only an one record file and not need merge | 只有一個檔案不需要合併 |
| record file m3u8 not exist | m3u8 檔案不存在 |
| illegal record file id | |
| illegal playback origin | 非法的回放來源 |
| invalid playback video | 不能課件重製的影片 |
| illegal ppt record type | |
| this ppt record task already exist | |
| illegal background url | 課件重製背景圖位址錯誤，或轉存失敗 |
| playback video is using | 正在使用的回放不能被刪除 |
| check image porn fail | |
| record files 【%s】 missing mp4 | 錄製檔案缺少 mp4 |
| only support wx pay | 只支援微信支付 |
| none redpack | 紅包已派發完 |
| red pack expired | 紅包已過期 |
| had join red pack | 已參加過紅包雨 |
| channel status already live | 切換 cdn，頻道還是直播狀態不允許切換 |
| cdn type is not exist | 要切換的 cdn 類型不存在 |
| forbid switch cdn | 帳號沒有切換 cdn 的權限 |
| trial user pay price over limit | 試用帳號的付費觀看金額超過限制 |
| channel enroll setting error | 頻道報名觀看設定錯誤 |
| enroll record not found | 沒有報名觀看記錄 |
| missing required field | 缺少必填題目 |
| robot num over limit | 虛擬用戶數量超過限制 |
| robot setting operate too frequent:%d | 虛擬用戶數量超過限制 |
| whitelist validate error | 白名單驗證錯誤，可能存在多種情況的錯誤，在回傳的 data 裡面顯示 |
| illegal whitelist code | 白名單的會員碼錯誤，與頻道號或者子頻道號相同 |
| both watchEndTime and validTimePeriods has value | 付費觀看，watchEndTime 和 validTimePeriods 同時有值 |
| img url error: %s | 圖片 url 錯誤 |
| invalid account role type | 非法的子頻道角色類型 |
| guest account count reached the limit | 已達嘉賓人數上限 |
| account role error | 子帳號權限錯誤 |
| oss callback params error | oss 回呼參數錯誤 |
| illegal oss upload type | 非法的 oss 上傳類型 |
| can't delete special menu type | 不能刪除的選單 |
| menu id can't be empty | 選單 id 不能為空 |
| user pureRtc privilege is closed | 用戶沒有開啟純 RTC 拉流頻道的權限 |
| pureRtc currently only supports ppt scene | 純 rtc 拉流頻道目前僅支援 ppt 直播場景 |
| invalid bill type | 錯誤的帳單類型 |
| appId error | appId 錯誤 |
| live userId error | 直播 userId 錯誤 |
| appSecret error | appSecret 錯誤 |
| user sms is error | 用戶簡訊設定錯誤 |
| delete all tuwen live status fail | 頻道直播時不能刪除全部圖文 |
| illegal tuwen content id | 非法的圖文直播內容 ID |
| user tuwen live is closed | 用戶的圖文直播開關關閉 |
| content contains bad word:%s | 內容包含嚴禁詞 |
| video and channel scene mismatch | 點播影片與直播頻道場景不匹配 |
| assistant monitorenabled is close | 助教的監播開關為關閉 |
| assistant account count reached the limit | 已達助教人數上限 |
| transmit channel forbid use web-start | 轉播頻道不能使用網頁開播 |
| single receive channel forbid use web-start | 單人轉播模式下的接收頻道不能使用網頁開播 |
| language not support | 不支援的語言類型 |
| translate text over size | 翻譯的語句長度過長 |
| chatTranslateEnabled is close | 聊天翻譯開關關閉 |
| translate fail | 翻譯失敗 |
| openId is empty | 微信 openId 為空 |
| sessionId is empty | 場次 ID 為空 |
| no trial condition | 非試看條件 |
| trial watch only apply to mobile weixin | 試看必須在行動端微信 |
| viewer info empty | 觀眾資訊為空 |
| channel donate setting error | 頻道打賞設定錯誤 |
| like operate too frequent | 按讚發送頻繁 |
| record file MP4 not exist | 錄製影片的 MP4 檔案不存在 |
| clip time frame format error | 錄製影片的裁剪時段格式錯誤 |
| clip time frame over 100 limit |
