保利威文档中心

幫助中心

修改預設模板角色權限設定

更新時間:2024-07-22 09:16:03

介面描述

1、修改角色权限默认模板设置
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/template/role-config/update

線上API呼叫

請求方式

POST

介面限制

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

請求參數描述

參數名 必選 類型 說明
appId true String 帳號appId【詳見取得金鑰
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
timestamp true String 目前13位毫秒級時間戳記,3分鐘內有效

請求體參數描述

參數名 必選 類型 說明
teacherConfig false Object 講師角色權限設定【詳見TeacherConfig參數描述
guestConfig false Object 嘉賓角色權限設定【詳見GuestConfig參數描述

TeacherConfig參數描述

參數名 必選 類型 說明
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:音訊

GuestConfig參數描述

參數名 必選 類型 說明
webStartCheckInDisplayEnabled false String 開播端簽到功能顯示開關 Y:開啟、N:關閉
webStartLotteryDisplayEnabled false String 開播端抽獎功能顯示開關 Y:開啟、N:關閉
webStartQuestionnaireDisplayEnabled false String 開播端問卷功能顯示開關 Y:開啟、N:關閉
webStartAnswerDisplayEnabled 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:關閉
cameraSingleModeEnabled false String 攝影機單人模式開關 Y:開啟、N:關閉
aiVirtualBgUrl false String AI去背背景圖
remixDefaultEnabled false String 混音預設開關 Y:開啟、N:關閉
showSceneTemplateEnabled false String 是否顯示場景模板開關 Y:開啟、N:關閉
hideFramesDirectionEnabled false String 隱藏畫面方向切換入口開關 Y:開啟、N:關閉

範例

http://api.polyv.net/live/v4/user/template/role-config/update?appId=frlr1zazn3&sign=9C73C7471CF969AD8AC042221C89551D&timestamp=1677167340447

請求體json參數:

{
    "teacherConfig": {
        "webStartCheckInDisplayEnabled": "N"
    }
}

回應參數描述

參數名 類型 說明
code Integer 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態
data Object 成功回應的資料
error Object 狀態碼非200時的錯誤資訊【詳見Error參數描述
requestId String 請求ID,每次請求產生的唯一的 UUID,僅可用於排查、除錯,不應該和業務掛上鉤
status String 回應結果,由業務決定,成功回傳success,失敗回傳error
success Boolean 是否成功回應

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(getClass());
/**
* 修改角色权限默认模板设置
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void updateRoleConfigTemplateTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/live/v4/user/template/role-config/update";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);

    Map<String, Object> teacherConfigMap = new HashMap<>();
    teacherConfigMap.put("webStartCheckInDisplayEnabled", "N");

    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("teacherConfig", teacherConfigMap);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);

    log.info("测试修改角色权限默认模板设置成功:{}", response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "a5e9b1d15f544d7a9db6f038156a851d.71.16771673423081591",
    "data": null,
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询