调用 ListActivityQuestionnaire 接口,在指定直播间内获取问卷列表。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListActivityQuestionnaire | 接口名称。当前 API 的名称为 ListActivityQuestionnaire。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
ActivityId | Long | 否 |
| 直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| PageNumber | Integer | 否 | 1 | 分页查询页码。默认值为 1。取值大于等于 1。 |
| PageSize | Integer | 否 | 10 | 分页查询数量。默认值为 10。取值范围为 [1,500]。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Questionnaires | Array of Questionnaires | - | 当前直播间的问卷配置列表。 |
| Total | Long | 1 | 问卷总数量。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Id | Long | 181******2313 | 问卷 ID。 |
| Title | String | 网购调研 | 问卷的标题。 |
| Description | String | 收集您网购的偏好。 | 问卷的详细描述或说明,将显示在问卷标题下方。 |
TriggerTime | String |
| 问卷的发送时机。支持以下取值:
|
SendTime | Integer |
| 定时发送问卷的时间。Unix 时间戳,单位为秒。 说明 当 |
IsRealNameEnable | Integer |
| 是否为实名问卷。支持以下取值:
说明 实名问卷用于保证观众填写问卷时已登录直播间,无法保证观众使用真实姓名。如果您在观看限制中将评论限制设置为公开,则观众提交实名问卷时需选择输入昵称或手机号登录。 |
IsForbidEdit | Integer |
| 该问卷是否禁止编辑。问卷一旦发布,将无法再次编辑。支持以下取值:
|
PublishStatus | Integer |
| 问卷的发布状态,支持以下取值:
说明 当 |
| Questions | Array of Questions | - | 问卷中的问题列表。最多支持 20 个问题。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Question | String | 您在网购时,收货方式是? | 问题内容。 |
IsRequire | Integer |
| 问题是否为必填。支持以下取值:
|
QuestionTag | String |
| 问题类型。支持以下取值:
|
QuestionSubTag | String |
| 问题子类型。取值情况如下。
|
Options | Array of Options |
| 选择题中的选项列表。至少需包含两个选项。 说明 当 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| OptionName | String | 快递柜取件 | 选项内容。 |
GET https://livesaas.volcengineapi.com/?Action=ListActivityQuestionnaire&Version=2023-08-01&ActivityId=182*******2131&PageNumber=1&PageSize=10
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListActivityQuestionnaire", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Questionnaires": [ { "TriggerTime": "auto_send", "Description": "收集您网购的偏好。", "IsRealNameEnable": 0, "PublishStatus": 0, "IsForbidEdit": 0, "Title": "网购调研", "SendTime": 1773724175, "Questions": [ { "QuestionTag": "select", "IsRequire": 1, "Question": "您在网购时,收货方式是?", "QuestionSubTag": "radio", "Options": [ { "OptionName": "快递柜取件" }, { "OptionName": "选项2" } ] } ], "Id": 181******2313 } ], "Total": 1 } }