修改課節狀態為禁止上課

更新時間：2024-10-21 09:33:43

接口描述

1、禁止课节上课，禁止有效期为24小时，24小时后会恢复课节允许上课（如果课节已到达下课时间，则不允许再上课）
2、接口URL中的{lessonId}为课节号
3、接口支持https协议

接口URL

http://api.polyv.net/hi-class-api/open/lesson/v1/{lessonId}/cutoff

請求方式

POST

接口約束

1、接口同時支援HTTP 、HTTPS ，建議使用HTTPS 確保接口安全，接口呼叫有頻率限制，詳細請查看

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見獲取金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值【詳見簽名生成規則】
userId	true	String	POLYV用戶ID，與保利威官網一致，獲取路徑：官網->登入->直播（開發設定）

範例

http://api.polyv.net/hi-class-api/open/lesson/v1/11687/cutoff

表單參數：

appId=fyirmfdak4&timestamp=1636339754708&sign=F79C16196B1E8DE8DF474B4E1034875B&userId=17e1c4f329

響應參數描述

參數名	類型	說明
code	Integer	響應狀態碼，200為成功返回，非200為失敗【詳見全局錯誤說明】
status	String	響應狀態文字資訊
error	Error	錯誤物件【詳見全局錯誤說明】
data	Object	請求失敗時為空，請求成功時為修改狀態相應結果【詳見data字段描述】

data字段描述

參數名	類型	說明
status	boolean	操作狀態。true：成功；false：失敗

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(ChannelStateTest.class);
/**
 * 禁止直播频道推流
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testCutoff() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/hi-class-api/open/lesson/v1/%s/cutoff";
    String lessonId = "11687";
    
    url = String.format(url, lessonId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("userId", userId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("修改课节状态为禁止上课，返回值：{}", response);
    //do somethings
    
}

響應範例

系統全局錯誤說明詳見全局錯誤說明

成功範例

{
  "code": 200,
  "status": "success",
  "data": {
    "status": true
  },
  "success": true
}

異常範例

{
  "code": 400,
  "status": "error",
  "error": {
    "code": 1012,
    "desc": "输入的userId有误"
  },
  "data": null,
  "success": false
}