Create Anchor

Updated: 2024-11-18 17:57:00

Interface Description

1、创建主播
2、接口支持https协议

Interface URL

https://api.polyv.net/live/v4/channel/anchor/create

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details for obtaining secret key
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 details for signature generation rules

Request Body Parameter Description

Parameter	Required	Type	Description
nickname	true	String	Nickname, up to 20 characters
sex	true	String	Gender, M-Male, W-Female
avatar	true	String	Avatar
description	false	String	Description, up to 150 characters
addChannelIds	false	Array	List of newly associated channel IDs, up to 1000

Example

https://api.polyv.net/live/v4/channel/anchor/create?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

Request body JSON parameters:

{
    "nickname": "1号主播",
    "sex":"W",
    "avatar":"https://liveimages.videocc.net/uploaded/images/2024/04/gvh9eybcbb.png",
    "description":"主播简介，我是一名大主播"
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result, determined by business logic, returns success on success, error on failure
success	Boolean	Response result, determined by business logic, returns true on success, false on failure
data	Object	Tag data [See Data field description](#Data Parameter Description)
error	Object	Error information when status code is non-200 See Error field description
requestId	String	Request ID, a unique UUID generated for each request, only for troubleshooting and debugging, should not be tied to business logic

Data Parameter Description

Parameter	Type	Description
Data itself	Long	Anchor ID

Error Parameter Description

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

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source code project. The HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API functionality 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 createChannelAnchorTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "https://api.polyv.net/live/v4/channel/anchor/create";
    String nickname = "1号主播";
      String sex = "w";
    String avatar = "https://liveimages.videocc.net/uploaded/images/2024/04/gvh9eybcbb.png";
    String description = "主播简介，我是一名大主播";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("nickname", nickname);
    jsonMap.put("sex", sex);
    jsonMap.put("avatar", avatar);
    jsonMap.put("description", description);
    
    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": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "data":1, // 主播ID
    "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