添加邀请员

接口描述

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

接口URL

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

请求方式

POST

接口约束

1. 接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看
2. 账号下的邀请员总数有限制，目前为1000，超过则操作失败，返回错误提示。

请求参数描述

请求体参数描述

请求示例

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

请求体json参数：

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

响应参数描述

error对象说明

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

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);
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

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

失败示例

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