修改頻道角色權限設定
更新時間:2024-07-22 09:16:03
介面說明
1、修改频道角色权限设置
2、(timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
介面URL
https://api.polyv.net/live/v4/channel/role-config/update-by-role
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | true | Integer | 頻道號 |
| role | true | String | 角色類型 Teacher:講師、Guest:嘉賓 |
請求體參數說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| body | true | Object | 字幕資訊列表【詳見body參數字段說明】 |
body參數字段說明
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| webStartCheckInDisplayEnabled | false | String | 開播端簽到功能顯示開關 Y:開啟、N:關閉 |
| webStartLotteryDisplayEnabled | false | String | 開播端抽獎功能顯示開關 Y:開啟、N:關閉 |
| webStartQuestionnaireDisplayEnabled | false | String | 開播端問卷功能顯示開關 Y:開啟、N:關閉 |
| webStartAnswerDisplayEnabled | false | String | 開播端答題卡功能顯示開關 Y:開啟、N:關閉 |
| webStartTimerDisplayEnabled | false | String | 開播端定時器功能顯示開關 (角色類型為講師時有此欄位) Y:開啟、N:關閉 |
| webStartRedPackDisplayEnabled | false | String | 開播端紅包功能顯示開關 Y:開啟、N:關閉 |
| webStartCardPushDisplayEnabled | false | String | 開播端卡片推播功能顯示開關 Y:開啟、N:關閉 |
| webStartNotifyDisplayEnabled | false | String | 開播端公告功能顯示開關 Y:開啟、N:關閉 |
| webStartLinkMicDisplayEnabled | false | String | 開播端連麥功能顯示開關 Y:開啟、N:關閉 |
| webStartMultiMediaDisplayEnabled | false | String | 開播端多媒體功能顯示開關 Y:開啟、N:關閉 |
| webStartMembersDisplayEnabled | false | String | 開播端成員列表功能顯示開關 Y:開啟、N:關閉 |
| screenShareRetainCameraEnabled | false | String | 共享保持攝影機狀態開關 Y:開啟、N:關閉 |
| multiplexingDefaultLayout | false | String | 混流佈局預設套用 (角色類型為講師時有此欄位) 1:單人模式、2:平鋪模式、3:主講模式 |
| cameraSingleModeEnabled | false | String | 攝影機單人模式開關 Y:開啟、N:關閉 |
| aiVirtualBgUrl | false | String | AI去背背景圖 |
| remixDefaultEnabled | false | String | 混音預設開關 Y:開啟、N:關閉 |
| showSceneTemplateEnabled | false | String | 是否顯示場景模板開關 Y:開啟、N:關閉 |
| hideFramesDirectionEnabled | false | String | 隱藏畫面方向切換入口開關 Y:開啟、N:關閉 |
| defaultOpenMicLinkEnabled | false | String | 連麥預設方式 (角色類型為講師時可設定此欄位) video:音視訊、audio:音訊 |
範例
http://api.polyv.net/live/v4/channel/role-config/update-by-role?channelId=4872391&role=Teacher×tamp=1721291107000&appId=fso8gzbxlr&sign=D15AFF4476E348FC7F9ECE750B4C96F7
請求體json參數:
{
"webStartCheckInDisplayEnabled": "N"
}
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
| requestId | String | 請求ID,每次請求產生的唯一 UUID,僅可用於排查、除錯,不應該和業務掛鉤 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位描述】 |
| data | Object | 回傳內容 |
Error參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 錯誤代碼,用於確定具體的錯誤原因 |
| desc | String | 錯誤描述,與 error.code 對應 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、例外處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
* 修改频道角色权限
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void updateChannelRoleConfigTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
int channelId = 100033;
//业务参数
String url = "https://api.polyv.net/live/v4/channel/role-config/update-by-role";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelId", "4872391");
requestMap.put("role", "Teacher");
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
Map<String, Object> jsonMap = new HashMap<>();
jsonMap.put("webStartCheckInDisplayEnabled", "N");
String json = JSON.toJSONString(jsonMap);
String response = HttpUtil.postJsonBody(url, json, null);
log.info("测试修改频道角色权限设置成功:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例(測試範例頻道號已隱藏)
{
"code": 200,
"status": "success",
"requestId": "14138a5004b1412fbe109f854fec0b52.59.16538790171742883",
"data": "",
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360831818611581",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
