---
name: "getAlbums"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "getAlbums - 获取相册日志。"
summary: "获取相册日志。仅支持视对讲设备。"
---

## getAlbums

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

### 描述

获取相册日志

### 参数

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `page` | `number` | 否 | 页码，默认 1 |
| `pageSize` | `number` | 否 | 每页数量，默认为 20 |
| `startTime` | `number` | 否 | 开始时间，单位为毫秒 |
| `endTime` | `number` | 否 | 结束时间，单位为毫秒 |

### 返回值

类型: `Promise<GetAlbumsResult>`

相册类日志分页列表

##### GetAlbumsResult

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `hasMore` | `boolean` | 是否有更多 |
| `list` | `AlbumMessage[]` | 日志数据 |
| `types` | `number[]` | 事件类型列表 |

### 引用对象

##### `interface` AlbumMessage

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `id` | `string` | 消息 id |
| `aiInfos` | `Object[]` | AI 事件列表 |
| `aiTypes` | `number[]` | AI 类型聚合 |
| `describe` | `string` | 消息文案 |
| `type` | `number` | 业务消息类型 |
| `createTime` | `number` | 创建时间（毫秒） |
| `mediaPath` | `string` | 媒体逻辑路径 |
| `fileKey` | `string` | 对象存储 file key |
| `fileUrl` | `string` | 可访问 URL |
| `mediaBucket` | `string` | 存储桶名 |
| `mediaKey` | `string` | 媒体对象 key |

##### `type` AlbumMessage.aiInfos

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `id` | `number` | 事件 id |
| `type` | `number` | 事件类型码 |
| `name` | `string` | 事件名称 |
| `desc` | `string` | 事件描述 |
| `happenTime` | `number` | 检出时间（毫秒） |
| `isCorrected` | `boolean` | 用户是否已修正标注 |


### 示例代码

#### 示例

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