Query Sub-account Channel List
Updated: 2026-07-13 11:57:31
API Description
1、查询子账号频道列表
2、接口支持https协议
API URL
http://api.polyv.net/live/v4/channel/channel-user-children/get-channels
Request Method
GET
API Constraints
- The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API calls have frequency limits. See details
Request Parameter Description
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | true | String | Account appId See Get Secret Key |
| timestamp | true | String | 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 never 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 and retrieve response data. See Signature Generation Rules |
| childUserId | true | String | Sub-account user ID |
| startTime | false | Long | Channel creation time - start range |
| endTime | false | Long | Channel creation time - end range |
| pageNumber | true | Integer | Current page number |
| pageSize | true | Integer | Page size |
Example
http://api.polyv.net/live/v4/channel/channel-user-children/get-channels?childUserId=${childUserId}&pageNumber=1&pageSize=10&appId=${your_appId}&sign=${your_sign}
Response Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Status code, same as HTTP status code, used to determine the basic response status |
| data | Object | Data for successful response |
| error | Object | Error information when status code is not 200 See Error Parameter Description |
| requestId | String | Request ID, a unique UUID generated for each request, only for troubleshooting and debugging, should not be tied to business logic |
| status | String | Response result, determined by business logic. Returns success on success, error on failure |
| success | Boolean | Whether the response was successful |
Data Parameter Description
| Parameter | Type | Description |
|---|---|---|
| pageSize | Integer | Number of items per page |
| pageNumber | Integer | Current page number |
| totalItems | Integer | Total number of items |
| totalPages | Integer | Total number of pages |
| contents | List |
Query result list See Contents Parameter Description |
Contents Parameter Description
| Parameter | Type | Description |
|---|---|---|
| channelId | Integer | Channel ID |
| organizationId | String | Organization structure ID |
| createdTime | Integer | Creation time |
Error Parameter Description
| Parameter | Type | Description |
|---|---|---|
| code | Integer | Error code, used to determine the specific error reason |
| desc | String | Error description, corresponding to error.code |
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 cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.
It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.
private static final Logger log = LoggerFactory.getLogger(getClass());
/**
* 清空频道公告信息
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void noticeCleanTest() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
Integer pageNumber = 1;
Integer pageSize = 10;
//业务参数
String url = "http://api.polyv.net/live/v4/channel/channel-user-children/get-channels";
String childUserId = "xx";
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("childUserId", channelId);
requestMap.put("timestamp", timestamp);
requestMap.put("pageNumber", pageNumber);
requestMap.put("pageSize", pageSize);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postFormBody(url, null);
log.info("测试清空频道公告信息成功:{}", response);
//do somethings
}
Response Example
For system-wide error descriptions, see Global Error Description
Success Example
{
"code": 200,
"status": "success",
"requestId": "b85a17e1-a894-432c-a086-12ba3a6ee320",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalPages": 1,
"totalItems": 2,
"contents": [
{
"channelId": 3729186,
"organizationId": "1886",
"createdTime": 1675062332000
},
{
"channelId": 5052255,
"organizationId": "1894",
"createdTime": 1722828648000
}
]
},
"success": true
}
Error Example
{
"code": 400,
"status": "error",
"requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
"error": {
"code": 20001,
"desc": "application not found."
},
"success": false
}
