修改研討會會議類型
更新時間:2023-02-22 10:48:49
介面描述
1、修改研讨会会议类型
2、(channelId, timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
介面URL
https://api.polyv.net/meet/v1/channel/live-type/update
請求方式
POST
介面限制
1、介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值【詳見簽名產生規則】 |
| channelId | true | String | 頻道號 |
請求體參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| seminarLiveType | true | String | 會議類型 private 對內研討 public 對外直播 |
範例
https://api.polyv.net/meet/v1/channel/live-type/update?appId=frlr1zazn3&sign=B6424CE5E5D94BB795BC7B3AA6058949&channelId=3589029×tamp=1677033522629
請求體參數:
{
"seminarLiveType":"public"
}
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 狀態碼,與 http 狀態碼相同,用於確定基本的回應狀態 |
| status | String | 回應結果,由業務決定,成功回傳success,失敗回傳error |
| success | Boolean | 是否成功回應 |
| requestId | String | 請求ID,每次請求產生的唯一的 UUID,僅可用於排查、除錯,不應該和業務掛鉤 |
| error | Object | 狀態碼非200時的錯誤資訊【詳見Error欄位描述】 |
| data | Object | 失敗原因,失敗時回傳。成功時為空【詳見data欄位說明】 |
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(LiveTypeUpdate.class);
/**
* 修改研讨会会议类型
* @throws IOException
*/
@Test
public void testUpdateLiveType() 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/meet/v1/channel/live-type/update";
String channelId = "3589029";
String body = "{\n" +
" \"seminarLiveType\":\"public\"\n" +
"}";
//http 调用逻辑
Map<String,String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp",timestamp);
requestMap.put("channelId",channelId);
requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postJsonBody(url, body, null);
log.info("测试修修改研讨会会议类型接口返回值:{}",response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"requestId": "82c0b2fba8a940419c75540f3fb6a635.64.16652796585214411",
"data": null,
"success": true
}
異常範例
{
"code": 400,
"status": "error",
"requestId": "82c0b2fba8a940419c75540f3fb6a635.60.16652797835524421",
"error": {
"code": 10001,
"desc": "研讨会直播类型不正确"
},
"data": null,
"success": false
}
{
"code": 400,
"status": "error",
"requestId": "6fa092a476ba43f3962c62de38557321.74.16652797988577027",
"error": {
"code": 30005,
"desc": "非法频道ID: 2665820"
},
"success": false
}
{
"code": 400,
"status": "error",
"requestId": "c4920bc4c27e40e18a8a9241d462450a.64.16653728084970005",
"error": {
"code": 125001,
"desc": "研讨中不允许修改配置"
},
"data": null,
"success": false
}
