Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Media

This endpoint requests a list of intervals for which there are recordings for the given type and mediaType. If no endTimestamp__lte (formatted according to ISO 8601) is given, then the results until now are returned.

Note: The ISO 8601 timestamp format is a standardized format for representing date and time information. It uses the format 'YYYY-MM-DDTHH:MM:SS.sss±hh:mm' where "T" is the separator between the date and time portions.

get/media

Query parameters

deviceIdstring required
Example:10058b7a

The ID of the device that generates the media.

type'preview' | 'main' required

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

mediaType'video' | 'image' required

The type of media that is queried.

startTimestamp__gtestring date-time required
Example:2022-08-08T07:57:37.000+00:00

Minimum timestamp from which you want to list recordings. Timestamps are according to ISO 8601.

endTimestamp__ltestring date-time
Example:2022-08-08T08:57:37.000+00:00

Maximum timestamp till which you want to list recordings.

coalesceboolean

If true, we coalesce connected intervals into a single. An interval is seen as connected if the end time and start time are exactly the same.

includestring[]

Allows clients to request optional information such us URLs necessary to configure third party IDPs.

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.

Example response

{
  "results": [
    {
      "deviceId": "10058b7a",
      "flvUrl": "https://media.c13.eagleyenetworks.com/media/streams/main/flv",
      "rtspUrl": "rtsp://media.c13.eagleyenetworks.com/media/streams/main/rtsp",
      "rtspsUrl": "rtsps://media.c13.eagleyenetworks.com/media/streams/main/rtsp",
      "hlsUrl": "https://media.c13.eagleyenetworks.com/media/recordings/main/hls/playlist.m3u8",
      "multipartUrl": "https://media.c13.eagleyenetworks.com/media/streams/main/multipart",
      "mp4Url": "https://media.c13.eagleyenetworks.com/media/recordings.mp4"
    }
  ]
}