logo
On this page

Stop recording


Description

You can call this method to stop cloud recording.

When you call the StopRecord method, the Cloud Recording service stops recording in the room and uploads the recording file to the preset third-party cloud storage platform.

Request method and endpoint

  • Request method: POST
  • Request URL: https://cloudrecord-api.zego.im/?Action=StopRecord
  • Transmission protocol: HTTPS
  • Rate limit: 50 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.

ParameterTypeRequiredDescription
TaskIdStringYesTask ID. The value is a 16-byte character string.

Sample request

  • Request URL
    Untitled
    https://cloudrecord-api.zego.im/?Action=StopRecord
    &AppId=1234567890
    &SignatureNonce=15215528852396
    &Timestamp=1234567890
    &Signature=7a2c0f11145fb760d607a07b54825013
    &SignatureVersion=2.0
    
    1
    Copied!
  • Request message body
    Untitled
    {
        "TaskId": "XXXXXXXXXXX"
    }
    
    1
    Copied!

Response parameters

ParameterTypeDescription
CodeInt64Return code.
MessageStringDescription of the request execution result.
RequestIdStringRequest ID.

Sample response

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

Previous

Start recording

Next

Update the mixed stream layout