Update User Identity Information

Updated: 2024-04-22 19:18:32

API Description

1、更新用户身份信息
2、接口支持https协议

API URL

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

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 details on 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 saved or used directly on the client side. All APIs must be called through 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
viewerUnionId	true	String	Viewer ID
nickname	false	String	Viewer nickname, max 64 characters
mobile	false	String	Phone number, max 20 characters
name	true	String	Collected name
lastCollectMobile	false	String	Last collected phone number
email	true	String	Email
area	true	String	Address
latestAccessIp	true	String	Last access IP
device	true	String	Device information

Example

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

Request body JSON parameters:

{
    "viewerUnionId": "2_v378gn997yovtl3p8h77db9e224t6hg9",
    "mobile": "3333",
    "nickname": "2222",
    "name": "demoData",
    "lastCollectMobile": "demoData",
    "email": "demoData",
    "area": "demoData",
    "latestAccessIp": "demoData",
    "device": "demoData"
    
}

Response body JSON:

{
    "code": 200,
    "status": "success",
    "requestId": "be18d7c8-4645-47f2-81dd-c3202d759b12",
    "data": true,
    "success": true
}

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	Boolean	Successfully created user information 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 used for troubleshooting and debugging, not related to business logic

Error Parameter Description

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

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. 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 packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 更新观众信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void updateViewerTest() 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/update";
    //业务参数
    String viewerUnionId = "2_v378gn997yovtl3p8h77db9e224t6hg9";
    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("viewerUnionId", viewerUnionId);
    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": {
        "name": "demoData",
        "lastCollectMobile": "demoData",
        "email": "demoData",
        "area": "demoData",
        "latestAccessIp": "demoData",
        "device": "demoData",
        "watchDuration": 0,
        "watchChannelCount": 0,
        "viewerUnionId": "2_2v0u6u75hw013ja684ba9co7lnppq4j9",
        "nickname": "demoData",
        "mobile": "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