Start recording api starts cloud recording.

post/v1/recording/start

Start recording api submit request to start recording to agora cloud recording service.

post/v1/recording/start

https://managedservices-prod.rteappbuilder.com/

Request

HEADER

AuthorizationREQUIRED

TYPE: STRING

JWT token as auth header. Format "Bearer <xxxxx.yyyyy.zzzzz>" xxxxx.yyyyy.zzzzz is the JWT token

REQUEST BODY

request agora cloud recording service to start recording for request.

passphrase

TYPE: STRING

url

TYPE: STRING

webpage_ready_timeout

TYPE: INTEGER

mode

TYPE: STRING

[web, mix]

encryption

TYPE: BOOLEAN

SAMPLE REQUEST
{
  "passphrase": "host_passphrase",
  "url": "https://appbuilder.agora.io",
  "webpage_ready_timeout": 10,
  "mode": "web",
  "encryption": false
}

Responses

success

SAMPLE RESPONSE
{
  "error": {
    "code": 611,
    "message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
  }
}

SAMPLE RESPONSE
{
  "error": {
    "code": 611,
    "message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
  }
}

SAMPLE RESPONSE
{
  "error": {
    "code": 611,
    "message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
  }
}

SAMPLE RESPONSE
{
  "error": {
    "code": 611,
    "message": "The API request is invalid, improperly formed, or missing a required field. Please refer to the API documentation to identify which parameters are valid for your request."
  }
}