联系人

更新时间：2023-06-03 09:00

允许在账户中添加、更新和删除联系人，还可以批量导入联系人。

身份验证

验证方式看这里。

添加或更新单个联系人

POST /v5/contacts/upsert

请求参数

名称	类型	必填	描述	示例值
name	string	否	联系人名称。不填写时以email参数为名称值	张三
email	string	是	联系人的邮箱地址。此值不填写时，则phoneNumber参数为必填	zhangsan@easeye.com.cn
phoneNumber	string	否	联系人的联系电话。此值不填写时，则email参数为必填	13800000000
listName	string	否	将该联系人归于某一联系组	123
sandboxMode	boolean	否	是否使用沙盒模式	取值范围：true、false。使用沙盒模式（true），不使用沙盒模式（false）。不填写时默认为不使用

请求示例

{
	"name": "张三",
	"email": "zhangsan@easeye.com.cn",
	"phoneNumber": "13800000000",
	"listName": "123"
}

返回参数

名称	类型	描述
code	int	返回码
message	string	对返回码的文本描述内容

返回示例

{
	"code": 200,
	"message": ""
}

批量导入联系人

POST /v5/contacts/imports

请求参数

名称	类型	必填	描述	示例值
contactData	array[array[object]]	是	联系人数据
contactDataMapping	array[object]	是	联系人数据的映射描述
contactDataMapping.columnNum	int	是	映射序号，从0开始。对应contactData中一组数据的属性值顺序	取值范围：0、1，2，...
contactDataMapping.propertyName	string	是	映射的属性字段值	系统属性取值范围自定义属性取值范围：在平台的UI界面-设置-自定义属性中获取
updateMode	int	是	更新方式	取值范围：1、2、3。创建和更新（1），只创建新的（2），只更新现有的（3）
listName	string	否	导入时是否导入组。不填写时，仅导入联系人；填写时，若没有对应名称的组则新建组，若有对应名称的组则使用现有组	黑名单
sandboxMode	boolean	否	是否使用沙盒模式	取值范围：true、false。使用沙盒模式（true），不使用沙盒模式（false）。不填写时默认为不使用

请求示例

{
	"contactData": [
		[
			"zhangsan@easeye.com.cn",
			"张三"
		],
		[
			"lisi@easeye.net",
			"李四"
		]
	],
	"contactDataMapping": [
		{
			"columnNum": 0,
			"propertyName": "email"
		},
		{
			"columnNum": 1,
			"propertyName": "name"
		}
	],
	"updateMode": 1,
	"listName": "黑名单"
}

返回参数

名称	类型	描述
code	int	返回码
message	string	对返回码的文本描述内容

返回示例

{
	"code": 200,
	"message": ""
}

检索单个联系人

POST /v5/contacts/get

请求参数

名称	类型	必填	描述	示例值
email	string	是	待查询的联系人邮箱地址	zhangsan@easeye.com.cn

请求示例

{
	"email": "zhangsan@easeye.com.cn"
}

返回参数

名称	类型	描述
code	int	返回码
message	string	对返回码的文本描述内容
contact	object	联系人数据
contact.id	string	联系人Id
contact.name	string	联系人名称
contact.email	string	联系人的邮箱地址
contact.phoneNumber	string	联系人的联系电话
contact.wxSubscriber	array[object]	联系人的微信公众号信息
contact.wxMiniSubscriber	object	联系人的微信小程序信息
contact.properties	object	联系人的属性信息
contact.createDate	date	联系人创建时间
contact.modifyTime	date	联系人最后修改时间
contact.createUserId	int	联系人的创建用户Id

返回示例

{
	"code": 200,
	"message": "",
	"contact": {
		"id": "653f663a17e04f6e5a263de6",
		"name": "张三",
		"email": "zhangsan@easeye.com.cn",
		"phoneNumber": "13800000000",
		"properties": {
			"company_address": "公司地址",
			"email_bounced_flag": "1000",
			"email_bounced_time": "2024-02-21T02:11:11.217Z",
			"cu1262_4": "fen11",
			"cu1262_9": "ds4"
		},
		"createDate": "2023-10-30T08:15:54.921Z",
		"modifyTime": "2025-04-21T05:53:01.089Z",
		"createUserId": 123
	}
}

删除联系人

POST /v5/contacts/delete

请求参数

名称	类型	必填	描述	示例值
email	string	是	待删除的联系人邮箱地址	zhangsan@easeye.com.cn
sandboxMode	boolean	否	是否使用沙盒模式	取值范围：true、false。使用沙盒模式（true），不使用沙盒模式（false）。不填写时默认为不使用

请求示例

{
	"email": "zhangsan@easeye.com.cn"
}

返回参数

名称	类型	描述
code	int	返回码
message	string	对返回码的文本描述内容

返回示例

{
	"code": 200,
	"message": ""
}