新增或修改頻道問卷

更新時間：2025-04-22 13:59:14

介面說明

1、编辑或添加问卷信息，为全量增加或修改
2、（channelId, timestamp, appId）参与sign签名，并和sign一起通过url传递，请求体参数不参与签名，通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/questionnaire/add-edit-questionnaire

線上API呼叫

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號

請求體參數說明

參數名	必選	類型	說明
questionnaireTitle	true	String	問卷標題
questions	true	Array	題目陣列【詳見questions欄位說明】
questionnaireId	false	String	問卷id，修改問卷時需要
customQuestionnaireId	false	String	客戶自訂問卷id
autoPublishTime	false	String	問卷定時自動發佈時間（時間格式為"yyyy-MM-dd HH:mm"；需大於當前時間1分鐘以上；當autoEndTime傳遞時，autoPublishTime必傳）
autoEndTime	false	String	問卷定時自動結束時間（時間格式為"yyyy-MM-dd HH:mm"；需大於autoPublishTime，當autoPublishTime必傳傳遞時，autoEndTime必傳）

questions欄位說明

參數名	必選	類型	說明
questionId	false	String	題目id，修改問卷時需要傳
name	true	String	題目
type	true	String	題目類型 R：單選 C：多選 Q：問答
scoreEnabled	false	String	題目是否需要評分 Y：需要 N：不需要
answer	false	String	需要評分的選擇題才有答案，填入對應選項序號，如：A或AB
required	false	String	題目是否為必答 Y：必答 N：非必答
options	false	String[]	題目為單選題或多選題為必填，選項陣列下標0-9對應答案A-J

範例

https://api.polyv.net/live/v3/channel/questionnaire/add-edit-questionnaire?appId=frlr1zazn3&sign=439CDA1327558DFCF947F305D03AFA92&channelId=1965681&timestamp=1621843779393

請求體參數

{
    "questionnaireId": "fwnf2sbpf5",
    "customQuestionnaireId": "6a3ff44289f94a5fb1dd8341ac1c0100",
    "questionnaireTitle": "这里是问卷标题",
    "questions": [{
        "questionId": "feqfr13ftz",
        "name": "题目名称qwe",
        "type": "R",
        "answer": "A",
        "scoreEnabled": "Y",
        "score": 10,
        "required": "Y",
        "options": ["选项1", "选项2", "选项3"]
    }]
}

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	成功回應時為問卷基本資訊【詳見data欄位說明】

data欄位說明

參數名	類型	說明
questionnaireId	String	問卷ID
questionIds	String[]	題目陣列
questionnaireTitle	String	問卷標題

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 testAddEditQuestionnaire() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "1965681";
    String temp = "https://api.polyv.net/live/v3/channel/questionnaire/add-edit-questionnaire";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("channelId",channelId);

    String body = "{\"questionnaireId\":\"fwnf2sbpf5\",\"customQuestionnaireId\":\"6a3ff44289f94a5fb1dd8341ac1c0100\",\"questionnaireTitle\":\"这里是问卷标题\",\"questions\":[{\"questionId\":\"feqfr13ftz\",\"name\":\"题目名称qwe\",\"type\":\"R\",\"answer\":\"A\",\"scoreEnabled\":\"Y\",\"score\":10,\"required\":\"Y\",\"options\":[\"选项1\",\"选项2\",\"选项3\"]}]}";
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String url = HttpUtil.appendUrl(temp,requestMap);
    String response = HttpUtil.postJsonBody(url, body, null);
    log.info("测试修改频道问卷接口返回值：{}",response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "questionnaireId": "fwnf2sbpf5",
        "questionIds": ["feqfr13ftz"],
        "questionnaireTitle": "这里是问卷标题"
    }
}

異常範例

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