Modify 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/update

Request Method

POST

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 on obtaining keys
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 signature generation rules
channelId	true	String	Channel ID
weixinShareTitle	false	String	WeChat share title (within 30 characters), defaults to: channel title
weixinShareDesc	false	String	WeChat share description (within 120 characters), defaults to: "Live streaming, very good! Come and check it out!"

Example

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

Form parameters:

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

Response Parameter Description

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	String	"success" on success, empty on error

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own project source code. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the download file.

It is strongly recommended to use the Live Java SDK for API 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 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

}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API