---
name: "addPet"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.6.27" }
title: "addPet - 新增宠物"
---

## addPet

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

### 描述

新增宠物

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `data` | `PetAdd` | 是 | 请求参数：宠物基础信息、时区 timeZone、业务数据类型 dataType 等，详见类型 PetAdd |

### 返回值

类型: `Promise<number>`

Promise，resolve 值为新建宠物的 id（number）

### 引用对象

##### `type` PetAdd

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `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 |
| `bizType` | `1 \| 2` | 业务类型，1-宠物中心，2-宠物助手，默认为2 |
| `devIds` | `string[]` | 关联设备IDs |
| `foodId` | `number` | 关联主粮ID |
| `extInfo` | `string` | 额外信息，不要放敏感信息 |
| `idPhotos` | `IdPhotos[]` | 宠物正面照 |
| `features` | `Feature[]` | 宠物特征code |
| `personalities` | `string[]` | 宠物性格code |
| `timeZone` | `string` | 时区 |
| `dataType` | `string` | 业务数据类型 |

##### `type` IdPhotos

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `angle` | `string` |  |
| `objectKey` | `string` |  |
| `display` | `string` |  |

##### `type` Feature

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `category` | `string` |  |
| `details` | `string[]` |  |

##### `type` Images

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `imageDisplayUrl` | `string` |  |
| `objectKey` | `string` |  |
| `angle` | `string` |  |
| `desc` | `string` |  |


### 示例代码

#### 请求示例

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

addPet({
  bizType: 1,
  ownerId: 'xxxx',
  petType: 'cat',
  name: '福宝',
  avatar: 'smart/xxxx/xxxx/xxxx',
  sex: 1,
  activeness: 1,
  birth: 1614528000000,
  weight: 5000,
  breedCode: 'xxx',
  idPhotos: [
    {
      angle: 'firstFront',
      objectKey: 'xxxx',
    },
  ],
  features: [
    {
      category: 'eyeColor',
      details: ['棕色'],
    },
  ],
});
```

#### 返回示例

```json
2
```