---
name: "getAlbums"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "getAlbums - Get album logs."
summary: "Get album logs. Only supports video intercom devices."
---

## getAlbums

> [VERSION] @ray-js/lock-sdk >= 1.0.0

### Description

Get album logs

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | `GetAlbumsParams` | No | Input parameters |

### Return Value

Type: `Promise<GetAlbumsResult>`

Paginated album log list

##### GetAlbumsResult

| Property | Type | Description |
| --- | --- | --- |
| `hasMore` | `boolean` | Has more |
| `list` | `AlbumMessage[]` | Log data |
| `types` | `number[]` | Event type list |

### Referenced Types

##### `interface` GetAlbumsParams

| Property | Type | Description |
| --- | --- | --- |
| `page` | `number` | Page number, default 1 |
| `pageSize` | `number` | Page size, default 20 |
| `startTime` | `number` | Start time in milliseconds |
| `endTime` | `number` | End time in milliseconds |

##### `interface` AlbumMessage

| Property | Type | Description |
| --- | --- | --- |
| `id` | `string` | Message ID |
| `aiInfos` | `Object[]` | AI event list |
| `aiTypes` | `number[]` | AI type aggregation |
| `describe` | `string` | Message content |
| `type` | `number` | Business message type |
| `createTime` | `number` | Creation time (ms) |
| `mediaPath` | `string` | Logical media path |
| `fileKey` | `string` | Object storage file key |
| `fileUrl` | `string` | Accessible URL |
| `mediaBucket` | `string` | Bucket name |
| `mediaKey` | `string` | Media object key |
| `width` | `number` | Image width |
| `height` | `number` | Image height |
| `angle` | `number` | Image angle |
| `position` | `number` | Camera position |
| `isVR` | `boolean` | Whether VR mode is enabled |

##### `type` AlbumMessage.aiInfos

| Property | Type | Description |
| --- | --- | --- |
| `id` | `number` | Event ID |
| `type` | `number` | Event type code |
| `name` | `string` | Event name |
| `desc` | `string` | Event description |
| `happenTime` | `number` | Detection time (ms) |
| `isCorrected` | `boolean` | Whether the user has corrected the annotation |


### Examples

```ts
import { getAlbums } from '@ray-js/lock-sdk';
const albums = await getAlbums({ offset: 0, limit: 20 });
```