Remove Inviter

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

Interface Description

1、将账号下的某些邀请员，移除邀请员身份
2、接口支持https协议

Interface URL

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

Request Method

POST

Interface Constraints

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

Request Parameter Description

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

Request Body Parameter Description

Parameter	Required	Type	Description
viewerUnionIds	true	Array	List of user IDs whose inviter role is to be removed. Up to 100 users per call. If any invalid user ID exists, the operation fails.
newViewerUnionId	false	String	Only valid when the inviter to be removed has bound viewers. Indicates transferring and binding the originally bound viewers to this new inviter. If empty, the originally bound viewers will be unbound.

Request Example

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

Request body JSON parameters:

{
    "viewerUnionIds": [
        "xxxabc",
        "xxxdef"
    ],
    "followViewersToNewViewerUnionId": "xxxijk"
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure.
status	String	Response result, determined by the business. Returns "success" on success, "error" on failure.
success	Boolean	Response result, determined by the business. Returns true on success, false on failure.
error	Object	Error information when the status code is non-200. See details on the error object
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not to be tied to business logic.

Error Object Description

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

Java Request Example

For quick integration of the 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, both contained 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 pools.

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");
    String newViewerUnionId = "xxxijk";
    
    //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("newViewerUnionId", newViewerUnionId);
    
    String url = "https://api.polyv.net/v4/user/invite-sales/remove";
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    log.info("response: {}", response);
}

Response Example

For global system 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