新增資訊收集

介面描述

1、创建一个新的信息采集配置（表单），可用于报名、登记、福袋领奖等场景收集观众信息
2、字段与管理后台信息采集配置保持一致
3、请求体参数不参与签名，签名仅使用URL参数（appId、timestamp）
4、接口支持https协议

介面URL

http://api.polyv.net/live/v4/user/info-collection/form/create

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看
2、請設定請求頭 contentType:application/json

請求參數描述

請求體參數描述

請求體為JSON物件，欄位如下：

fields欄位說明

fieldKey 新建時無需傳入，由伺服器端自動產生；編輯時須原樣回傳。

privacyList欄位說明

範例

http://api.polyv.net/live/v4/user/info-collection/form/create?appId=xxx&sign=xxx&timestamp=xxx

請求體參數：

{
    "formName": "问卷调研",
    "privacyForceCheckEnabled": "N",
    "fields": [
        {
            "fieldType": "name",
            "fieldName": "姓名",
            "rank": 1,
            "required": "Y",
            "placeholder": "请输入姓名"
        },
        {
            "fieldType": "mobile",
            "fieldName": "手机号",
            "rank": 2,
            "required": "Y",
            "smsCheckEnabled": "N",
            "areaCodeEnabled": "N"
        }
    ],
    "privacyList": []
}

回應參數描述

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(LiveInteractionTest.class);
/**
 * 新增信息采集
 * @throws IOException
 */
@Test
public void testCreateInfoCollection() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v4/user/info-collection/form/create";

    //签名仅使用URL参数,请求体不参与签名
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));

    String json = "{\"formName\":\"问卷调研\",\"privacyForceCheckEnabled\":\"N\",\"fields\":[{\"fieldType\":\"name\",\"fieldName\":\"姓名\",\"rank\":1,\"required\":\"Y\"},{\"fieldType\":\"mobile\",\"fieldName\":\"手机号\",\"rank\":2,\"required\":\"Y\"}],\"privacyList\":[]}";
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, json, null);

    log.info("测试新增信息采集接口返回值：{}",response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": 52
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}