Skip to main content

Create a New Recording Session

Creates a new active recording of the session. Certain metadata, like the title and description, are automatically copied from the session. The sources to record can be specified in the request. By default, the active recording records all of the session’s sources. Sources that are not associated with the session are ignored.

Authorizations: Sessions - RECORD

Requests

POST /apis/sessions/:sessionId/recordings
{
"recorders": [
{
  "source": "323e1db5-5bb4-4988-85fc-b07605b365c8"
},
{
  "source": "54fde7cd-c734-470e-b188-5d60def4f63a"
}
]
}

Response

Success

{
"data": {
  "id": "bea38704-ef95-4330-9f77-ad52a2c5a8b3",
  "session": "ad0eff6f-12b3-4622-893e-a5586046ab82",
  "username": "haiadmin",
  "state": "RECORDING",
  "duration": 0,
  "recorders": [
    {
      "source": "323e1db5-5bb4-4988-85fc-b07605b365c8",
      "chunk": "asset-chunk://bea38704-ef95-4330-9f77-ad52a2c5a8b3/3/0/0",
      "id": "7"
    },
    {
      "source": "54fde7cd-c734-470e-b188-5d60def4f63a",
      "chunk": "asset-chunk://bea38704-ef95-4330-9f77-ad52a2c5a8b3/4/0/0",
      "id": "8"
    }
  ],
  "ctime": 1399407563,
  "title": "InfoDevSession - 06/05/2014, 15:26"
}
}


Error

Code

Payload

 Description

403
{"code":"040006", "name":"SessionHidden",
"message":"Session hidden",
"httpStatusCode":403}

Session is hidden and requester does not own the session.

404
{"code":"040006", "name":"SessionNotFound",
"message":"Session not found", "httpStatusCode":404}

Session with UUID sessionId not found.

409
{"code":"060009","name":"SessionHasNoSource",
"message":"Session requires at least one source",
"httpStatusCode":409}

Session must have at least one source.

500
{"code":"070027","name":"InsufficientSpace",
"message":"Insufficient disk space on server to
complete operation",
"httpStatusCode":500}

The server has run out of disk space.

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.