Start or Stop Manual Recording by Accessory Id

This API call allows starting, stopping or checking status for manual recordings. If start-recording is invoked a new Activity is automatically created. If a duration isn't passed to start-recording, then 30 seconds will be used. Notification Events will appear for new requested recordings. The newly created Activity may not appear in Get Activity by Id or Get Activities by Accessory Id for a little while after creation due to processing time.

Permissions

Requires a Permissions scope of: circle:accessories or circle:activities_basic

Response Body

Main Object

Name

Type

Description

status

string

One of:

recording - A manual recording via this API call is currently in progress
none - No manual recording is in progress

context

object

Contains a StartRecordingContext, StopRecordingConext or StatusRecordingContext object depending on type requested.

StartRecordingContext Sub-Object

Name

Type

Description

activityId

string

The new Activity Id that will be used. Follow progress via Notification Events.

previousStatus

string

The status that was previously in use. Can be used to determine if caller changed actual current status.

StopRecordingContext Sub-Object

Name

Type

Description

previousStatus

string

The status that was previously in use. Can be used to determine if caller changed actual current status.

StatusRecordingContext Sub-Object

activityId

string

The current Activity Id being recorded. Empty string if none.

duration

integer

Length of time in seconds to record.

durationRemaining

integer

Length of time in seconds left to record.

source

string

The Activity Set
based source attribute from the start-recording request.

Language
Authentication
OAuth2