結束偽直播
更新時間:2023-12-22 11:10:21
接口描述
1、结束当前正在直播中的伪直播
2、接口支持https协议
接口URL
http://api.polyv.net/live/v3/channel/stream/end-disk-push
請求方式
POST
接口限制
1、接口同時支援HTTP及HTTPS,建議使用HTTPS以確保接口安全,接口呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得密鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret密鑰作為通訊資料安全的關鍵資訊,嚴禁保存在客戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelId | true | String | 頻道號,僅支援正常延遲的純影片頻道設定偽直播 |
| diskVideoId | false | String | 偽直播id,不傳則結束目前時間直播中的偽直播 |
範例
http://api.polyv.net/live/v3/channel/stream/end-disk-push
表單參數:
appId=frlr1zazn3&sign=2A861BD280299A4D7E6FF556C77C88D2&channelId=2149710×tamp=1621843071824&diskVideoId=1dg53250a3
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| 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(ChannelOperateTest.class);
/**
* 停止伪直播
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void testEndDiskVideo() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/live/v3/channel/stream/end-disk-push";
String channelId = "2149710";
String diskVideoId = "1dg53250a3";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("diskVideoId", diskVideoId);
requestMap.put("channelId", channelId);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
String response = HttpUtil.postFormBody(url, requestMap);
log.info("测试停止伪直播,返回值:{}", response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code":200,
"status":"success",
"message":"",
"data":""
}
異常範例
{
"code": 400,
"status": "error",
"message": "invalid signature.",
"data": ""
}
