Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Feeds

This endpoint allows developers to list and retrieve information about the feeds that are generated by a device.
It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available feeds, not the number of feeds resulting from the query string.

get/feeds

Query parameters

deviceIdstring
Example:10058b7a

The device generating the feed.

deviceId__instring[]

The device ID's of the devices for which to return the feeds.

[
  "10058b7a"
]
type'main' | 'preview' | 'talkdown'

The stream type of the device used to generate the feed.

includestring[]
pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Response

OK

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger required

Size of the total result set.

Example response

{
  "results": [
    {
      "id": "10058b7a-main",
      "deviceId": "10058b7a",
      "flvUrl": "https://media.c13.eagleyenetworks.com/10058b7a/main.flv",
      "rtspUrl": "rtsp://media.c13.eagleyenetworks.com/media/streams/main/rtsp",
      "rtspsUrl": "rtsps://media.c13.eagleyenetworks.com/media/streams/main/rtsp",
      "localRtspUrl": "rtsp://10.0.0.1:554/",
      "hlsUrl": "https://media.c13.eagleyenetworks.com/media/streams/main/hls",
      "webRtcUrl": "https://media.c13.eagleyenetworks.com/media/streams/main/webRtc",
      "audioPushHttpsUrl": "https://media.c13.eagleyenetworks.com/media/streams/audio"
    }
  ]
}