Pearl REST API add a bookmark to a recording
A bookmark marks a point of interest inside a recording while it is being made. Bookmarks are added per channel and are written into the archive file the channel is currently recording.
Applies to: Pearl-2, Pearl Mini, Pearl Nexus, Pearl Nano.
POST /api/v2.0/channels/{cid}/bookmarks?text=Keynote%20starts
The text parameter is required and supplies the bookmark name.
Format restriction. Adding a bookmark is supported only for recordings in MP4 or MOV format. The operation is not supported for recordings in any other format, and attempting it returns HTTP 400.
The channel must be recording. A bookmark cannot be added to a channel that is not currently being recorded; that returns HTTP 409.
Responses.
| Code | Meaning |
|---|---|
| 200 | Bookmark command processed successfully |
| 400 | Missing or invalid parameters, or the recording format does not support bookmarks |
| 404 | Channel not found |
| 409 | The channel is not being recorded |
| 500 | Internal error while creating the bookmark |
Because the format and recording-state conditions both have to hold, check the recorder status for the channel before issuing a bookmark call in an automation script.