修改頻道關注公眾號設定資訊
更新時間:2025-10-23 13:50:02
介面描述
1、更新关注公众号设置接口
2、支持多个频道查询
3、接口支持https协议
介面URL
http://api.polyv.net/live/v3/channel/promotion/update-channels-follow
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
2、qrCodeUrl圖片的content-type僅支援"image/jpeg"或"image/png",其他類型會拋出"img url error:request file content-type"異常
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 目前13位毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| channelIds | true | String | 頻道號,多個頻道用","分隔 |
| qrCodeUrl | true | String | 圖片連結位址 |
| enabled | false | String | 關注公眾號功能開關,為空不進行修改 Y:開啟 N:關閉 |
| autoShowEnabled | false | String | 主動彈窗開關,為空不進行修改 Y:開啟 N:關閉 |
| entranceText | false | String | 入口文案,最大8個字元、為空是不進行修改 |
| tips | false | String | 彈窗提示文案,最大30個字元、為空是不進行修改 |
| pcFollowTips | false | String | PC-彈窗文案, 最大30個字元 |
範例
http://api.polyv.net/live/v3/channel/promotion/update-channels-follow
表單參數:
appId=fso8gzbxlr×tamp=1628069484000&channelIds=2452644,2446799&enabled=N&entranceText=welcome&tips=tips&autoShowEnabled=N&qrCodeUrl=http://image.biaobaiju.com/uploads/20181223/20/1545567880-shRzoBCgMS.jpeg&sign=9FC1777C16282BF180AF6CCF12E5437B
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或者500時,輔助描述錯誤原因 |
| data | String | 回應成功時返回null,失敗時返回空字串 |
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 testUpdateSetting() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际
String appId = super.appId;
String appSecret = super.appSecret;
String userId = super.userId;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url="https://api.polyv.net/live/v3/channel/promotion/update-channels-follow";
String channelIds="2452644,2446799";
String enabled = "Y";
String autoShowEnabled = "Y";
String entranceText = "welcome";
String tips = "tips";
String qrCodeUrl = "http://image.biaobaiju.com/uploads/20181223/20/1545567880-shRzoBCgMS.jpeg";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("channelIds", channelIds);
requestMap.put("qrCodeUrl", qrCodeUrl);
requestMap.put("enabled", enabled);
requestMap.put("autoShowEnabled", autoShowEnabled);
requestMap.put("entranceText", entranceText);
requestMap.put("tips", tips);
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": ""
}
