观众自定义信息同步

接口描述

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

接口URL

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

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】

请求体参数描述

参数名	必选	类型	说明
	true	object []	自定义数据数据

数组对象参数描述

参数名	类型	说明
viewerId	String	观众ID
customFieldId	String	自定义字段ID
customFieldValue	String	自定义字段值

示例

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

请求体json参数：

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

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	响应结果，由业务决定，成功返回true，失败返回false
data	Object	自定义字段数据 【[Data字段说明](#Data 参数描述)】
error	Object	状态码非200时的错误信息【详见Error字段说明】
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩

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

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "data": null,
    "success": true
}

异常示例

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