透過外部ID匯入使用者

更新時間：2025-09-26 14:52:56

介面說明

1、通过外部ID导入用户
2、接口支持https协议

介面URL

https://api.polyv.net/live/v4/user/viewer-record/import-external-viewer

請求方式

POST

介面限制

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

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己的伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】

請求體參數說明

參數名	必填	類型	說明
nickname	true	String	觀眾暱稱，最大長度64個字元
externalViewerId	true	String	外部使用者ID，最大長度64個字元
labelIds	Array	String	使用者標籤ID陣列
followUsers	false	String	跟進人資訊【詳見followUsers欄位說明】

followUsers參數說明

參數名	必填	類型	說明
userId	true	String	跟進人ID
type	false	String	預設wwork：企微跟進人

範例

https://api.polyv.net/live/v4/user/viewer-record/import-external-viewer?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

請求體JSON參數：

[
    {
        "externalViewerId": "444",
        "nickname": "444",
        "labelIds": [
            20747
        ],
        "followUsers":{
            "userId":"123",
            "type":"wxwork"
        }
    },
    {
        "externalViewerId": "555",
        "nickname": "555",
        "labelIds": [
            20747,20737
        ]
    }
]

回應體JSON：

[
    {
    "viewerUnionId": "2_2v0u6u75hw013ja684ba9co7lnppq4j9",
    "nickname": "demoData",
    "externalViewerId": "demoData9",
    "source": "IMPORT",
    "latestAuthTime": 1712114620000,
    "createTime": 1712114620000
    }, {
        "viewerUnionId": "2_ba9co7lnppq4j92v0u6u75hw013ja684",
        "nickname": "demoData",
        "externalViewerId": "demoData10",
        "source": "IMPORT",
        "latestAuthTime": 1712114620000,
        "createTime": 1712114620000
    }
]

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	回應結果，由業務決定，成功回傳true，失敗回傳false
data	Object	回應新建成功的使用者資訊【詳見Data欄位說明】
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求產生的唯一UUID，僅可用於排查、除錯，不應與業務掛鉤

Data參數說明

參數名	必填	類型	說明
viewerUnionId	true	String	觀眾ID
nickname	true	String	觀眾暱稱
externalViewerId	true	String	外部使用者ID
source	true	String	使用者來源
latestAuthTime	true	timestamp	最後授權時間
createTime	true	timestamp	建立時間

Error參數說明

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

Java請求範例

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

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

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 新增观众信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void createViewerTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
        
    String url = "https://api.polyv.net/live/v4/user/viewer-record/create";
    //业务参数
    String mobile = "demoData";
    String nickname = "demoData";
  
    String name = "demoData";
    String lastCollectMobile = "demoData";
    String email = "demoData";
    String area = "demoData";
    String latestAccessIp = "demoData";
    String device = "demoData";
    
  
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
        
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("mobile", mobile);
    jsonMap.put("nickname", nickname);
    jsonMap.put("name", name);
    jsonMap.put("lastCollectMobile", lastCollectMobile);
    jsonMap.put("email", email);
    jsonMap.put("area", area);
    jsonMap.put("latestAccessIp", latestAccessIp);
    jsonMap.put("device", device);

    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试新增观众信息结果：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "97d9bc9c-c0d2-4639-acad-54b28335004c",
    "data": [{
        "viewerUnionId": "2_2v0u6u75hw013ja684ba9co7lnppq4j9",
        "nickname": "demoData",
        "externalViewerId": "demoData9",
        "source": "IMPORT",
        "latestAuthTime": 1712114620000,
        "createTime": 1712114620000
    }],
    "success": true
}

異常範例

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