Share an live video stream for a doorbell camera

Share an live video stream for a doorbell camera

POST /api/doorbellcamera/createSharedLiveVideoStream

Share an live video stream for a doorbell camera

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/doorbellcamera/createSharedLiveVideoStream \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "doorbellCameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "vodEnabled": true
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "sharedLiveM3U8StreamUrl": "https://example.com/live/m3u8/stream",
  "sharedLiveVideoStreamUrl": "https://example.com/live/video/stream",
  "sharedLiveVideoStreamUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · 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.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for creating a shared live video stream for a doorbell camera.

doorbellCameraUuid · string<DeviceFacetUuid> | null · required

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

streamType · enum<string> · required

Available options: USER, ALARM_MONITORING, DICE, LUMEO, INFORMACAST, RAPIDSOS, UNKNOWN

vodEnabled · boolean | null · required

Enables recording of live footage to a VOD

Example:

true

audioGatewayUuid · string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

expirationTimeSecs · integer<int32> | null

Add a expiration date for accessing the stream in seconds

Example:

86400

invertSchedule · boolean | null

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

Example:

false

name · string | null

If not provided, will be named 'Unnamed'

Example:

"Front Door Stream"

password · string | null

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

Example:

"mypassword123"

scheduleUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for creating a shared live video stream for a doorbell camera.

error · boolean | null

errorMsg · string | null

sharedLiveM3U8StreamUrl · string | null

M3U8 URL for the shared live video stream

Example:

"https://example.com/live/m3u8/stream"

sharedLiveVideoStreamUrl · string | null

URL for the shared live video stream

Example:

"https://example.com/live/video/stream"

sharedLiveVideoStreamUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg · string | null