# 新增或修改频道问卷

### 接口描述

```
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调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v3/channel/questionnaire/add-edit-questionnaire/README.md)

### 请求方式

```
POST
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)\


### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |
| channelId | true | String | 频道号                                                                                                                                                                                                       |

### 请求体参数描述

| 参数名                   | 必选    | 类型     | 说明                                                                                                                                                                                             |
| --------------------- | ----- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| questionnaireTitle    | true  | String | 问卷标题                                                                                                                                                                                           |
| questions             | true  | Array  | 题目数组 【详见[questions字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/live_interaction/add_edit_questionnaire.md?id=questions%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |
| questionnaireId       | false | String | 问卷id,修改问卷时需要                                                                                                                                                                                   |
| customQuestionnaireId | false | String | 客户自定义问卷id                                                                                                                                                                                      |

### questions字段说明

| 参数名          | 必选    | 类型        | 说明                                  |
| ------------ | ----- | --------- | ----------------------------------- |
| questionId   | false | String    | 题目id，修改问卷时需要传                       |
| name         | true  | String    | 题目                                  |
| type         | true  | String    | <p>题目类型<br>R：单选<br>C：多选<br>Q：问答</p> |
| scoreEnabled | false | String    | <p>题目是否需要评分<br>Y：需要<br>N：不需要</p>    |
| answer       | false | String    | 需要评分的选择题才有答案，填入对应选项序号，如：A或AB        |
| required     | false | String    | <p>题目是否为必答<br>Y：必答<br>N：非必答</p>     |
| options      | false | String\[] | 题目为单选题或多选题为必填，选项数组下标0-9对应答案A-J      |

### 示例

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

请求体参数

```json
{
	"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为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)】                                                             |
| status  | String  | 响应状态文本信息                                                                                                                                                                                     |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                                                                                            |
| data    | Object  | 成功响应时为问卷基本信息 【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/live_interaction/add_edit_questionnaire.md?id=data%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |

#### data字段说明

| 参数名                | 类型        | 说明   |
| ------------------ | --------- | ---- |
| questionnaireId    | String    | 问卷ID |
| questionIds        | String\[] | 题目数组 |
| questionnaireTitle | String    | 问卷标题 |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

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

```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

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

异常示例

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