本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在你的音视频应用中，你可能会需要对房间内的实时音视频互动按一定时间间隔进行截图，供后续处理。比如，实现存证，鉴别非法信息。

你可以使用 StartSnapshot 这个 OpenAPI 实现这一功能。

你也可以在控制台上开启自动抽帧功能，开启该功能后，若未设置业务标识，默认对房间内每个用户都进行全程抽帧。截图结果会上传到你指定的存储平台。

你可以调用 StartSnapshot 接口，指定你所属的 AppId，对指定 roomId 房间中指定的一路或多路视频流进行截图。
截图结果会上传到你指定的存储平台。你在控制台上设置的回调地址会收到每一张图片的元数据回调。有关回调结果的详细说明，参看SnapshotRealTimeData。

在使用抽帧截图功能前，你必须已经在控制台上开启抽帧截图服务。

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用OpenAPI。

请求频率：QPS 不得超过 150。

• 请求方式：POST
• 请求地址：https://rtc.volcengineapi.com?Action=StartSnapshot&Version=2022-06-01

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

本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。

POST https://rtc.volcengineapi.com?Action=StartSnapshot&Version=2022-06-01

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "TargetStreams": {
        "StreamList": [
            {
                "UserId": "user1",
                "StreamType": 0
            },
            {
                "UserId": "user2",
                "StreamType": 0
            }
        ]
    },
    "MaxIdleTime": 180,
    "ImageConfig": {
        "Format": 0,
        "Width": 800,
        "Height": 800,
        "Interval": 2
    },
    "StorageConfig": {
        "Type": 3,
        "VeImageXConfig": {
            "AccountId": "Your_AccountId",
            "Region": 0,
            "ServiceId": "Your_ServiceId"
        }
    }
}
json

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StartSnapshot",
        "Version": "2022-06-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}
json

您可访问公共错误码，获取更多错误码信息。