联系人列表成员

用户可以通过以下接口对所属的联系人列表的增删改查

新建联系人列表成员

请求ULR

http://api.ifaxin.com/lists/{list_id}/members/save

HTTP请求方式

POST

参数说明

参数	类型	必须	说明
access_token	string	是	通过获取access_token接口获取到的access_token
list_id	string	是	联系人列表的id
address	string	是	邮箱地址
phone	string	否	联系电话
name	string	否	名称
vars	string	否	变量

说明

address、phone、vars必须对应符合邮箱格式规范、电话格式规范、json格式规范

请求示例:

curl --location --request POST 'api.ifaxin.com/lists/61633/members/save' \

--form 'address="abc@qq.com"' \

--form 'access_token="9ab3de75c0a81d57b9aa28c61cc5abe5"'

返回值说明

参数	说明
id	列表成员的id
mailListId	联系人列表的id
name	联系人列表成员的名称
address	联系人列表成员的邮箱地址
phone	联系人列表成员的联系电话
vars	联系人列表成员的变量
gmtCreated	联系人列表的创建时间
gmtModified	联系人列表的更新时间

说明：

返回的json中的data字段为返回给用户的数据，只有获取数据成功的时候data字段中才会有数据，其他情况下data字段为空

返回值示例:

{

"subMsg": "添加成功",

"statusCode": {

"code": 200,

"msg": "OK",

"states": "success"

},

"data": {

"vo": {

"id": "5961bfd5edeefb25883c7fac",

"mailListId": 11111,

"name": "ifaxin_test_2",

"address": "1111111111@qq.com",

"phone": "12345678900",

"vars": "{\"a\":1,\"b\":2}",

"gmtCreate": "2017-07-09 13:32:05",

"gmtModified": "2017-07-09 13:32:05"

}

}

}

获取联系人列表的单个成员

请求ULR

http://api.ifaxin.com/lists/{list_id}/members/get/{id}

HTTP请求方式

GET

参数说明

参数	类型	必须	说明
access_token	string	是	通过获取access_token接口获取到的access_token
list_id	string	是	联系人列表的id
id	string	是	列表成员的id

请求示例:

curl --location --request GET 'api.ifaxin.com/lists/61633/members/get/6077b57b3aa60c2e2806dfc6?access_token=9ab3de75c0a81d57b9aa28c61cc5abe5'

返回值说明

参数	说明
id	列表成员的id
mailListId	联系人列表的id
name	联系人列表成员的名称
address	联系人列表成员的邮箱地址
phone	联系人列表成员的联系电话
vars	联系人列表成员的变量
gmtCreated	联系人列表的创建时间
gmtModified	联系人列表的更新时间

说明

返回的json中的data字段为返回给用户的数据，只有获取数据成功的时候data字段中才会有数据，其他情况下data字段为空

返回值示例:

{

"subMsg": "查询成功",

"statusCode": {

"code": 200,

"msg": "OK",

"states": "success"

},

"data": {

"vo": {

"id": "5961bfd5edeefb25883c7fac",

"mailListId": 11111,

"name": "ifaxin_test_2",

"address": "11111111@qq.com",

"phone": "12345678900",

"vars": "{\"a\":1,\"b\":2}",

"gmtCreate": "2017-07-09 13:32:05",

"gmtModified": "2017-07-09 13:32:05"

}

}

}

获取单个联系人列表的所有成员

请求ULR

http://api.ifaxin.com/lists/{list_id}/members/list

HTTP请求方式

GET

参数说明

参数	类型	必须	说明
access_token	string	是	通过获取access_token接口获取到的access_token
list_id	string	是	联系人列表的id
offset	string	否	查询起始值，默认为0
limit	string	否	查询返回的个数，默认为10,最大值100

说明

当用户有多个成员的时候，查询时候需要带上offset和limit参数，含义参同Mysql的limit后跟参数含义

请求示例:

curl --location --request GET 'api.ifaxin.com/lists/61633/members/list?access_token=9ab3de75c0a81d57b9aa28c61cc5abe5'

返回值说明

参数	说明
total	联系人列表的所有成员个数
count	本次查询得到的成员的个数
id	联系人列表的成员id
mailListId	联系人列表的id
name	联系人列表成员的名称
address	联系人列表成员的邮箱地址
phone	联系人列表成员的联系电话
vars	联系人列表成员的变量
gmtCreated	联系人列表的创建时间
gmtModified	联系人列表的更新时间

