保利威文档中心

幫助中心

修改輪詢監控帳號資訊

更新時間:2022-09-02 18:08:07

介面描述

1、修改轮询监控账号信息
2、(channelId, timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

https://api.polyv.net/live/v4/seminar/monitor/update

請求方式

POST

介面限制

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

請求參數描述

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

請求體參數描述

參數名 必選 類型 說明
id true Integer 監控輪詢帳號
nickname false String 監播員暱稱,支援1-16位長度(不傳則不修改)
password false String 密碼,支援6-16位長度(不傳則不修改)

範例

https://api.polyv.net/live/v4/seminar/monitor/update?appId=fyirmfdak4&timestamp=1657786379352&sign=CEA301164F9BA5076F156C1EB60F22F8&channelId=2191532

回應參數描述

參數名 類型 說明
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(UpdateAccountPost.class);
/**
 * 查询分组记录
 * @throws IOException
 */
@Test
public void testUpdateAccountPost() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId=super.appId;
        String appSecret=super.appSecret;
        String userId = super.userId;
        String timestamp=String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "api.polyv.net/live/v4/seminar/monitor/update";
        String channelId = "2191532";
        String body = "{\n" +
        "    \"enable\":\"N\"\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": "faeae397448d4c5f988b278256cbc487.60.16591497134900021",
  "data": null,
  "success": true
}

異常範例

{
  "code": 400,
  "status": "error",
  "error": {
    "code": 10003,
    "desc": "时间戳过期"
  },
  "success": false
}
{
  "code": 403,
  "status": "error",
  "error": {
    "code": 10002,
    "desc": "签名错误"
  },
  "success": false
}
{
  "code": 400,
  "status": "error",
  "requestId": "faeae397448d4c5f988b278256cbc487.66.16591497085220019",
  "error": {
    "code": 1081,
    "desc": "没有监控轮询权限"
  },
  "data": null,
  "success": false
}
{
  "code": 400,
  "status": "error",
  "requestId": "b7463368632042daaf4d700631dda9e1.70.16593213159150141",
  "error": {
    "code": 50101,
    "desc": "监控轮询账号不存在"
  },
  "data": null,
  "success": false
}
{
  "code": 400,
  "status": "error",
  "requestId": "b7463368632042daaf4d700631dda9e1.69.16593219092970191",
  "error": {
    "code": 10001,
    "desc": "密码长度为6~16"
  },
  "data": null,
  "success": false
}
{
  "code": 400,
  "status": "error",
  "requestId": "b7463368632042daaf4d700631dda9e1.66.16593219248760193",
  "error": {
    "code": 10001,
    "desc": "昵称长度为1~16"
  },
  "data": null,
  "success": false
}
联系客服,在线咨询