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

企业直播

复制全文
下载 pdf
互动工具
OfflineActivityQuestionnaire - 直播间下线问卷
复制全文
下载 pdf
OfflineActivityQuestionnaire - 直播间下线问卷

调用 OfflineActivityQuestionnaire 接口,在指定直播间内下线指定问卷。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的营销互动 > 可编辑 或 直播控制 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理
  • 仅发布后的问卷支持下线。您可通过调用 GetActivityQuestionnaire,通过 PublishStatus 参数判断问卷是否已发布。

请求说明

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

调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述

ActivityId

Long

182*******2131

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

说明

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

QuestionnaireIdLong181******1561问卷 ID。您可以通过 ListActivityQuestionnaire 接口获取问卷 ID。

QuestionnairePublishId

Long

181******1512

当问卷为手动发送或者定时发送时,问卷的发送 ID。

注意

  • 当问卷为手动发送或者定时发送时,该参数生效且必传。您可以调用 ListActivityQuestionnaire 接口,通过 TriggerTime 参数获取问卷的发送时机。
  • 通过手动或定时发送的问卷,下线后不支持再次发布。
  • 当问卷发送时机为观众进入直播时发送或直播结束发送时,则无需传入该参数。且该类问卷下线后,可调用 PublishActivityQuestionnaire 接口再次发布。

返回参数

参数类型示例值描述
StatusBooleantrue问卷是否成功下线。下线返回 true

请求示例

POST https://livesaas.volcengineapi.com/?Action=OfflineActivityQuestionnaire&Version=2023-08-01
{
    "ActivityId": 182*******2131,
    "QuestionnaireId": 181******1561,
    "QuestionnairePublishId": 181******1512
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "OfflineActivityQuestionnaire",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

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

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