獲取邀請員列表

介面描述

1、支持按特定的条件去过滤、获取账号下的邀请员列表
2、接口支持https协议

介面URL

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

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數說明

請求範例

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

回應參數說明

data物件說明

contents物件說明

留意：

1. 如果所查詢的組織中有邀請員管理員，則 會將該管理員置頂在第一頁資料的開頭 。此時，第一頁的記錄數會比常規的「每頁記錄數」多出一條記錄。
2. 如果未指定、傳遞「邀請員所屬組織」參數，則預設置頂「總部」的管理員（如果有的話）。

error物件說明

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼， 點擊下載原始碼 ，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

public void test() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String mobile = "18112345678";
    
    String url = "https://api.polyv.net/v4/user/invite-sales/list";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("mobile", mobile);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("response: {}", response);
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "5b33d00b-d284-4a3d-adcd-38210f8681c8",
    "data": {
        "pageSize": 5,
        "totalPages": 2,
        "totalItems": 10,
        "contents": [
            {
                "viewerUnionId": "6_xxx",
                "nickname": "广州观众",
                "wxNickName": null,
                "wxAvatar": null,
                "mobile": "18112345678",
                "inviteSalesSource": "apply",
                "inviteSalesGrantedTime": 1744795084000,
                "organizationId": 123,
                "organizationName": "总部",
                "inviteSalesAdmin": "Y",
                "customerNum": 10,
            }
        ]
    },
    "success": true
}

失敗範例

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