# 添加好友事件


**请求参数（未加密）**

| 请求参数名                        | 类型       | 说明                                                |
| --------------------------------- | ---------- | --------------------------------------------------- |
| data                              | `Object`   | 消息体                                              |
| data.id                           | `String`   | 事件id                                              |
| data.event                        | `String`   | 事件主类型（固定：CRM_FRIEND）                      |
| data.action                       | `String`   | 事件子类型（创建好友：CRMFriendCreated）            |
| data.body                         | `Object`   | 数据内容                                            |
| data.body.id                      | `Long`     | 好友id                                              |
| data.body.uid                     | `String`   | 操作人ID                                            |
| data.body.triggerTs               | `Int`      | 触发时间戳                                          |
| data.body.new                     | `Object`   | 新创建的好友信息                                    |
| data.body.new.id                  | `Long`     | 好友id                                              |
| data.body.new.friendType          | `String`   | 好友类别（WX_CONTACT：微信好友，QW_CONTACT：企微好友）                                            |
| data.body.new.state               | `String`   | 好友状态                                            |
| data.body.new.contactID           | `String`   | 关联联系人ID                                        |
| data.body.new.uid                 | `String`   | 加好友的员工ID                                      |
| data.body.new.remark              | `String`   | 备注                                                |
| data.body.new.corpRemark          | `String`   | 企业备注                                            |
| data.body.new.mobiles             | `String[]` | 手机号                                              |
| data.body.new.tags                | `Object[]` | 好友标签                                            |
| data.body.new.tags.id             | `String`   | 标签ID                                              |
| data.body.new.tags.type           | `Int`      | 标签类别                                            |
| data.body.new.description         | `String`   | 描述                                                |
| data.body.new.qwExternalUserID    | `String`   | 企微外部联系人ID                                    |
| data.body.new.qwUnionID           | `String`   | 企微UnionID                                         |
| data.body.new.qwExternalUserState | `String`   | 加友渠道(活码state参数，用于区分不同的添加好友渠道)[查询活码详情](https://open.dustess.com/doc-5158634.md) |
| data.body.new.source              | `String`   | 好友来源id                                          |

**请求参数示例**
`json` - Request-Example-加密:

```json
//明文信息推送
{
	"id": "902e9918-ca15-4876-bd1e-7b0341587c5f",
	"event": "CRM_FRIEND",
	"action": "CRMFriendCreated",
	"body": {
		"id": 60764790875754497,
		"uid": "10152",
		"triggerTs": 1663143455,
		"new": {
			"id": 60764790875754497,
			"friendType": "WX_CONTACT",
			"state": "active",
			"contactID": "",
			"uid": "10152",
			"remark": "Shen",
			"corpRemark": "",
			"mobiles": null,
			"tags": [],
			"description": "",
			"qwExternalUserID": "wmXvtYBgAAwiagId_v9oW7wMxXToZdFw",
			"qwUnionID": "ocPi06NtoP4ADU2WouotKaGMIFvw",
			"qwExternalUserState":"",
			"source":""
		}
	}
}

//信息加密推送
{
	"id": "902e9918-ca15-4876-bd1e-7b0341587c5f",
	"event": "CRM_FRIEND",
	"action": "CRMFriendCreated",
	"body": {
		"encrypt": "XOKphmyMEcuW94gYtL/5Nj4ueFcfjaEFecC507QGzXbnDmavLp7I+s7K5BI4Qjt+Ayy/mNbw9bUE2x0HkSWm9h57VKJc9VLBghTjALWJcJduBDC7L6doORsZdaNlfVJU6DJ0VLyd1NojW9PfrzS01eQ7GW/dgaO3tkXQP2AOrGTn3Ca8haZQiwEJDYN/NUjW1/9T+gIcBu8LbmZGyokwrOD+ZGy7uky37yq8w8SGpis1WR2pIlZUOo+QdmWnMY1kJ9bHelH9h3ERemmNRIh/oMZp7QvFaNl/iCgUVAkh14tOV0nniE9Ld29GxyIEFz0nxD5+s4AG4cvq+xl+FXhu0A==",
		"msgSignature": "d64cc4a02b22b725a6b50a9843ebf9c0fd7ca70f",
		"timeStamp": "1661233174",
		"nonce": "9ZvYhI4aFmR7wUNl"
	}
}
```

**成功响应**

| 响应参数名 | 类型     | 说明                         |
| ---------- | -------- | ---------------------------- |
| code       | `Int`    | 响应码:状态码 0 失败，1 成功 |
| msg        | `String` | 响应提示                     |

**成功响应示例**

```json
 {
    "code": 1,
    "msg": "成功"
}
```

**错误响应示例**

```json
 {
    "code": 0,
    "msg": "处理失败"
}
```