# 查询频道微信分享信息(旧版)

### 接口描述

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

### 接口URL

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

### 请求方式

```
GET
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| channelId | true | String | 频道号                                                                                                                                                                                                       |

### 示例

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

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                                                |
| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】                                                                  |
| status  | String  | 响应状态文本信息                                                                                                                                                                                          |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                                                                                 |
| data    | Object  | 成功时为微信分享的详细信息，错误时为空 【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/page_interaction/get_weixin_share.md?id=data%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |

#### data字段说明

| 参数名                                                                                                                                                                                       | 类型     | 说明              |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | --------------- |
| channelId                                                                                                                                                                                 | String | 频道号             |
| channelName                                                                                                                                                                               | String | 频道名称            |
| coverImg                                                                                                                                                                                  | String | 微信分享图标，即频道的直播图标 |
| weixinShareTitle                                                                                                                                                                          | String | 微信分享的标题         |
| weixinShareDesc                                                                                                                                                                           | String | 微信分享的描述         |
| weixinShareCustomUrl                                                                                                                                                                      | String | 微信分享客户自定义url    |
| webShareCustomUrl                                                                                                                                                                         | String | 网页分享客户自定义url    |
| ### Java请求示例                                                                                                                                                                              |        |                 |
| 快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。 |        |                 |

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
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
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

```json
{
	"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
	}
}
```

异常示例

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