logo
当前页

截图


描述

调用本接口,可对 混流画面 进行一次截图,您可通过 回调 接收 event_type1 的通知,获取一张格式为 JPG 的图片。

接口原型

  • 请求方法:POST
  • 请求地址:https://cloudrecord-api.zego.im/?Action=TakeSnapshot
  • 传输协议:HTTPS
  • 调用频率限制:10 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 中的 “公共请求参数”。

参数类型是否必选描述
TaskIdString混流录制任务 ID(进行中)。可通过 开始录制查询录制任务列表 接口的响应获取,长度固定为 16 个字节的字符串。

请求示例

  • 请求 URL
    Untitled
    https://cloudrecord-api.zego.im/?Action=TakeSnapshot
    &AppId=1234567890
    &SignatureNonce=15215528852396
    &Timestamp=1234567890
    &Signature=7a2c0f11145fb760d607a07b54825013
    &SignatureVersion=2.0
    
    1
    Copied!
  • 请求消息体
    Untitled
    {
        "TaskId": "XXXXXXXXXXX"
    }
    
    1
    Copied!

响应参数

参数类型描述
CodeInt64错误码。
MessageString错误描述。
RequestIdString请求 ID。

响应示例

Untitled
{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123"
}
1
Copied!

Previous

恢复录制

Next

录制状态回调