保利威文档中心

幫助中心

取得邀請員的綁定觀眾列表

更新時間:2025-06-05 18:34:19

介面說明

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

介面URL

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

請求方式

GET

介面限制

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

請求參數說明

參數名 必填 類型 說明
appId true String 帳號appId【詳見取得金鑰
timestamp true Long 目前13位毫秒級時間戳記,3分鐘內有效
sign true String 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
inviteCustomerId false String 邀請員使用者ID,精準比對
inviteCustomerNickname false String 邀請員暱稱關鍵字,支援模糊比對
viewerId false String 觀眾使用者ID,精準比對
username false String 觀眾暱稱關鍵字,支援模糊比對
telephone false String 觀眾手機號碼,精準比對
followStatusList false String 觀眾綁定狀態列表,多個以英文逗號分隔。0-待跟進;1-已綁定;2-已解綁。
pageSize false Integer 每頁記錄數(預設10,最大1000)
pageNumber false Integer 頁碼(最大1000頁)

請求範例

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

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗
status String 回應結果,由業務決定,成功返回success,失敗返回error
success Boolean 回應結果,由業務決定,成功返回true,失敗返回false
data Object 具體的回應資料【詳見data物件說明
error Object 狀態碼非200時的錯誤資訊【詳見error物件說明
requestId String 請求ID,每次請求產生的唯一 UUID,僅可用於排查、除錯,不應該和業務掛鉤

data物件說明

欄位名 類型 說明
pageSize Integer 每頁記錄數
totalPages Integer 總頁數
totalItems Integer 總記錄數
contents Array 綁定觀眾資訊列表【詳見contents物件說明
requestId String 請求ID,每次請求產生的唯一 UUID,僅可用於排查、除錯,不應該和業務掛鉤

contents物件說明

欄位名 類型 說明
inviteCustomerId String 邀請員使用者ID
inviteCustomerNickname String 邀請員使用者暱稱
viewerId String 觀眾使用者ID
nickname String 觀眾使用者暱稱
telephone String 觀眾手機號碼
followStatus Integer 觀眾綁定狀態列表。0-待跟進;1-已綁定;2-已解綁。
followTime timestamp 綁定時間,格式為13位時間戳記

error物件說明

欄位名 類型 說明
code Integer 錯誤代碼,用於確定具體的錯誤原因
desc String 錯誤描述,與 error.code 對應

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 telephone = "18112345678";
    
    String url = "https://api.polyv.net/v4/user/invite-sales/follow-viewer/list";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("telephone", telephone);
    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": [
            {
                "inviteCustomerId": "6_xxxabc",
                "inviteCustomerNickname": "xxxabc",
                "viewerId": "6_xxxdef",
                "nickname": "xxxdef",
                "telephone": "18112345678",
                "followStatus": 1,
                "followTime": 1746699185000
            }
        ]
    },
    "success": true
}

失敗範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服,在线咨询