Query Channel WeChat Sharing Information (Legacy)

Updated: 2022-09-02 18:08:07

Interface Description

1、查询频道微信分享信息
2、接口支持https协议

Interface URL

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

Request Method

GET

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls are subject to frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details: Get Secret Key
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 saved 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 details: Signature Generation Rules
channelId	true	String	Channel ID

Example

http://api.polyv.net/live/v3/channel/weixin-share/get?appId=frlr1zazn3&sign=650B48B283200764B96E6F92A9CADAC5&channelId=2149710&timestamp=1621844211156

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See details: Global Error Description
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides auxiliary error description
data	Object	On success, detailed WeChat sharing information; on error, empty. See details: data field description

data Field Description

Parameter	Type	Description
channelId	String	Channel ID
channelName	String	Channel name
coverImg	String	WeChat sharing icon, i.e., the channel's live stream icon
weixinShareTitle	String	WeChat sharing title
weixinShareDesc	String	WeChat sharing description
weixinShareCustomUrl	String	Custom URL for WeChat sharing
webShareCustomUrl	String	Custom URL for web sharing

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. The test case files HttpUtil.java and LiveSignUtil.java are included in the download package.

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

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

/**
 * 依查询频道微信分享信息
 * @throws IOException
 */
@Test
public void testGetWeixinShare() 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/get";
    String channelId = "2149710";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道微信分享信息接口返回值：{}",response);
    //do somethings
}

Response Example

For system global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelId": 2149710,
        "channelName": "创建并初始化频道-验证码观看1",
        "coverImg": "//liveimages.videocc.net/assets/wimages/pc_images/logo.png",
        "weixinShareTitle": "qwe",
        "weixinShareDesc": "qweqwe",
        "weixinShareCustomUrl": null,
        "webShareCustomUrl": null
    }
}

Error Example

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

Live Streaming Server API