Create Group

Updated: 2024-09-05 17:26:45

API Description

1、新建分组
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/channel/lottery-viewer-group/whitelist/create

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
Incorrect parameters will result in a 400 error response.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details
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	Integer	Channel ID

Request Body Parameter Description

Parameter	Required	Type	Description
title	true	String	Group name

Example

http://api.polyv.net/live/v4/channel/lottery-viewer-group/whitelist/create?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=4619012

Request body JSON parameters:

{
    "title": "分组1"
}

Response Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the request was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not related to business logic
error	Object	Error information when status code is not 200 See Error field description
data	Object	Detailed response information See data field description

Error Response Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error reason
desc	String	Error description, corresponding to error.code

data Response Description

Parameter	Type	Description
id	Long	Group ID
title	String	Group name

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both included 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 final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 新建分组
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void groupAdd() 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/lottery-viewer-group/whitelist/create";
    //业务参数
    Integer channelId = 5004544;
    String title = "分组1";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
        
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("title", title);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试新建分组结果：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "df1d4247-3cd6-4cf5-990d-b19fd4cd58e9",
    "data": {
        "id": 678,
        "title": "分组1"
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API