Skip to main content

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

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

Loading...