Import Users via External ID

Updated: 2025-09-26 14:52:56

API Description

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

API URL

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

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Obtaining Keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 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 stored or used directly on the client. All APIs must be called from your own server to relay requests to the POLYV server for response data.` See Signature Generation Rules

Request Body Parameter Description

Parameter	Required	Type	Description
nickname	true	String	Viewer nickname, max 64 characters
externalViewerId	true	String	External user ID, max 64 characters
labelIds	Array	String	Array of user label IDs
followUsers	false	String	Follower information See followUsers Field Description

followUsers Parameter Description

Parameter	Required	Type	Description
userId	true	String	Follower ID
type	false	String	Default is wwork: WeCom follower

Example

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

Request body JSON parameters:

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

Response body 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
    }
]

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result, determined by business logic: success returns "success", failure returns "error"
success	Boolean	Response result, determined by business logic: success returns true, failure returns false
data	Object	Response data for the newly created user See Data Field Description
error	Object	Error information when status code is non-200 See Error Field Description
requestId	String	Request ID, a unique UUID generated for each request. Only for troubleshooting and debugging, not for business logic

Data Parameter Description

Parameter	Required	Type	Description
viewerUnionId	true	String	Viewer ID
nickname	true	String	Viewer nickname
externalViewerId	true	String	External user ID
source	true	String	User source
latestAuthTime	true	timestamp	Last authorization time
createTime	true	timestamp	Creation time

Error Parameter Description

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

Java Request Example

For quick integration of the base code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own project source code. The test cases include HttpUtil.java and LiveSignUtil.java 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.

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
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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
}

Error Example

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

Live Streaming Server API