====JSON格式==== ^名称 ^类型 ^只读 ^必填 ^注释^ |cId |int | 是 | 否 |联系人ID,系统自动生成 | |name |varchar | 否 | 否 |姓名 | |mobile |varchar | 否 | 是 |手机号码 | |fixnumber|varchar | 否 | 否 |座机号码 | |position |varchar | 否 | 否 |职位 | |QQ |varchar | 否 | 否 |QQ号码 | |note |varchar | 否 | 否 |联系人备注 | |companyId|int | 是 | 否 |联系人所属公司ID,系统自动生成 | |supportId|int | 是 | 否 |负责该联系人的客服ID,系统自动生成 | |createDT |date | 是 | 否 |创建时间 | |updateDT|date | 是 | 否 |更新时间 | |custom_fields|array | 否 | 否 |联系人自定义字段 | ====JSON示例==== { "cId": 1, "name": "张三", "mobile ": "13240138429", "fixnumber": "010-63701717", "position": "项目经理", "QQ": "601100987", "note": "这里是联系人的备注", "companyId": 123, "supportId": 3, "createDT": "2017-09-12 10:12:22", "updateDT": "2017-09-12 10:12:22", "custom_fields": [ { "key": "field_1", "value": "4334" }, { "key": "field_3", "value": "1" //复选框 }, { "key": "field_2", "value": "下拉菜单的某一项" } ] } ====获取联系人列表==== GET /api/v1/users.json **查询参数** ^名称 ^必需的 ^类型 ^注释 ^ |created_start |否 |string |按创建时间筛选,开始时间,格式为:2017-8-27| |created_end |否 |string |按创建时间筛选,结束时间,格式为:2017-8-29| |updated_start |否 |string |按更新时间筛选,开始时间,格式为:2017-8-27| |updated_end |否 |string |按更新时间筛选,结束时间,格式为:2017-8-29| |created_order |否 |string |按创建时间排序,取值为:asc-升序,desc-降序| |updated_order |否 |string |按更新时间排序,取值为:asc-升序,desc-降序| |page |否 |int |分页获取,默认为1| |per_page |否 |int |每页大小,默认为100| **调用者权限** 所有客服 也可以使用下面的接口 /*查看服务商下某个客户的联系人*/ GET /api/v1/companys/{company_id}/users.json **调用示例** curl https://www.bangwo8.com/api/v1/users.json \ -v -u {account}:{password} **返回值示例** Status: 200 OK { "users": [ { "cId": 1, "name": "张三", ... }, { "cId": 2, "name": "李四", ... } ] } ====查看指定联系人信息==== GET /api/v1/users/{id}.json **调用者权限** 所有客服 **调用示例** curl https://www.bangwo8.com/api/v1/users/{id}.json \ -v -u {account}:{password} **返回值示例** Status: 200 OK { "user": { "cId": 1, "name": "张三", ... } } ====获取多个联系人信息==== GET /api/v1/users/show_many.json?ids={ids} **调用者权限** 所有客服 **调用示例** curl https://www.bangwo8.com/api/v1/show_many.json?ids=1,2,3 \ -v -u {account}:{password} **返回值示例** Status: 200 OK { "users": [ { "cId": 1, "name": "张三", ... }, { "cId": 2, "name": "李四", ... } ] } ====创建联系人==== POST /api/v1/users.json **调用者权限** 所有客服 **调用示例** curl -v -u {account}:{password} https://www.bangwo8.com/api/v1/users.json \ -H "Content-Type: application/json" -X POST -d '{"user": {"name": "张三", \ -"mobile": "13240139998", "fixnumber": "010-63701717"}}' //说明:目前只能通过mobile属性来创建联系人。也就是说,创建联系人时,mobile必须有值。// **返回值示例** Status: 201 Created Location: https://www.bangwo8.com/api/v1/users/{id}.json { "user": { "cId": 11, "name": "张三", ... } }