On this page

TakeSnapshot

POST

https://cloudrecord-api.zego.im/

Call this API to take a screenshot of the mixed stream. You can receive a notification with event_type of 1 through Callback to obtain a JPG format image.

Note
Call frequency limit: 10 times/second

Request

Query Parameters

    Action stringrequired

    Possible values: [TakeSnapshot]

    API prototype parameter

    https://cloudrecord-api.zego.im?Action=TakeSnapshot

    AppId uint32required

    💡Common parameter. Application ID, a unique credential assigned by ZEGOCLOUD. You can obtain it from the ZEGOCLOUD Console.

    SignatureNonce stringrequired

    💡Common parameter. A 16-character hexadecimal random string (hex encoding of an 8-byte random number). For the generation algorithm, refer to Signature Example.

    Timestamp int64required

    💡Common parameter. Current Unix timestamp in seconds. For the generation algorithm, refer to Signature Example. A maximum error of 10 minutes is allowed.

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡Common parameter. Signature version number.

    Signature stringrequired

    💡Common parameter. Signature used to verify the legitimacy of the request. Please refer to Signature Mechanism for generation.

Body

required

Responses

OK
Schema
    Code int64

    Error code.

    Message string

    Error description.

    RequestId string

    Request ID.

Previous

Resume recording

Next

Recording status callback

On this page

Back to top