修改管理員身分資訊
更新時間:2022-09-02 18:08:07
介面描述
1、通过频道号,修改管理员信息,提交参数都不能为空
2、接口URL中的{channelId}为"频道号"
3、(actor, nickname, timestamp, appId)参与sign签名,并和sign一起通过post表单传递,文件通过二进制流提交到服务器端。
4、接口支持https协议
介面URL
http://api.polyv.net/live/v2/channelSetting/{channelId}/set-chat-admin
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| nickname | true | String | 管理員暱稱,長度不能超過8 |
| actor | true | String | 管理員頭銜,長度不能超過4 |
| avatar | true | File | 管理員頭像,支援jpg、jpeg、png三種格式,大小不能超過2Mb |
範例
http://api.polyv.net/live/v2/channelSetting/2191569/set-chat-admin
表單參數:
actor=管理员1&appId=frlr1zazn3&nickname=张三&sign=FA7ABEBFC204253D6E44699DD8C84866×tamp=1616644515871
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | String | 請求失敗時為空,請求成功時為"修改成功" |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。
強烈建議您使用直播Java SDK完成API的功能對接,直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(ChatRoleTest.class);
/**
* 修改管理员身份信息
* @throws IOException
*/
@Test
public void testUpdateAdminInfo() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String channelId = "2191569";
String url = "http://api.polyv.net/live/v2/channelSetting/"+channelId+"/set-chat-admin";
String nickname = "张三";
String actor = "管理员1";
File avatar = new File("/Users/apple/Documents/证件照/证件照1.jpeg");
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("nickname",nickname);
requestMap.put("actor",actor);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
Map<String, File> fileMap = new HashMap<String, File>();
fileMap.put("avatar",avatar);
String response = HttpUtil.postFile(url,requestMap,fileMap,"UTF-8");
log.info("测试修改管理员身份信息接口返回值:{}",response);
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "",
"data": "修改成功"
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
