Doorbell Camera Webservice

Share an live video stream for a doorbell camera

Share an live video stream for a doorbell camera

post/api/doorbellcamera/createSharedLiveVideoStream

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/doorbellcamera/createSharedLiveVideoStream
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

audioGatewayUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

doorbellCameraUuidstring DeviceFacetUuid nullable required

RUUID with optional appended facet information

expirationTimeSecsinteger nullable

Add a expiration date for accessing the stream in seconds

invertScheduleboolean nullable

If given a schedule uuid, will hide the stream during the schedule instead and show it otherwise

namestring nullable

If not provided, will be named 'Unnamed'

passwordstring nullable

Add a password to allow access to your shared stream. If null or blank password is not set.

scheduleUuidstring RUUID nullable

base 64 (url-safe) uuid string

streamType'USER' | 'ALARM_MONITORING' | 'DICE' | 'LUMEO' | 'INFORMACAST' | 'RAPIDSOS' | 'UNKNOWN' required
vodEnabledboolean nullable required

Enables recording of live footage to a VOD

Example request

{
  "audioGatewayUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "doorbellCameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "expirationTimeSecs": 86400,
  "name": "Front Door Stream",
  "password": "mypassword123",
  "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "vodEnabled": true
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
sharedLiveM3U8StreamUrlstring nullable

M3U8 URL for the shared live video stream

sharedLiveVideoStreamUrlstring nullable

URL for the shared live video stream

sharedLiveVideoStreamUuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "sharedLiveM3U8StreamUrl": "https://example.com/live/m3u8/stream",
  "sharedLiveVideoStreamUrl": "https://example.com/live/video/stream",
  "sharedLiveVideoStreamUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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