调用 UpdateActivityQuestionnaire 接口,在指定直播间内更新指定问卷。
IsForbidEdit 参数判断问卷是否支持编辑。下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateActivityQuestionnaire | 接口名称。当前 API 的名称为 UpdateActivityQuestionnaire。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ActivityId | Long | 是 |
| 直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| Questionnaire | Object of Questionnaire | 是 | - | 问卷的配置信息,包含问卷 ID、题目、选项等。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Id | Long | 是 | 181******1561 | 问卷 ID。您可以通过 ListActivityQuestionnaire 接口获取问卷 ID。 |
| Title | String | 否 | 网购调研 | 问卷的标题。最多支持输入 60 个字符。不可为纯空格。 |
| Description | String | 否 | 收集您网购的偏好。 | 问卷的详细描述或说明,将显示在问卷标题下方。最多支持输入 200 个字符。不可为纯空格。 |
TriggerTime | String | 否 |
| 问卷的发送时机。支持以下取值:
|
SendTime | Long | 否 |
| 定时发送问卷的时间。Unix 时间戳,单位为秒。设定时间必须晚于当前时间至少 1 分钟。 说明 当 |
IsRealNameEnable | Long | 否 |
| 是否将问卷设为实名问卷。默认为匿名问卷。支持以下取值:
说明 实名问卷用于保证观众填写问卷时已登录直播间,无法保证观众使用真实姓名。如果您在观看限制中将评论限制设置为公开,则观众提交实名问卷时需选择输入昵称或手机号登录。 |
| Questions | Array of Questions | 否 | - | 问卷中的问题列表。最多可添加 20 个问题。传入该参数时,将以该列表全量覆盖原有问题。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Question | String | 是 | 您在网购时,收货方式是? | 问题内容,最多支持输入 50 个字符,不可为纯空格。 |
IsRequire | Integer | 否 |
| 问题是否为必填,默认为非必填。支持以下取值:
|
QuestionTag | String | 是 |
| 问题类型。支持以下取值:
|
QuestionSubTag | String | 是 |
| 问题子类型。取值情况如下。
|
Options | Array of Options | 否 |
| 选择题中的选项列表。至少需包含两个选项。 说明 当 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| OptionName | String | 是 | 快递柜取件 | 选项内容,最多支持输入 50 个字符,不可为纯空格。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Id | Long | 181*****4418616 | 更新后的问卷 ID。 |
POST https://livesaas.volcengineapi.com/?Action=UpdateActivityQuestionnaire&Version=2023-08-01 { "ActivityId": 182*******2131, "Questionnaire": { "Title": "网购调研", "Description": "收集您网购的偏好。", "TriggerTime": "auto_send", "SendTime": 1773724175, "IsRealNameEnable": 0, "Questions": [ { "Question": "您在网购时,收货方式是?", "IsRequire": 1, "QuestionTag": "select", "QuestionSubTag": "radio", "Options": [ { "OptionName": "快递柜取件" }, { "OptionName": "选项 2" }, ] } ], "Id": 181******1561 } }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "UpdateActivityQuestionnaire", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Id": 181******1561 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 409 | OperationDenied.QuestionnaireInPublish | Operation is denied because the questionnaire has published. | 问卷已经发布过,无法再更新。您可调用 GetActivityQuestionnaire 接口,通过 IsForbidEdit 参数判断问卷是否支持编辑。 |