修改角色資訊

更新時間：2023-03-29 14:41:14

介面描述

1、修改助教或嘉宾的信息
2、接口URL中的{channelId}为频道号
3、接口支持https协议

介面URL

http://api.polyv.net/live/v2/channelAccount/{channelId}/update

請求方式

POST

介面限制

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

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
account	true	String	助教/嘉賓帳號（不能以數字類型提交，否則可能去掉角色號前的00）
nickname	false	String	角色暱稱
password	false	String	角色密碼
avatar	false	String	角色頭像連結，不超過200個字元長度，超過將回傳400異常
actor	false	String	角色頭銜
pageTurnEnabled	false	String	角色翻頁權限，只能一個角色有，僅支援三分屏場景 Y：開啟 N：關閉
notifyEnabled	false	String	角色公告權限 Y：開啟 N：關閉

範例

http://api.polyv.net/live/v2/channelAccount/2191541/update

表單參數：

actor=%E5%8A%A9%E6%95%99&password=123456&pageTurnEnabled=Y&notifyEnabled=Y&appId=frlr1zazn3&nickname=%E9%99%88%E8%80%81%E5%B8%88&sign=08B5096C4EBA19C10750D4570004C9E1&avatar=https%3A%2F%2Fs1.videocc.net%2Fdefault-img%2Favatar%2Fassistant.png&account=0052191541&timestamp=1621841976967

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	String	請求成功時為success，請求失敗為空字串

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 testUpdateAccount() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v2/channelAccount/%s/update";
    String channelId = "2149710";
    String account = "0062149710";
    String nickname = "王老师";
    String password = getRandomString(10);
    String avatar = "https://s1.videocc.net/default-img/avatar/assistant.png";
    String actor = "助教";
    String pageTurnEnabled = "Y";
    String notifyEnabled = "Y";
    
    url = String.format(url, channelId);
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("account", account);
    requestMap.put("nickname", nickname);
    requestMap.put("password", password);
    requestMap.put("avatar", avatar);
    requestMap.put("actor", actor);
    requestMap.put("pageTurnEnabled", pageTurnEnabled);
    requestMap.put("notifyEnabled", notifyEnabled);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试设置角色信息，返回值：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

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

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}