Pause recording

Description

You can call this method to pause a task of recording audio streams, video streams, and whiteboards in a room.

Warning

This method can be used only to pause mixed-stream recording tasks.

Request method and endpoint

Request method: POST
Request URL: https://cloudrecord-api.zego.im/?Action=PauseRecord
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	Task ID. The value is a 16-byte character string.

Sample request

The following is a request example of the PauseRecord method:

Request URL

Untitled

https://cloudrecord-api.zego.im/?Action=PauseRecord
&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!