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

旧版接口地址[查询频道微信分享信息(旧版)](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/page_interaction/get_weixin_share/README.md)

### 接口描述

```
1、查询频道微信分享信息，对应新版后台的 营销-分享设置
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v4/channel/share/get
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v4/channel/share/get/README.md)

### 请求方式

```
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/v4/channel/share/get?appId=frlr1zazn3&sign=AFEFF406F3E243B7F3882B0616685448&channelId=2567762&timestamp=1632818971891
```

### 响应参数描述

| 参数名       | 类型      | 说明                                       |
| --------- | ------- | ---------------------------------------- |
| code      | Integer | 响应状态码，200为成功返回，非200为失败                   |
| status    | String  | 响应结果，由业务决定，成功返回success，失败返回error         |
| success   | Boolean | 响应结果，由业务决定，成功返回true，失败返回false            |
| data      | Object  | 成功响应时返回频道分享信息【详见[Data字段说明](#Data参数描述)】   |
| error     | Object  | 状态码非200时的错误信息【详见[Error字段说明](#error参数描述)】 |
| requestId | String  | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |

### Error参数描述

| 参数名  | 类型      | 说明                   |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因     |
| desc | String  | 错误描述，与 error.code 对应 |

### Data参数描述

| 参数名                  | 类型     | 说明                              |
| -------------------- | ------ | ------------------------------- |
| shareBtnEnable       | String | 是否开启分享，Y：开启，N：关闭                |
| titleType            | String | 标题类型follow直播标题、custom自定义        |
| weixinShareTitle     | String | 分享标题，最大长度50，标题类型为custom时，该字段生效  |
| weixinShareDesc      | String | 分享简介，最大长度120，标题类型为custom时，该字段生效 |
| weixinShareCustomUrl | String | 微信自定义分享地址，最大长度512               |
| webShareCustomUrl    | String | 网页观看自定义分享地址，最大长度512             |

### 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(ChannelShareTest.class);

    @Test
    public void testGetChannelShare() throws IOException, NoSuchAlgorithmException {
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "http://api.polyv.net/live/v4/channel/share/get";
        
        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);
        requestMap.put("channelId", "2567762");
        
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        
        String response = HttpUtil.get(url,requestMap);
        
        log.info("测试查询频道分享设置，返回值：{}", response);
    }
```

### 响应示例

成功示例

```json
{
    "code": 200,
    "status": "success",
    "requestId": "779ef4fc-0690-463f-ae1e-59f4bc792be4",
    "data": {
        "shareBtnEnable": "Y",
        "titleType": "custom",
        "weixinShareTitle": "保利威测试微信分享标题",
        "weixinShareDesc": "保利威测试微信分享描述",
        "weixinShareCustomUrl": "httPs://polyv.com",
        "webShareCustomUrl": ""
    },
    "success": true
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "requestId": "4081dbac03e6441e8bdd301d8feee5a2.117.16360830804996119",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
```