Skip to Content

TwentyThree™ API

API Method: /api/live/recording/status

Get the current status of a live recording

Parameters

ParameterDescription
live_id (required)The ID for the stream you want to retrieve status for.

Permission level

The minimum required permission level is:

write

Example XML Response

<response status="ok" permission_level="write" cached="0">
  <status>recording</status>
  <upload_token>live-678j35g34jh54309</status>
</response>

Example JSON Response

{
  "status": "ok", 
  "message":"The stream has stopped recording",
  "permission_level":"write",
  "cached":"0",
  "p": "1",
  "size": "1",
  "live":{"status": "recording", "upload_token": "live-678j35g34jh54309"},
  "site": { ...},
  "endpoint": "/api/live/stop-recording"
}