You need to enable JavaScript to run this app.
文档中心
企业直播

企业直播

复制全文
下载 pdf
互动工具
ListActivityQuestionnaire - 直播间获取问卷列表
复制全文
下载 pdf
ListActivityQuestionnaire - 直播间获取问卷列表

调用 ListActivityQuestionnaire 接口,在指定直播间内获取问卷列表。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的营销互动 > 可查看 或 直播控制 > 可查看权限的子账号。有关如何添加子账号,详见子账号管理

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=ListActivityQuestionnaire&Version=2023-08-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数

Query

参数类型是否必选示例值描述
ActionStringListActivityQuestionnaire接口名称。当前 API 的名称为 ListActivityQuestionnaire
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

ActivityId

Long

182*******2131

直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

PageNumberInteger1分页查询页码。默认值为 1。取值大于等于 1。
PageSizeInteger10分页查询数量。默认值为 10。取值范围为 [1,500]。

返回参数

参数类型示例值描述
QuestionnairesArray of Questionnaires-当前直播间的问卷配置列表。
TotalLong1问卷总数量。

Questionnaires

参数类型示例值描述
IdLong181******2313问卷 ID。
TitleString网购调研问卷的标题。
DescriptionString收集您网购的偏好。问卷的详细描述或说明,将显示在问卷标题下方。

TriggerTime

String

auto_send

问卷的发送时机。支持以下取值:

  • live_page_in:当观众进入直播间时弹出问卷
  • live_end:当直播结束时弹出问卷
  • manual:手动发送问卷,问卷发送后在观看页弹出
  • auto_send:定时发送问卷,问卷将在指定时间在观看页弹出

SendTime

Integer

1773724175

定时发送问卷的时间。Unix 时间戳,单位为秒。

说明

TriggerTime 取值为 auto_send 时,该参数生效。

IsRealNameEnable

Integer

0

是否为实名问卷。支持以下取值:

  • 0:匿名问卷,用户无需登录即可提交问卷,且可以重复提交问卷。
  • 1:实名问卷。如果您需要获取填写问卷的观众昵称,且不允许观众重复提交问卷,可选择实名问卷

说明

实名问卷用于保证观众填写问卷时已登录直播间,无法保证观众使用真实姓名。如果您在观看限制中将评论限制设置为公开,则观众提交实名问卷时需选择输入昵称或手机号登录。

IsForbidEdit

Integer

0

该问卷是否禁止编辑。问卷一旦发布,将无法再次编辑。支持以下取值:

  • 0:允许编辑
  • 1:禁止编辑

PublishStatus

Integer

0

问卷的发布状态,支持以下取值:

  • 0:未发布
  • 1:已发布
  • 2:已下线

说明

TriggerTime 取值为 live_page_inlive_end 时,该参数生效。

QuestionsArray of Questions-问卷中的问题列表。最多支持 20 个问题。

Questions

参数类型示例值描述
QuestionString您在网购时,收货方式是?问题内容。

IsRequire

Integer

1

问题是否为必填。支持以下取值:

  • 0:非必填
  • 1:必填

QuestionTag

String

select

问题类型。支持以下取值:

  • personal_info:个人信息。支持手机号、邮箱和昵称。
  • blank_filling:填空题。
  • select:选择题。支持单选和多选。

QuestionSubTag

String

radio

问题子类型。取值情况如下。

  • QuestionTag 取值为 personal_info 时,支持以下取值:
    • phone_number:手机号码。系统会校验手机号格式。
    • email:邮箱,系统会校验邮箱格式。
    • nickname:昵称。如果用户已登录,则系统会自动填充昵称且用户无法更改。
  • QuestionTag 取值为 blank_filling 时,该参数仅支持 text 取值,表示填空题。最多支持观众填入 200 个字符。
  • QuestionTag 取值为 select 时,支持以下取值:
    • radio:单选题。
    • checkbox:多选题。

Options

Array of Options

-

选择题中的选项列表。至少需包含两个选项。

说明

QuestionTag 取值为 select 时,该参数生效。

Options

参数类型示例值描述
OptionNameString快递柜取件选项内容。

请求示例

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

错误码

访问公共错误码错误码获取详细信息。

最近更新时间:2026.04.24 14:41:39
这个页面对您有帮助吗?
有用
有用
无用
无用