查詢頻道微信分享資訊（新版）

更新時間：2025-07-04 13:49:58

介面描述

1、查询频道微信分享信息，对应新版后台的 营销-分享设置
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/share/get

線上API呼叫

請求方式

GET

介面限制

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

請求參數說明

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

範例

http://api.polyv.net/live/v4/channel/share/get?appId=frlr1zazn3&sign=AFEFF406F3E243B7F3882B0616685448&channelId=2567762&timestamp=1632818971891

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗
status	String	回應結果，由業務決定，成功返回success，失敗返回error
success	Boolean	回應結果，由業務決定，成功返回true，失敗返回false
data	Object	成功回應時返回頻道分享資訊【詳見Data欄位說明】
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求產生的唯一UUID，僅可用於排查、除錯，不應與業務掛鉤

Error參數說明

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

Data參數說明

參數名	類型	說明
shareBtnEnable	String	是否開啟分享，Y：開啟，N：關閉
titleType	String	標題類型follow直播標題、custom自訂
weixinShareTitle	String	分享標題，最大長度50，標題類型為custom時，該欄位生效
weixinShareDesc	String	分享簡介，最大長度120，標題類型為custom時，該欄位生效
weixinShareCustomUrl	String	微信自訂分享位址，最大長度512
webShareCustomUrl	String	網頁觀看自訂分享位址，最大長度512
weixinShareCustomUrlWithParamEnabled	String	微信觀看自訂位址攜帶分享者參數，Y：開啟，N：關閉
webShareCustomUrlWithParamEnabled	String	網頁觀看自訂位址攜帶分享者參數開關，Y：開啟，N：關閉

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點擊下載原始碼，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

    private static final Logger log = LoggerFactory.getLogger(ChannelShareTest.class);

    @Test
    public void testGetChannelShare() throws IOException, NoSuchAlgorithmException {
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "http://api.polyv.net/live/v4/channel/share/get";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("channelId", "2567762");
        
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        
        String response = HttpUtil.get(url,requestMap);
        
        log.info("测试查询频道分享设置，返回值：{}", response);
    }

回應範例

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "779ef4fc-0690-463f-ae1e-59f4bc792be4",
    "data": {
        "shareBtnEnable": "Y",
        "titleType": "custom",
        "weixinShareTitle": "保利威测试微信分享标题",
        "weixinShareDesc": "保利威测试微信分享描述",
        "weixinShareCustomUrl": "httPs://polyv.com",
        "webShareCustomUrl": ""
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.117.16360830804996119",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}