保利威文档中心

幫助中心

修改頻道微信分享資訊(舊版)

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

介面說明

1、修改频道的微信分享相关设置
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/weixin-share/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 String 頻道號
weixinShareTitle false String 微信分享的標題(30字元內),預設為:頻道標題
weixinShareDesc false String 微信分享的描述(120字元內),預設為:正在直播,非常不錯喔!快來看看吧!

範例

http://api.polyv.net/live/v3/channel/weixin-share/update

表單參數:

weixinShareDesc=qweqwe&appId=frlr1zazn3&weixinShareTitle=qwe&sign=17CF37DFF97FE315063BF9554AF14A6B&channelId=2149710&timestamp=1621844173371

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data String 成功時為success,錯誤時為空

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(PageInteractionTest.class);
/**
 * 修改频道微信分享信息
 * @throws IOException
 */
@Test
public void testUpdateWeixinShare() 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/weixin-share/update";
    String channelId = "2149710";
    String weixinShareTitle = "qwe";
    String weixinShareDesc = "qweqwe";
    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("channelId",channelId);
    requestMap.put("weixinShareTitle",weixinShareTitle);
    requestMap.put("weixinShareDesc",weixinShareDesc);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改频道微信分享信息接口返回值:{}",response);
    //do somethings

}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "success"
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询