start live streaming

GET

/partners/live/{device_id}/{channel}

devicelivestream

Starts a live streaming for a device. To save the cellular data plan of the device, the live streaming link must be open in 5s, and the m3au list needs to be refreshed every 5s, or it will be regarded as not playing and the connection will close and expire.

Channel can be 1, 2, 3, 4. Please check a device to see the available live streaming channels. If a channel is not available, it can not be played.

Once a link is opened and being played back, it will not stop itself as long as any player is playing it. So it is the developer's duty to set up automatic-stop mechanism, such as a timer, to stop a player that opens and opens too long.

Request

Path Params

device_id

integer

required

Device ID to live stream

>= 0

Example:

1234567890

channel

integer

required

channel to live stream. Channel must be active on device to live stream

>= 1<= 4

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://fleet.roscolive.com/api/v1.0/partners/live/1234567890/1' \
--header 'Content-Type: text/plain' \
--data-raw ''

Responses

🟢200Success

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

response

object

required

Contains response data

modem_rssi

string

required

Received Signal Strength Indicator for device network

Examples:

-630

token

string

required

Live stream token for .m3u8 manifest file

>= 8 characters<= 8 characters

Match pattern:

^[A-Za-z0-9]+.m3u8

url

string

required

URL to manifest file

Example:

https://fleet.roscolive.com:8080/live/3299582673/1/O2lQYFdR.m3u8

result

string

required

"OK" if request successful, otherwise "Failed"

Example

{
  "meta": {
    "code": 200
  },
  "response": {
    "modem_rssi": "-63",
    "token": "w3m3u86r.m3u8",
    "url": "https://fleet.roscolive.com:8080/live/3299582673/1/w3m3u86r.m3u8"
  },
  "result": "OK"
}

🟠400Invalid input

🟠404Record not found

🟠404Resource Not Found

🔴500Internal Server Error

🟠403Forbidden

🟠401Login Required

Modified at 2024-07-25 02:00:14

update an event

get list of companies with data usage for date range