# 查询频道图文直播内容

### 接口描述

```
1、查询频道图文直播内容
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v3/channel/watch/tuwen/list
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/watch/tuwen/list/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  | 频道号                                                                                                                                                                                                       |
| id        | false | Integer | 图文内容的序列号：为空表示获取第一页数据，且同时会返回置顶数据。非空表示获取 id 比该值小的记录（也就是更早发布的内容），此时不返回置顶列表。                                                                                                                                  |
| imageMode | false | String  | <p>是否为图片模式，默认为N<br>Y：图片模式<br>N：文字加图片的模式</p>                                                                                                                                                               |

### 示例

```requestUrl
https://api.polyv.net/live/v3/channel/watch/tuwen/list?appId=frlr1zazn3&sign=9E82CCD014CBBBE72EC6306D05A331E3&imageMode=N&channelId=2149710&timestamp=1621842666131
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                         |
| ------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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/menu/tuwen_list.md?id=data%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |

#### data字段说明

| 参数名         | 类型      | 说明                                                                                                                                                                                |
| ----------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| total       | Integer | 总的返回结果条数                                                                                                                                                                          |
| contents    | Array   | 返回的图文列表内容 【详见[contents字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/menu/tuwen_list.md?id=contents%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】     |
| topContents | Array   | 置顶的图文信息 【详见[topContents字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/menu/tuwen_list.md?id=topContents%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |
| setting     | Object  | 图文直播相关设置信息 【详见[setting字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/web/menu/tuwen_list.md?id=setting%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】      |

#### contents字段说明

| 参数名         | 类型      | 说明                                                                                 |
| ----------- | ------- | ---------------------------------------------------------------------------------- |
| id          | Integer | 图文内容序列号,可用于查询条件参数id                                                                |
| channelId   | String  | 频道号                                                                                |
| text        | String  | 文本内容                                                                               |
| images      | Array   | 图片地址，格式：`["http://liveimages.net//chat.jpeg"，"http://liveimages.net//chat2.jpeg"]` |
| top         | String  | <p>是否置顶<br>Y：是<br>N：否</p>                                                          |
| createdTime | Integer | 内容发送的时间，13位的时间戳                                                                    |

#### topContents字段说明

| 参数名         | 类型      | 说明                                                                                 |
| ----------- | ------- | ---------------------------------------------------------------------------------- |
| id          | Integer | 图文内容序列号，可用于查询条件参数id                                                                |
| channelId   | String  | 频道号                                                                                |
| text        | String  | 文本内容                                                                               |
| images      | Array   | 图片地址，格式：`["http://liveimages.net//chat.jpeg"，"http://liveimages.net//chat2.jpeg"]` |
| top         | String  | <p>是否置顶<br>Y：是<br>N：否</p>                                                          |
| createdTime | Long    | 内容发送的时间，13位的时间戳                                                                    |

#### setting字段说明

| 参数名      | 类型     | 说明     |
| -------- | ------ | ------ |
| nickname | String | 操作人的昵称 |
| actor    | String | 操作人的头衔 |
| avatar   | String | 操作人的头像 |

### 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(MenuTest.class);
/**
 * 查询频道图文直播内容
 * @throws IOException
 */
@Test
public void testTuwenList() 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/watch/tuwen/list";
    String channelId = "2149710";
    String imageMode = "N";

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

    requestMap.put("channelId",channelId);
    requestMap.put("imageMode",imageMode);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(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": {
		"total": 4,
		"contents": [{
			"id": 114225,
			"channelId": 2149710,
			"text": "<p>图片测试2</p>",
			"images": ["http://liveimages.videocc.net/uploadimage/20210309/chat_img_2149710_16152571693814.jpeg"],
			"top": "N",
			"createdTime": 1615257175000
		}, {
			"id": 114223,
			"channelId": 2149710,
			"text": "<p>加图片测试</p>",
			"images": ["http://liveimages.videocc.net/uploadimage/20210309/chat_img_2149710_16152570796353.jpeg"],
			"top": "N",
			"createdTime": 1615257089000
		}],
		"topContents": [],
		"setting": {
			"id": 109036,
			"nickname": "请问123",
			"actor": "主持人",
			"avatar": "//liveimages.videocc.net/assets/wimages/pc_images/logo.png"
		}
	}
}
```

异常示例

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