---
name: "getPetList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.6.27" }
title: "getPetList - 获取宠物列表"
---

## getPetList

> [VERSION] @ray-js/ray >= 1.6.27

### 描述

获取宠物列表

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `data` | `GetPetList` | 是 | 请求参数：ownerId 家庭 id；bizTypes 可选，内部会固定为宠物中心业务 |

### 返回值

类型: `Promise<Pet[]>`

Promise，resolve 值为当前家庭下的宠物列表（GetPetListResult）

##### Pet

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `ownerId` | `string` | 家庭id |
| `petType` | `"cat" \| "dog"` | 宠物类型 |
| `name` | `string` | 宠物名字，不能超过40个字符 |
| `avatar` | `string` | 宠物头像路径，以 "smart/" 开头 |
| `sex` | `number` | 性别. 0-雌性, 1-雄性, 2-绝育雌性, 3-绝育雄性 |
| `activeness` | `number` | 活跃度，0-不活跃，1-正常，2-非常活跃 |
| `birth` | `number` | 生日, 单位: 毫秒 |
| `weight` | `number` | 体重，单位为g |
| `breedCode` | `string` | 品种code(从宠物品种列表接口获取) |
| `rfid` | `string` | rfid |
| `id` | `number` | 宠物id |
| `avatarDisplay` | `string` | 宠物头像可访问路径 |
| `extInfo` | `string` | 额外信息，不要放敏感信息 |
| `breedName` | `string` | 品种名称 |
| `gmtCreate` | `number` | 创建时间戳，单位毫秒 |
| `gmtModified` | `number` | 修改时间戳，单位毫秒 |
| `bindFood` | `boolean` | 是否绑定宠物粮食 |

### 引用对象

##### `type` GetPetList

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `ownerId` | `string` | 家庭id |
| `bizTypes` | `number[]` | 业务类型，1-宠物中心，2-宠物AI，默认为1 |


### 示例代码

#### 请求示例

```typescript
import { getPetList } from '@ray-js/ray';

getPetList({
  ownerId: 'xxxx',
  bizTypes: [2],
});
```

#### 返回示例

```json
[
  {
    "id": 1,
    "ownerId": "xxxx",
    "petType": "cat",
    "name": "福宝",
    "avatar": "smart/xxxx/xxxx/xxxx",
    "avatarDisplay": "https://xxx/xxx",
    "sex": 1,
    "activeness": 1,
    "birth": 1614528000000,
    "weight": 5000,
    "breedCode": "xxx",
    "breedName": "金吉拉",
    "rfid": "xxxxx",
    "extInfo": "",
    "bindFood": false,
    "gmtCreate": 1740792022716,
    "gmtModified": 1741785184589
  }
]
```