ANangelcam
recording

General recording information

get/recording/{recording_id}/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesrecording_access
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

recording_idstring uuid required

Recording UUID

Response

Returns general recording information.

idstring uuid required

Recording ID

status'READY' | 'CONNECTING' | 'RECORDING' | 'STOPPING' | 'ERROR' required

Recording status values have the following meaning:

  • READY - Not recording (recording is ready to be started)
  • CONNECTING - Recorder is trying to connect to the stream (this usually indicates camera connectivity problems; the recorder keeps trying to connect).
  • RECORDING - Recorder is connected to the stream and records are being created
  • STOPPING - Recording is stopping
  • ERROR - Error occurred when recording (this indicates a possible issue with Angelcam infrastructure)
retentionstring nullable required

Retention period in ISO 8601 duration format tells how long in past we store the footage. Example: P7D means 7 days.

record_queue_capacitynumber nullable

Capacity of the record queue in seconds, maxium amount of seconds to be recorded in total, unlimited if null

deactivated_atstring datetime nullable required

Datetime when recording service has been deactivated, if null then recording is active.

recording_startstring datetime nullable

Recording footage start datetime, if null there is no recording footage

recording_endstring datetime nullable

Recording footage end datetime, if null there is no recording footage

Example response

{
  "id": "df5fcd78-6114-4750-b23a-cec3c3febc5b",
  "status": "RECORDING",
  "retention": "P7D",
  "deactivated_at": null,
  "record_queue_capacity": null,
  "recording_start": "2024-05-02T10:32:11.000Z",
  "recording_end": "2024-05-07T16:58:7.5400Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.