Take a Snapshot

Description

You can call this method to take a snapshot of the mixed stream. You can receive a notification with event_type set to 1 through the callback to get a JPG image.

Request method and endpoint

Request method: POST
Request URL: https://cloudrecord-api.zego.im/?Action=TakeSnapshot
Transmission protocol: HTTPS
Rate limit: 10 requests/second

Request parameters

Listed below are the parameters specific to this request. For the list of common request parameters, see Accessing Server APIs - Common parameters.

Parameter	Type	Required	Description
TaskId	String	Yes	The mixed stream recording task ID (in progress). You can get it from the response of Start recording and Query the recording task list APIs. The value is a 16-byte character string.

Sample request

Request URL

Untitled

https://cloudrecord-api.zego.im/?Action=TakeSnapshot
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0

Copied!

Request message body
Untitled
{ "TaskId": "XXXXXXXXXXX" }
1
Copied!

Response parameters

Parameter	Type	Description
Code	Int64	Return code.
Message	String	Description of the request execution result.
RequestId	String	Request ID.

Sample response

Untitled

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123"
}

Copied!