Cloud Recording
  • Introduction
  • Release notes
  • Getting started
  • Guides
    • Single-stream recording
    • Mixed-stream recording
    • Set mixed-stream layout
    • Multi-sector recording (Whiteboard)
    • Capture screenshots
  • API reference
    • API overview
    • Accessing Server APIs
    • Start recording
    • Stop recording
    • Update the mixed-stream layout
    • Update the whiteboard
    • Query recording status
    • Query the recording task list
    • Pause recording
    • Resume recording
    • Callback of the recording status
    • API testing with Postman
  • Error codes
  • Documentation
  • Cloud Recording
  • API Documents
  • Stop Recording

Stop recording

Last updated:2022-03-31 18:40

Description

Stops 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 endpoint: https://cloudrecord-api.zego.im/?Action=StopRecord
  • Transmission protocol: HTTPS
  • Rate limit: 50 requests/second (testing environment: 20 requests/second)

Request parameters

Listed below are the parameters specific to this request. For the list of public request parameters, see Accessing Server APIs - Public 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 StopRecord method:

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

Response parameters

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

Sample response

The following is a response example of the StopRecord method:

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