说明：

返回的json中的data字段为返回给用户的数据，只有获取数据成功的时候data字段中才会有数据，其他情况下data字段为空

返回值示例:

{

"subMsg": "查询成功",

"statusCode": {

"code": 200,

"msg": "OK",

"states": "success"

},

"data": {

"total": 1500,

"count": 100,

"voList": [{

"id": "5961bfd5edeefb25883c7fac",

"mailListId": 61521,

"name": "ifaxin_test_2",

"address": "11111111@qq.com",

"phone": "12345678900",

"vars": "{\"a\":1,\"b\":2}",

"gmtCreate": "2017-07-09 13:32:05",

"gmtModified": "2017-07-09 13:32:05"

}, {

"id": "595e00b7e0c3cb2b8861e988",

"mailListId": 61521,

"name": "ifaxin_test_2",

"address": "11111112@qq.com",

"phone": "12345678901",

"vars": "{\"a\":1,\"b\":2}",

"gmtCreate": "2017-07-06 17:19:51",

"gmtModified": "2017-07-06 17:19:51"

}

...

]

}

}

更新联系人列表成员

请求ULR

http://api.ifaxin.com/lists/{list_id}/members/update/{id}

HTTP请求方式

PATCH

参数说明

参数	类型	必须	说明
access_token	string	是	通过获取access_token接口获取到的access_token
list_id	string	是	联系人列表的id
id	string	是	列表成员的id
name	string	是	联系人列表的新名称
address	string	否	邮箱地址
phone	string	否	联系电话
name	string	否	名称
vars	string	否	变量

请求示例:

curl --location --request PATCH 'api.ifaxin.com/lists/2104555/members/update/5fcda13ab263e1cd83ce424c?address=abc@qq.com&access_token=78ee5edc8f06f9659f924a649e81a5b9'

返回值说明

参数	说明
id	列表成员的id
mailListId	联系人列表的id
name	联系人列表成员的名称
address	联系人列表成员的邮箱地址
phone	联系人列表成员的联系电话
vars	联系人列表成员的变量
gmtCreated	联系人列表的创建时间
gmtModified	联系人列表的更新时间

说明

返回的json中的data字段为返回给用户的数据，只有获取数据成功的时候data字段中才会有数据，其他情况下data字段为空

返回值示例:

{

"subMsg": "更新成功",

"statusCode": {

"code": 200,

"msg": "OK",

"states": "success"

},

"data": {

"vo": {

"id": "5961bfd5edeefb25883c7fac",

"mailListId": 11111,

"name": "ifaxin-test-3",

"address": "333333333@qq.com",

"phone": "12345678905",

"vars": "{\"a\":1,\"b\":3}",

"gmtCreate": "2017-07-09 13:32:05",

"gmtModified": "2017-07-09 13:32:05"

}

}

}

删除联系人列表成员

请求ULR

http://api.ifaxin.com/lists/{list_id}/members/delete/{id}

HTTP请求方式

DELETE

参数说明

参数	类型	必须	说明
access_token	string	是	通过获取access_token接口获取到的access_token
list_id	string	是	联系人列表的id
id	string	是	列表成员的id

请求示例:

curl --location --request DELETE 'api.ifaxin.com/lists/2104555/members/delete/5fcda13ab263e1cd83ce424c?access_token=78ee5edc8f06f9659f924a649e81a5b9'

返回值说明

返回示例:

{

"subMsg": "删除成功",

"statusCode": {

"code": 200,

"msg": "OK",

"states": "success"

},

"data": null

}

删除指定联系人列表所有成员

请求ULR

http://api.ifaxin.com/lists/{list_id}/members/deleteAll

HTTP请求方式

DELETE

参数说明

参数	类型	必须	说明
access_token	string	是	通过获取access_token接口获取到的access_token
list_id	string	是	联系人列表的id

请求示例:

curl --location --request DELETE 'api.ifaxin.com/lists/2104555/members/deleteAll?access_token=78ee5edc8f06f9659f924a649e81a5b9'

返回值说明

返回示例:

{

"subMsg": "删除成功",

"statusCode": {

"code": 200,

"msg": "OK",

"states": "success"

},

"data": null

}