Viewer Custom Information Synchronization

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

API Description

1、观众自定义信息同步
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/user/custom-field/viewer-value/save

Online API Call

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 Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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 not be used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` [See Signature Generation Rules]

Request Body Parameter Description

Parameter	Required	Type	Description
	true	object []	Custom data

Array Object Parameter Description

Parameter	Type	Description
viewerId	String	Viewer ID
customFieldId	String	Custom field ID
customFieldValue	String	Custom field value

Example

https://api.polyv.net/live/v4/user/custom-field/viewer-value/save?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

Request body JSON parameters:

[
    {
        "viewerId": "viewerId",
        "customFieldId": "PAY_ORDER",
        "customFieldValue": "已支付"
    },
    {
        "viewerId": "viewerId2",
        "customFieldId": "PAY_ORDER",
        "customFieldValue": "未支付"
    }
]

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, returns success on success, error on failure
success	Boolean	Response result, determined by business logic, returns true on success, false on failure
data	Object	Custom field data [See [Data Field Description](#Data Parameter 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, used only for troubleshooting and debugging, should not be tied to business logic

Error Parameter Description

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

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source code project. HttpUtil.java and LiveSignUtil.java in the test cases are included 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 createLabelTest() 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/custom-field/viewer-value/save";
    String viewerId = "viewerId";
    String customFieldId = "PAY_STATUS";
    String customFieldValue = "已支付";
  
    
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        
    Map<String, Object> customFieldMap = new HashMap<>();
    customFieldMap.put("viewerId", viewerId);
    customFieldMap.put("customFieldId", customFieldId);
    customFieldMap.put("customFieldValue", customFieldValue);
    List customFields = Collections.singletonList(customFieldMap);
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(customFields), null);
    
    log.info("测试同步观众自定义信息结果：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "data": null,
    "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