1.1 接口说明

第三方系统调用此接口查询客户信息。

1.2 调用形式

https://ykf.uincall.com/openapi/customer/query?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=12dc1a0e50628c37ec58ef1e4f7xxxxx

1.3 调用方式

POST

1.4 传入参数

非必填参数，调用接口时请传递参数名，参数值可为空

序号 名称 类型 是否必填 说明
1 id String 否 客户Id
2 agent_num String 是 当前操作座席编号
3 page Int 是 页码（int类型的正整数）
4 size Int 是 每页数量（int类型的正整数，最大50）
5 status Int 是 客户类型（0 公海 1 已分配 2无归属 3外呼任务 9全部）
6 sea_title String 否 公海来源
7 level_title String 否 客户状态
8 truename String 否 客户名称 （最大值100）
9 mobile String 否 客户电话 （最大值20）
10 is_plan Boolean 否 是否关联联系计划 false 不关联 true 关联
11 source_title String 否 数据来源
12 province String 否 省 （最大值20）
13 city String 否 市 （最大值20）
14 district String 否 区 （最大值20）
15 updateStart String 否 更新开始时间
16 updateEnd String 否 更新结束时间
17 start String 否 创建开始时间
18 end String 否 创建结束时间
19 website String 否 网站 （最大值100）
20 wechat String 否 微信 （最大值20）
21 mail String 否 邮箱 （最大值100）
22 nickname String 否 昵称信息 （最大值20）
23 address String 否 地址 （最大值100）
24 tracker_id String 否 关联访客ID （最大值130）
25 summary String 否 备注 （最大值200）

1.5 回应参数

序号 名称 类型 是否必填 说明
1 errcode Number 是 状态码：0成功，及其他非0错误码，详见错误码列表
2 errmsg String 是 状态说明
3 data Object对象 是 结果集（有数据时返回最新10条数据）
3.1 total Int 是 总个数
3.2 size Int 是 每页条数
3.3 current Int 是 当前页码
3.4 pages Int 是 总页数
3.5 records Int 是 结果集（有数据则返回结果集；无则为空）
3.5.1 id String 是 客户Id
3.5.2 truename String 是 客户名称
3.5.3 mobile String 是 手机
3.5.4 province String 是 省
3.5.5 city String 是 市
3.5.6 district String 是 区
3.5.7 nickname String 是 客户昵称
3.5.8 summary String 是 备注
3.5.9 level_name String 是 客户状态
3.5.10 color String 是 客户状态颜色值
3.5.11 source_name String 是 数据来源
3.5.12 agent_name String 是 归属座席
3.5.13 agent_num String 是 归属座席编号
3.5.14 address String 是 地址
3.5.15 wechat String 是 微信
3.5.16 mail String 是 邮箱

1.6 使用样例

调用：

url：https://ykf.uincall.com/openapi/customer/query?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=12dc1a0e50628c37ec58ef1e4f7xxxxx

    POST数据：
{
    "id":"",
    "agent_num":"1006",
    "page":1,
    "size":50,
    "status":1,
    "sea_title":"",
    "level_title":"",
    "truename":"1231test666After",
    "mobile":"19896686665",
    "is_plan":false,
    "source_title":"",
    "province":"",
    "city":"",
    "district":"",
    "updateStart":"",
    "updateEnd":"",
    "start":"",
    "end":"",
    "website":"",
    "wechat":"",
    "mail":"",
    "nickname":"",
    "address":"",
    "tracker_id":"",
    "summary":""
}

响应：

{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "total": 1,
        "size": 50,
        "current": 1,
        "pages": 0,
        "records": [
            {
                "id": "f3ea9c0a345444446a11f2b0a06d6fce",
                "truename": "1231test666After",
                "mobile": "19896686665",
                "province": "434",
                "city": "嘎嘎嘎",
                "district": "342323",
                "nickname": "1231test666After",
                "summary": "beizhu",
                "level_name": "",
                "source_name": "",
                "agent_name": "1006",
                "agent_num": "1006",
                "address": "123号街区",
                "wechat": "789",
                "mail": "11@11.com"
            }
        ]
    }
}
文档更新时间: 2024-03-25 15:20   作者：admin