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

企业直播

复制全文
下载 pdf
互动工具
SendCheckIn - 直播间内发送签到
复制全文
下载 pdf
SendCheckIn - 直播间内发送签到

调用 SendCheckIn 接口,在指定直播间发送指定签到。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 前提条件:
    • 确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理
    • 发送签到时,请确保签到为未发送状态。即 GetCheckInListAPI 接口中返回参数 Status 的取值为 Init 时,可调用当前接口发送签到。

请求说明

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

调试

请求参数

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

Query

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

Body

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

ActivityId

Long

1783****8443

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

说明

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

CheckInId

String

checkIn123456789

签到 ID。您可以通过 GetCheckInListAPI 接口获取 ID。

说明

发送签到时,请确保签到为未发送状态。即 GetCheckInListAPI 接口中返回参数 Status 的取值为 Init 时,可调用当前接口发送签到。

返回参数

参数类型示例值描述
StatusBooleantrue签到是否发送成功。成功返回 true

请求示例

POST https://livesaas.volcengineapi.com/?Action=SendCheckIn&Version=2023-08-01
{
    "ActivityId": 1783****8443,
    "CheckInId": "checkIn123456789"
}

返回示例

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

错误码

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

最近更新时间:2026.08.19 11:45:59
这个页面对您有帮助吗?
有用
有用
无用
无用