webInfo

更新時間：2025-10-29 14:26:06

1、設定頻道名稱

描述

设置频道名称
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channels/%s/update

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testUpdateChannelName() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelNameRequest liveUpdateChannelNameRequest = new LiveUpdateChannelNameRequest();
        Boolean liveUpdateChannelNameResponse;
        try {
            liveUpdateChannelNameRequest.setChannelId(createChannel())
                    .setName("Junit测试(勿删)");
            liveUpdateChannelNameResponse = new LiveWebInfoServiceImpl().updateChannelName(
                    liveUpdateChannelNameRequest);
            Assert.assertNotNull(liveUpdateChannelNameResponse);
            if (liveUpdateChannelNameResponse) {
                //to do something ......
                log.debug("测试设置频道名称成功");
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

單元測試說明

1、請求正確，回傳 Boolean 物件，B 端依據此物件處理業務邏輯；

2、請求參數驗證不合格，拋出 PloyvSdkException，錯誤資訊見 PloyvSdkException.getMessage()，如 [ 輸入參數 [xxx.chat.LivexxxRequest] 物件驗證失敗，失敗欄位 [pic 不能為空 / msg 不能為空] ]

3、伺服器處理異常，拋出 PloyvSdkException，錯誤資訊見 PloyvSdkException.getMessage()，如 [ 保利威請求回傳資料錯誤，請求流水號：66e7ad29fd04425a84c2b2b562d2025b，錯誤原因： invalid signature. ]

請求入參描述

參數名	必選	類型	說明
channelId	true	String	頻道號
name	true	String	修改後的頻道名稱
appId	false	String	POLYV 使用者 APP_ID，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）
appSecret	false	String	POLYV 使用者 APP_SECRET，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）

回傳物件描述

true 為設定成功，false 為設定失敗

2、設定主持人姓名

描述

设置主持人姓名
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/setPublisher

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testUpdateChannelPublisher() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelPublisherRequest liveUpdateChannelPublisherRequest = new LiveUpdateChannelPublisherRequest();
        Boolean liveUpdateChannelPublisherResponse;
        try {
            liveUpdateChannelPublisherRequest.setChannelId(createChannel())
                    .setPublisher("主讲老师");
            liveUpdateChannelPublisherResponse = new LiveWebInfoServiceImpl().updateChannelPublisher(
                    liveUpdateChannelPublisherRequest);
            Assert.assertNotNull(liveUpdateChannelPublisherResponse);
            if (liveUpdateChannelPublisherResponse) {
                //to do something ......
                log.debug("测试设置主持人姓名成功");
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

單元測試說明

1、請求正確，回傳 Boolean 物件，B 端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
channelId	true	String	頻道號
publisher	true	String	主持人姓名，不超過 20 個字元
appId	false	String	POLYV 使用者 APP_ID，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）
appSecret	false	String	POLYV 使用者 APP_SECRET，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）

回傳物件描述

true 為設定成功，false 為設定失敗

3、查詢直播引導圖開關狀態及 URL

描述

查询直播引导图开关状态及URL
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/getSplash

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetChannelSplash() throws Exception, NoSuchAlgorithmException {
        LiveChannelSplashRequest liveChannelSplashRequest = new LiveChannelSplashRequest();
        LiveChannelSplashResponse liveChannelSplashResponse;
        try {
            liveChannelSplashRequest.setChannelId(createChannel());
            liveChannelSplashResponse = new LiveWebInfoServiceImpl().getChannelSplash(liveChannelSplashRequest);
            Assert.assertNotNull(liveChannelSplashResponse);
            if (liveChannelSplashResponse != null) {
                //to do something ......
                log.debug("测试查询直播引导图开关状态及URL成功,{}", JSON.toJSONString(liveChannelSplashResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

單元測試說明

1、請求正確，回傳 LiveChannelSplashResponse 物件，B 端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
channelId	true	String	頻道號
appId	false	String	POLYV 使用者 APP_ID，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）
appSecret	false	String	POLYV 使用者 APP_SECRET，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）

回傳物件描述

參數名	類型	說明
splashImg	String	引導圖片 url
splashEnabled	String	引導功能開關，Y/N

4、設定頻道圖示

描述

设置频道图标
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/setCoverImg

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testUpdateChannelLogo() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelLogoRequest liveUpdateChannelLogoRequest = new LiveUpdateChannelLogoRequest();
        String liveUpdateChannelLogoResponse;
        try {
            String path = getClass().getResource("/img/elephant.png").getPath();
            liveUpdateChannelLogoRequest.setChannelId(createChannel())
                    .setImgfile(new File(path));
            liveUpdateChannelLogoResponse = new LiveWebInfoServiceImpl().updateChannelLogo(
                    liveUpdateChannelLogoRequest);
            Assert.assertNotNull(liveUpdateChannelLogoResponse);
            if (liveUpdateChannelLogoResponse != null) {
                //to do something ......
                log.debug("测试设置频道图标成功,{}", liveUpdateChannelLogoResponse);
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

單元測試說明

1、請求正確，回傳 String 物件，B 端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
channelId	true	String	頻道號
imgfile	true	File	圖片為大小 2MB 的 JPG、JPEG、PNG 圖片
appId	false	String	POLYV 使用者 APP_ID，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）
appSecret	false	String	POLYV 使用者 APP_SECRET，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）

回傳物件描述

成功回傳圖示地址，如：//livestatic.videocc.net/uploaded/images/2017/03/******.jpg

5、設定引導開關以及引導圖片

描述

设置引导开关以及引导图片
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/setSplash

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testUpdateChannelSplash() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelSplashRequest liveUpdateChannelSplashRequest = new LiveUpdateChannelSplashRequest();
        String liveUpdateChannelSplashResponse;
        try {
            String path = getClass().getResource("/img/elephant.png").getPath();
            liveUpdateChannelSplashRequest.setChannelId(createChannel())
//                    .setImgfile(new File(path))
                    .setSplashEnabled("Y");
            liveUpdateChannelSplashResponse = new LiveWebInfoServiceImpl().updateChannelSplash(
                    liveUpdateChannelSplashRequest);
            Assert.assertNotNull(liveUpdateChannelSplashResponse);
            if (liveUpdateChannelSplashResponse != null) {
                log.debug("设置引导开关以及引导图片成功,{}", liveUpdateChannelSplashResponse);
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

單元測試說明

1、請求正確，回傳 String 物件，B 端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
channelId	true	String	頻道號
splashEnabled	true	String	設定開啟或關閉引導頁 Y 或 N
imgfile	false	File	支援 jpg、jpeg、png 三種格式，大小不能超過 4Mb
appId	false	String	POLYV 使用者 APP_ID，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）
appSecret	false	String	POLYV 使用者 APP_SECRET，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）

回傳物件描述

設定引導頁未上傳圖片，成功回傳 success；設定引導頁同時上傳圖片；成功回傳地址，如：//xxx.videocc.net/uploaded/images/2017/03/******.jpg

6、查詢頻道點讚數和觀眾熱度值

描述

查询频道点赞数和观众热度值
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channels/live-likes

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetChannelLikes() throws Exception, NoSuchAlgorithmException {
        LiveChannelLikesRequest liveChannelLikesRequest = new LiveChannelLikesRequest();
        LiveChannelLikesResponse liveChannelLikesResponse;
        try {
            liveChannelLikesRequest.setChannelIds("1965681");
            liveChannelLikesResponse = new LiveWebInfoServiceImpl().getChannelLikes(liveChannelLikesRequest);
            Assert.assertNotNull(liveChannelLikesResponse);
            if (liveChannelLikesResponse != null) {
                //to do something ......
                log.debug("测试查询频道点赞数和观众热度值成功,{}", JSON.toJSONString(liveChannelLikesResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

單元測試說明

1、請求正確，回傳 LiveChannelLikesResponse 物件，B 端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
channelIds	true	String	用逗號隔開的頻道號，如：10000,100001 最多 20 個
appId	false	String	POLYV 使用者 APP_ID，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）
appSecret	false	String	POLYV 使用者 APP_SECRET，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）

回傳物件描述

參數名	類型	說明
channelLikes	Array	頻道點讚數和觀眾熱度值【詳見ChannelLikes參數描述】

ChannelLikes參數描述

參數名	類型	說明
channelId	String	頻道號
likes	Integer	頻道點讚數
viewers	Integer	頻道觀看熱度

7、設定頻道直播倒數計時資訊

描述

设置频道直播倒计时信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/set-countdown

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testUpdateChannelCountDown() throws Exception, NoSuchAlgorithmException {
        LiveUpdateChannelCountDownRequest liveUpdateChannelCountDownRequest = new LiveUpdateChannelCountDownRequest();
        Boolean liveUpdateChannelCountDownResponse;
        try {
            liveUpdateChannelCountDownRequest.setChannelId(createChannel())
                    .setBookingEnabled("Y")
                    .setStartTime(getDate(2020, 11, 11, 11, 11, 11));
            liveUpdateChannelCountDownResponse = new LiveWebInfoServiceImpl().updateChannelCountDown(
                    liveUpdateChannelCountDownRequest);
            Assert.assertTrue(liveUpdateChannelCountDownResponse);
            if (liveUpdateChannelCountDownResponse) {
                //to do something ......
                log.debug("测试设置频道直播倒计时信息成功");
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

單元測試說明

1、請求正確，回傳 Boolean 物件，B 端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
channelId	true	String	頻道號
bookingEnabled	false	String	預約觀看開關 Y 或 N
startTime	false	Date	直播開始時間，如果不傳該值，表示不顯示直播時間和倒數計時（yyyy-MM-dd HH:mm:ss）
appId	false	String	POLYV 使用者 APP_ID，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）
appSecret	false	String	POLYV 使用者 APP_SECRET，多帳號呼叫時該參數必填（即呼叫了 initMultiAccount() 設定多帳號呼叫），透過註冊保利威官網取得，路徑：官網->登入->直播（開發設定）

回傳物件描述

true 為設定成功，false 為設定失敗

8、查詢頻道直播倒數計時資訊

描述

查询频道直播倒计时信息
接口地址（仅做说明使用）：https://api.polyv.net/live/v2/channelSetting/%s/get-countdown

呼叫限制

1、介面呼叫有頻率限制，詳細請查看，呼叫常見異常，詳細請查看

單元測試

    @Test
    public void testGetChannelCountDown() throws Exception, NoSuchAlgorithmException {
        LiveChannelCountDownRequest liveChannelCountDownRequest = new LiveChannelCountDownRequest();
        LiveChannelCountDownResponse liveChannelCountDownResponse;
        try {
            liveChannelCountDownRequest.setChannelId(createChannel());
            liveChannelCountDownResponse = new LiveWebInfoServiceImpl().getChannelCountDown(
                    liveChannelCountDownRequest);
            Assert.assertNotNull(liveChannelCountDownResponse);
            if (liveChannelCountDownResponse != null) {
                //to do something ......
                log.debug("测试查询频道直播倒计时信息成功,{}", JSON.toJSONString(liveChannelCountDownResponse));
            }
        } catch (PloyvSdkException e) {
            //参数校验不合格 或者 请求服务器端500错误，错误信息见PloyvSdkException.getMessage()
            log.error(e.getMessage(), e);
            // 异常返回做B端异常的业务逻辑，记录log 或者 上报到ETL 或者回滚事务
            throw e;
        } catch (Exception e) {
            log.error("SDK调用异常", e);
            throw e;
        }
    }

單元測試說明

1、請求正確，回傳 LiveChannelCountDownResponse 物件，B 端依據此物件處理業務邏輯；

請求入參描述

參數名	必選	類型	說明
channelId	true	String	頻道號
appId	false	String	POLYV 使用者 APP_ID，多帳號呼叫時