Get Channel Official Account Settings

Updated: 2025-10-23 13:50:02

API Description

1、查询关注公众号设置接口
2、支持多个频道查询
3、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/promotion/list-channels-follow

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See details
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
channelIds	true	String	Channel IDs, multiple channels separated by commas

Example

http://api.polyv.net/live/v3/channel/promotion/list-channels-follow?appId=fso8gzbxlr&timestamp=1628061073000&channelIds=2452644,2446799&sign=90A6E0ECEDE5DB34FD859101136A6318

Response Parameters

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Object	Result set returned on success See data field description

Data Parameter Description

Parameter	Type	Description
list	Array	Official account settings list See Detail parameter description

Detail Parameter Description

Parameter	Type	Description
channelId	String	Channel ID
enabled	String	Official account follow feature toggle, Y for enabled, N for disabled
autoShowEnabled	String	Auto popup toggle, Y for enabled, N for disabled
qrCodeUrl	String	QR code image URL
entranceText	String	Entrance text
tips	String	Popup prompt text
pcFollowTips	String	PC popup text

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java in the test cases are included in the download file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

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/list-channels-follow";
    String channelIds="2452644,2446799";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelIds", channelIds);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("查询关注公众号设置，返回值：{}", response);
    //do somethings

}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "list": [
            {
                "channelId": 2446799,
                "enabled": "N",
                "autoShowEnabled": "N",
                "qrCodeUrl": "//liveimages.videocc.net/uploaded/images/2021/08/g13osnscym.jpeg",
                "entranceText": "welcome",
                "tips": "tips"
            },
            {
                "channelId": 2452644,
                "enabled": "N",
                "autoShowEnabled": "N",
                "qrCodeUrl": "//liveimages.videocc.net/uploaded/images/2021/08/g13osnscym.jpeg",
                "entranceText": "welcome",
                "tips": "tips"
            }
        ]
    }
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

Live Streaming Server API