UpdateCheckInConfig - 新增或更新签到--企业直播-火山引擎

文档中心

立即注册

企业直播

互动工具

UpdateCheckInConfig - 新增或更新签到

调用 UpdateCheckInConfig 接口，在指定直播间创建或更新签到配置信息。

注意

为避免签到参数值被替换为默认值，即便参数在该接口中为非必选，只要您有自定义的需求，就必须传入对应的参数值。

注意事项

前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateCheckInConfig`	接口名称。当前 API 的名称为 `UpdateCheckInConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1783****8443`	直播间的 ID。您可以通过 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
CheckInName	String	是	`上课签到`	签到名称。长度为 1 到 20 个字符。
CheckInId	String	否	`checkIn123456789`	签到 ID。要新增签到时，不传该参数或将该参数设为空。要更新签到配置时，传入待更新的签到 ID。您可以通过 GetCheckInListAPI 接口获取 ID。
SendType	Integer	否	`1`	签到发送类型。默认值为`0`。取值如下： `0`：手动发送 `1`：自动发送
Deadline	Long	否	`1`	签到倒计时中的分钟数。取值范围为 `[0,999]`，单位为分钟。默认值为 `0`。说明总倒计时时长为 `Deadline` 和 `DeadlineSecond` 两个参数设置的时间之和。
DeadlineSecond	Integer	否	`30`	签到倒计时中的秒数。取值范围为 `[0,59]`，单位为秒。默认值为 `0`。说明当 `Deadline`取值为 `0` 时，该参数必选且生效，且取值范围为 `[30,59]`。总倒计时时长为 `Deadline` 和 `DeadlineSecond` 两个参数设置的时间之和。
AutoSendTime	Long	否	`1704040000`	定时发送时间。Unix 时间戳，单位为秒。该时间至少需在当前时间的一分钟之后。说明仅当 `SendType` 取值为 `1` 时，该参数生效且必填。
NeedPersonInfo	Integer	否	`1`	是否需要用户填写签到信息。默认值为`0`。取值如下： `0`：不需要 `1`：需要
CheckInInfo	String	否	`请输入姓名`	签到提示文案。默认值为 `请输入姓名`。长度为 1 到 20 个字符。
IsSendComment	Integer	否	`1`	签到后是否会在聊天区发送评论。默认值为`0`，即不发送。取值如下： `0`：不发送 `1`：发送
CommentContent	String	否	`#用户昵称#已签到`	签到后自动发送的评论文案。长度为 1 到 100 个字符。默认值为 `#用户昵称#已签到`。您可以在文案中插入以下变量，每个变量仅允许使用一次： `#用户昵称#`：观众的实际昵称。例如：如果用户昵称为“观众 A”，则该用户签到后默认发送的文案为“观众 A已签到”。 `#签到时间#`：观众完成签到的时间，格式为 `YYYY-MM-DD HH:mm`，例如 2024-03-12 10:32。 `#签到标题#`：当前签到的名称（即 `CheckInName` 的值）。说明仅当 `IsSendComment` 取值为 `1` 时，该参数生效。
CannotWatchLiveWhenNotCheckIn	Integer	否	`1`	未按时签到的观众是否会被踢出直播间。默认值为 `0`。取值如下： `0`：不被踢出 `1`：被踢出，将无法继续观看直播
CannotWatchLivePrompt	String	否	`因长时间未签到，已暂停观看`	踢出提示文案。默认值为 `因长时间未签到，已暂停观看`。长度为 1 到 50 个字符。说明仅当 `CannotWathcLiveWhenNotCheckIn` 取值为 `1` 时，该参数生效。

返回参数

参数	类型	示例值	描述
CheckInId	String	`checkIn123456789`	签到 ID。可用于后续查询或更新该签到信息。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateCheckInConfig&Version=2023-08-01
{
    "CheckInId": "checkIn123456789",
    "CheckInName": "上课签到",
    "Deadline": 1,
    "ActivityId": 1783****8443,
    "NeedPersonInfo": 1,
    "IsSendComment": 1,
    "CommentContent": "#用户昵称#已签到",
    "DeadlineSecond": 30,
    "CannotWatchLiveWhenNotCheckIn": 1,
    "SendType": 1,
    "AutoSendTime": 1704040000,
    "CannotWatchLivePrompt": "因长时间未签到，已暂停观看",
    "CheckInInfo": "请输入姓名"
}

返回示例

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

错误码

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

最近更新时间：2026.03.17 13:39:18

这个页面对您有帮助吗？

有用

无用

企业直播

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #