Add Inviter

Updated: 2025-06-05 18:34:19

API Description

1、将账号下的某些用户，添加、设置为邀请员
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/user/invite-sales/add

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
The total number of inviters under an account is limited to 1000. Exceeding this limit will result in operation failure and an error prompt.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details in Get Secret Key
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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 used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See details in Signature Generation Rules

Request Body Parameter Description

Parameter	Required	Type	Description
viewerUnionIds	true	Array	List of user IDs to be added as inviters. Maximum of 200 users per call. Operation fails if any invalid user ID exists.
organizationId	false	Integer	Organization ID to which the inviter belongs. If empty, defaults to "Headquarters".

Request Example

https://api.polyv.net/v4/user/invite-sales/add?appId=xxx&timestamp=1670471250000&sign=xxx

Request body JSON parameters:

{
    "viewerUnionIds": [
        "xxxabc",
        "xxxdef"
    ],
    "organizationId": 123
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates 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.
error	Object	Error information when status code is non-200. See details in error object description
requestId	String	Request ID, a unique UUID generated for each request. For troubleshooting and debugging only, not for business logic.

Error Object Description

Field	Type	Description
code	Integer	Error code to identify the specific error cause.
desc	String	Error description corresponding to error.code.

Java Request Example

For quick integration, 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 in the downloaded 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 pooling.

import java.util.Arrays;

public void test() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    List<String> viewerUnionIds = Arrays.asList("xxxabc", "xxxdef");
    Integer organizationId = 123;
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("viewerUnionIds", viewerUnionIds);
    jsonMap.put("organizationId", organizationId);
    
    String url = "https://api.polyv.net/v4/user/invite-sales/add";
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    log.info("response: {}", response);
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "success": true,
    "requestId": "5b33d00b-d284-4a3d-adcd-38210f8681c8",
    "data": null
}

Failure Example

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

Live Streaming Server API