联系人列表

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

新建联系人列表#

请求ULR#

http://api.ifaxin.com/lists/save

HTTP请求方式#

POST

参数说明#

参数	类型	必须	说明
access_token	string	是	通过获取access_token接口获取到的access_token
name	string	是	联系人列表的名称
description	string	否	联系人列表的描述

请求示例:

curl --location --request POST 'api.ifaxin.com/lists/save' \
--form 'name="test2111"' \
--form 'access_token="86d69becda397f77804d71fd44482057"'

返回值说明#

参数	说明
id	联系人列表的id
name	联系人列表的名称
customField	联系人列表的自定义字段
description	联系人列表的描述
gmtCreated	联系人列表的创建时间
gmtModified	联系人列表的更新时间

说明：

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

返回值示例:

{
    "subMsg": "保存成功",
    "statusCode": {
        "code": 200,
        "msg": "OK",
        "states": "success"
    },
    "data": {
        "vo": {
            "id": 111111,
            "name": "sendcloud",
            "customField": null,
            "description": "hello",
            "gmtCreated": "2017-07-09 12:29:37",
            "gmtModified": "2017-07-09 12:29:37"
        }
    }
}

获取单个联系人列表#

请求ULR#

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

HTTP请求方式#

GET

参数说明#

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

请求示例:

curl --location --request GET 'api.ifaxin.com/lists/get/61635?access_token=9ab3de75c0a81d57b9aa28c61cc5abe5'

返回值说明#

参数	说明
id	联系人列表的id
name	联系人列表的名称
customField	联系人列表的自定义字段
description	联系人列表的描述
gmtCreated	联系人列表的创建时间
gmtModified	联系人列表的更新时间

说明

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

返回值示例:

{
    "subMsg": "查询成功",
    "statusCode": {
        "code": 200,
        "msg": "OK",
        "states": "success"
    },
    "data": {
        "vo": {
            "id": 111111,
            "name": "sendcloud",
            "customField": null,
            "description": "hello",
            "gmtCreated": "2017-07-09 12:29:37",
            "gmtModified": "2017-07-09 12:29:37"
        }
    }
}

获取所有联系人列表#

请求ULR#

http://api.ifaxin.com/lists/list

HTTP请求方式#

GET

参数说明#

参数	类型	必须	说明
access_token	string	是	通过获取access_token接口获取到的access_token
offset	string	否	查询起始值，默认为0
limit	string	否	查询返回的个数，默认为10

说明:

当用户有多个联系人列表时候，查询时候需要带上offset和limit参数，含义参同Mysql的limit后跟参数含义

请求示例:

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

返回值说明#

参数	说明
total	用户所有联系人列表的个数
count	本次查询得到的联系人列表的个数
id	联系人列表的id
name	联系人列表的名称
customField	联系人列表的自定义字段
description	联系人列表的描述
gmtCreated	联系人列表的创建时间
gmtModified	联系人列表的更新时间

返回值示例:

{
    "subMsg": "查询成功",
    "statusCode": {
        "code": 200,
        "msg": "OK",
        "states": "success"
    },
    "data": {
        "total": 15,
        "count": 10,
        "voList": [{
                "id": 60865,
                "name": "生物地址",
                "customField": "",
                "description": null,
                "gmtCreated": "2016-11-07 14:45:21",
                "gmtModified": "2017-05-13 16:41:14"
            }, {
                "id": 61046,
                "name": "测试1",
                "customField": "",
                "description": null,
                "gmtCreated": "2016-11-21 17:47:07",
                "gmtModified": "2017-05-08 10:40:42"
            }
            ...
        ]
    }
}

更新联系人列表#

请求ULR#

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

HTTP请求方式#

PATCH

参数说明#

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

请求示例:

curl --location --request PATCH 'api.ifaxin.com/lists/update/2244424' \
--form 'name="test2222"' \
--form 'access_token="9ab3de75c0a81d57b9aa28c61cc5abe5"'

返回值说明#

参数	说明
id	联系人列表的id
name	联系人列表的名称
customField	联系人列表的自定义字段
description	联系人列表的描述
gmtCreated	联系人列表的创建时间
gmtModified	联系人列表的更新时间

说明：

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

返回值示例:

{
    "subMsg": "更新成功",
    "statusCode": {
        "code": 200,
        "msg": "OK",
        "states": "success"
    },
    "data": {
        "vo": {
            "id": 111111,
            "name": "ifaxin",
            "customField": null,
            "description": "hello",
            "gmtCreated": "2017-07-09 12:29:37",
            "gmtModified": "2017-07-09 12:29:37"
        }
    }
}

删除联系人列表和成员#

请求ULR#

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

HTTP请求方式#

DELETE

参数说明#

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

请求示例:

curl --location --request DELETE 'api.ifaxin.com/lists/delete/61633/confirm' \
--form 'access_token="9ab3de75c0a81d57b9aa28c61cc5abe5"'

返回值说明#

返回示例:

{
    "subMsg": "删除联系人列表和对应的成员成功",
    "statusCode": {
        "code": 200,
        "msg": "OK",
        "states": "success"
    },
    "data": null
}