尘锋SCRM开放平台
  1. 联系人管理
尘锋SCRM开放平台
  • 接入前准备
    • 接口鉴权说明
    • 回调接入指南
    • 报错code码说明
    • 省市区code码
    • 获取附件URL访问签名
    • 更新日志
  • 对接方案介绍
    • 联系人架构介绍
    • 员工概览
    • ERP打通
    • 客户信息打通
    • 订单打通
    • 微信unionid互通场景
    • 获客助手对接场景
  • API文档
    • 客户
      • 联系人
        • 联系人管理
          • 查询联系人
          • 新增联系人
          • 编辑联系人
          • 删除联系人
          • 编辑联系人状态
          • 获取联系客户统计数据
          • 外部ID
            • 删除联系人外部ID
            • 更新联系人外部ID
            • 绑定外部ID与联系人ID
        • 联系人字段ID
          • 查询联系人自定义字段模板
          • 查询跟进状态列表
          • 查询联系人公海列表
          • 无效&放弃&删除原因查询
          • 联系人类型与标签和自定义字段关联关系
          • 联系人类型
          • 联系人联系方式
          • 多级联选列表
          • 来源
            • 来源列表查询(企业&联系人)
            • 编辑来源
            • 创建来源
        • 标签库
          • 给联系人打标签
          • 好友标签(企业微信标签)
            • 查询好友标签列表
            • 编辑好友标签
            • 新增好友标签
          • 联系人标签
            • 编辑联系人标签值
            • 新增联系人标签组
            • 编辑联系人标签组
            • 新增联系人标签值
            • 查询联系人标签列表
        • 跟进团队
          • 编辑(联系人/企业)共享人
          • 查询创建⼈跟进⼈和共享⼈
        • 跟进提醒
          • 查询跟进提醒
          • 新增跟进提醒
          • 编辑跟进提醒
          • 完成跟进提醒
          • 删除跟进提醒
        • 跟进记录
          • 查询跟进记录
          • 查询跟进记录模板
          • 新增跟进记录
        • 在职继承
          • 分配在职成员联系人
          • 查询接替状态
        • 签到
          • 查询签到记录
        • 行为轨迹
          • 轨迹参数说明
          • 上报轨迹事件
          • 查询轨迹事件
          • 查询旅程项目
      • 企业
        • 企业字段ID
          • 查询企业字段ID
          • 查询企业跟进状态
          • 查询企业公海列表
          • 来源列表查询(企业&联系人)
          • 查询企业类型
          • 查询企业删除原因
          • 查询多级联选
        • 企业管理
          • 查询企业列表
          • 新增企业
          • 编辑企业
          • 删除企业
          • 企业绑定联系人
          • 更新企业跟进人
          • 放弃企业到公海
          • 分配公海中企业
        • 企业标签
          • 查询企业标签
      • 好友
        • 查询好友列表
        • 编辑好友信息
        • 好友关联联系人
        • 好友取消关联联系人
        • unionId上传&关联externalUserId
      • 客户群
        • 查询客户群列表
        • 查询客户群详情
        • 编辑客户群标签
        • 查询群标签列表
        • 查询群聊数据统计-按群主聚合方式
        • 查询群聊数据统计-按自然日聚合方式
    • 销售机会
      • 销售机会管理
        • 查询销售机会列表
        • 新增销售机会
        • 编辑销售机会
        • 删除销售机会
        • 新增销售机会协同人
        • 移除销售机会协同人
        • 销售机会绑定订单
        • 销售机会解绑订单
        • 销售机会阶段变更记录
      • 销售机会字段ID
        • 查询销售机会字段ID
        • 查询销售机会类型
        • 查询销售机会阶段
        • 查询协同角色ID
        • 查询竞争对手
        • 查询丢单原因
        • 查询销售机会多级联选选项
        • 修改销售机会多级联选选项
    • 交易
      • 订单
        • 查询订单列表
        • 新增&编辑订单
        • 查询订单自定义字段ID
        • 修改订单归属人/归属部门
        • 订单发货
        • 查询物流公司列表
        • 查询订单来源
        • 编辑自主下单
      • 售后单
        • 查询售后单列表
        • 创建售后单
        • 售后单操作退款
      • 回款单
        • 查询回款单列表
        • 创建回款单
      • 会员积分
        • 查询会员列表
        • 新增会员
        • 变更会员等级
        • 查询会员等级变更明细
        • 变更会员积分
        • 变更会员成长值
        • 查询会员积分变更明细
      • 商品类
        • 查询商品列表
        • 查询商品详情
        • 新增商品
        • 商品图片/视频上传
        • 编辑商品库存
    • 员工
      • 查询员工信息
      • 编辑员工信息
      • 部门信息查询
      • 批量为员工启用系统
      • 给员工发送企微通知
    • 预约单
      • 查询预约列表
    • 评论
      • 查询评论列表接口
    • 运营
      • 活码
        • 查询活码详情
        • 查询活码列表
      • 表单
        • 查询表单字段模板
        • 查询表单填写内容
      • sop
        • 查询sop列表
        • 查询sop执行情况列表
      • 素材
        • 查询素材列表
        • 查询素材详情
        • 查询员工发送素材明细
      • 营销任务
        • 查询营销任务执行情况
        • 查询营销任务列表
      • 朋友圈
        • 获取企业发布的朋友圈员工执行情况
        • 获取朋友圈的互动数据
        • 获取企业全部发布列表
      • 获客助手短链
        • 查询获客助手来源及链接信息
        • 查询获客助手配置列表
        • 获取专属短链详情列表
        • 生成用户专属短链接
    • 会话存档
      • 上传会话存档记录
    • 通话短信
      • 查询通话记录列表
      • 电销手机外呼
      • 查询通话录音转文字结果
      • 查询短信记录列表
    • 页面嵌入
      • 页面嵌入配置说明
      • 解密嵌入页面传参
      • 菜单嵌入说明
    • 应用
      • 楼盘管理
        • 查询楼盘
        • 新增楼盘
        • 删除楼盘
      • 外联盟管理
        • 查询外联盟
        • 新增外联盟
        • 编辑外联盟
        • 删除外联盟
        • 启停用外联盟
        • 查询外联盟字段ID
        • 外联盟多级联选选项
  • 事件推送
    • 联系人
      • 新增联系人事件
      • 编辑联系人事件
      • 联系人跟进状态变更事件
      • 删除联系人事件
      • 联系人合并事件
      • 跟进提醒
        • 联系人跟进提醒状态变更
      • 联系人流转
        • 跟进团队变更事件
        • 联系人流转事件
      • 跟进记录
        • 跟进记录操作事件
    • 好友
      • 添加好友事件
      • 好友与联系人绑定事件
      • 好友与联系人解绑事件
      • 好友主动删除员工事件
      • 员工主动删除好友事件
      • 更新好友信息事件
    • 客户群
      • 新增客户群事件
      • 变更客户群事件
      • 解散客户群事件
    • 销售机会
      • 销售机会负责人变更
      • 销售机会协同人变更
      • 销售机会操作事件
    • 企业
      • 企业跟进团队流转事件
      • 企业新增事件
      • 编辑企业事件
      • 企业跟进状态变更事件
      • 企业删除事件
    • 交易
      • 推送说明
      • 订单
        • 新增订单事件
        • 编辑订单事件
        • 订单状态变更事件
        • 订单支付完成事件
        • 删除订单事件
      • 售后单
        • 售后单创建事件
        • 编辑售后单事件
        • 售后单状态变更事件
        • 删除售后单事件
        • 售后单退款成功事件
      • 商品
        • 新增商品事件
        • 商品库存变更事件
        • 编辑商品事件
        • 商品状态变更事件
      • 会员积分
        • 新增会员事件
        • 会员合并事件
        • 成长值变更事件
        • 会员等级变更事件
        • 会员积分变更事件
    • 工单
      • 新增工单事件
      • 流转工单事件
      • 编辑工单事件
    • 运营
      • 提交表单事件
    • 通话短信
      • 通话记录操作事件
      • 短信记录操作事件
    • 预约单
      • 新增预约单事件
    • 应用
      • 楼盘
        • 新增楼盘事件
        • 编辑楼盘事件
        • 删除楼盘事件
      • 外联盟
        • 新增外联盟事件
        • 编辑外联盟事件
        • 删除外联盟事件
        • 启/停外联盟事件
        • 外联盟审批完成事件
  1. 联系人管理

查询联系人

根据员工和联系人创建时间查询联系人资料
POST https://qw-openapi-tx.dustess.com/customer/v1/getCustomerList?accessToken=

Content-Type: application/json
接口限制:每分钟调用600次;单次最大限制500;
通过本接口查询的联系人数据与页面查询到的一致,本接口包含了存在于公海和员工名下的联系人数据。如对比数据量不一致,请检查查询条件是否正确
本接口不会返回存在于回收站的联系人数据
如需获取全量数据,推荐通过联系人的创建时间(时间范围请求参数为start、end)逐月拉取,当查询的数据超过500条时,可以使用当前页第500个联系人的cf_ts字段值进行翻页查询(详情查看参数列表说明)
cf_ts字段分页问题:分页使用cf_ts字段实现,具体是:获取第一页数据之后,用第一页的最后一条数据的cf_ts字段作为参数,比如:获取一个时间段的数据,单页数量为10,获取第二页的数据,cf_ts参数以第一页数据的最后一条数据的cf_ts字段作为参数,即获取大于当前cf_ts值的10条数据也就是第二页;
注意:当以下参数之一传入时,其他参数条件将失效,参数优先级:cids > external_ids > qw_external_userids > union_ids > mobiles > 其他参数,例:当参数cids和external_ids同时传参,只会以cids进行查询,external_ids等其他参数条件将被舍弃;
请求参数
请求参数名类型说明是否必须
cidsString[]尘锋联系人id,超过500个默认只返回500个false
external_idsString[]联系人所关联的外部系统ID ,超过500个默认只返回500个false
uidString员工的id(可筛选当前员工的联系人,查出的联系人当前员工为主跟进人或共享人)false
typeString联系人类型 "external":外部联系人,"ordinary":普通联系人(原联系人线索),"all":全部false
startInt64查询起始时间(时间戳,单位秒,指联系人的创建时间,未传时间区间默认查询最近一周,时间区间最长31天)false
endInt64查询结束时间(时间戳,单位秒,指联系人的创建时间,未传时间区间默认查询最近一周,时间区间最长31天)false
cf_tsInt分页标记,每个联系人都有唯一的cf_ts值,通过本字段实现翻页查询,传入后将会返回大于此值的数据,如不传值,默认为0,表示从头开始遍历查询。false
mobilesString[]联系方式列表(包含自定义联系方式座机、微信等均可通过此字段查询) ,超过500个默认只返回500个false
union_idsString[]unionid列表 ,超过500个默认只返回500个false
page_sizeInt分页尺码(最大值500,若没传或是0默认500)false
start_update_timeInt通过联系人更新时间查询的起始时间(时间戳,单位秒,指联系人的更新时间,未传时间区间不做查询,时间区间最长31天)false
end_update_timeInt通过联系人更新时间查询的结束时间(时间戳,单位秒,指联系人的更新时间,未传时间区间不做查询,时间区间最⻓31天)false
qw_external_useridsString[]联系人所关联的企微好友(外部联系人ID)false
请求参数示例
json - Request-Example:
{
  "uid": "11",
  "start": 1500084074,
  "end": 1600084074,
  "cf_ts": 100000000,
  "page_size": 100,
  "type":"external",
  "start_update_time": 1500084074,
  "end_update_time": 1600084074,
  "qw_external_userids": ["user1", "user2"]
}
成功响应
响应参数名类型说明
successBool请求状态,true:成功,false:失败_Allowed values: true,false_
codeInt响应代码
msgString消息提示
dataObject[]数据信息
data.idString联系人id
data.nameString企微昵称
data.corp_nameString企业简称
data.corp_full_nameString企业全称
data.mobilesObject[]联系方式(联系人去重核心字段)
data.mobiles.telString联系方式具体内容,如:type=mobile,则值为手机号码
data.mobiles.typeStringmobile(手机号),landline(座机),other(其他),11b90rp60zya(自定义联系方式,如:微信号)
data.mobiles.displayString联系方式名称
data.positionString职位
data.sourceCodeString来源id 来源列表查询(企业&联系人)
data.prov_cityString省市区(县)
data.addressString地址
data.birthdayString生日
data.emailStringemail
data.genderInt性别 0-未知 1-男性 2-女性
data.custom_fieldsObject[]自定义字段查询字段模版
data.custom_fields.idString字段id
data.custom_fields.array_valueString[]字段类型为:checkbox(多项选择),cascader(多级联选单选),multiCascader(多级联选多选)时使用此字段
data.custom_fields.float_valueInt字段类型为:number(数字)时使用此字段
data.custom_fields.typeString字段类型
data.custom_fields.string_valueString字段类型为:radio(单选),date(日期),datetime(日期时间),text(单行文本),textarea(多行文本)时使用此字段
data.custom_fields.files_valueObject[]字段类型为:附件列表 时使用此字段, 最大文件个数5个
data.custom_fields.files_value.nameString文件名称, 使用附件类型必填
data.custom_fields.files_value.urlString文件链接, 使用附件类型必填 获取附件URL访问签名
data.custom_fields.files_value.file_typeString文件type
data.external_useridString外部联系人的userid
data.avatarString外部联系人头像
data.typeInt1表示该外部联系人是微信用户,2表示该外部联系人是企业微信用户,3表示该联系人为普通联系人
data.unionidString外部联系人在微信开放平台的唯一身份标识
data.qwcreatetimeInt企微添加此外部联系人的时间
data.uidsString[]跟进员工id集合查询员工信息
data.ownerString主跟进员工id
data.share_uidsString[]共享员工id集合
data.remarkString联系人名称
data.descriptionString描述
data.tagsString[]好友标签id集合查询好友标签列表
data.remark_corp_nameString企业名称
data.statusString联系人状态id 查询跟进状态列表
data.reasonString无效原因id 无效&放弃&删除原因查询
data.priceInt销售机会金额
data.poolString公海id 查询联系人公海列表
data.corp_idString企业id 查询企业列表
data.updatetimeInt更新时间
data.gettimeInt获取时间
data.add_timeInt添加时间
data.add_wayInt[]添加来源
data.updateuserString更新员工id
data.update_qw_user_idString更新人的企微userId
data.createuserString创建人id
data.is_delBool是否删除
data.fromInt1111表示微信线索,2222表示联系人线索
data.mergetimeInt合并联系人的时间
data.ageInt年龄
data.nationalString民族
data.nationalityString国籍
data.educationString教育
data.majorString专业
data.id_cardString身份证
data.wxString微信
data.qqStringQQ
data.mkScoreInt营销评分,如返回值为1500,实际分值为15
data.intentionDegreeScoreInt意向分,如返回值为1500,实际分值为15
data.biz_tagsString[]联系人标签id集合查询联系人标签列表
data.have_sale_chanceBool联系人拥有销售机会
data.duplicateBool是否存在与之重复的联系人
data.categoryIdString联系人类型id
data.provinceInt省
data.cityInt市
data.districtInt县
data.external_idString联系人所关联的外部系统ID
data.follow_userObject[]员工添加外部联系人记录
data.follow_user.uidString员工id
data.follow_user.external_useridString联系人所关联的企微好友(外部联系人ID)
data.follow_user.createtimeInt联系人资料创建时间
data.follow_user.qw_create_timeInt企微好友添加时间
data.follow_user.add_wayInt添加来源
data.follow_user.is_deletedBool是否删除
data.rule_tagsString[]规则标签id集合
data.first_add_friend_timeInt首次添加好友时间(秒级时间戳)
从 2022年12月01日前开户的客户,来源会在‘source’字段中返回
add_way表示添加联系人的来源,有固定的值,而state表示此联系人的渠道,可以由企业进行自定义的配置,请注意二者的不同。
参考:企微来源定义
值含义
0未知来源
1扫描二维码
2搜索手机号
3名片分享
4群聊
5手机通讯录
6微信联系人
7来自微信的添加好友申请
8安装第三方应用时自动添加的客服人员
9搜索邮箱
201内部成员共享
202管理员/负责人分配
成功响应示例
{
    "success": true,
    "msg": "",
    "data": [{
        "MKScoreDetail": [{
            "tagScore": 9,
            "tid": "d1b78d16-dd2e-11ea-a9ec-11111112"
        }],
        "add_time": 1600154045,
        "add_way": [
            1
        ],
        "address": "",
        "age": 0,
        "avatar": "http://wx.qlogo.cn/mmhead/test/0",
        "birthday": "",
        "birthdayDay": 0,
        "birthdayMonth": 0,
        "birthdayMonthAndDay": "",
        "birthdayYear": 0,
        "biz_tags": [

        ],
        "categoryId": "00000000-0000-0000-0000-000000000000",
        "cf_ts": 1019989493388034000,
        "city": 0,
        "contact_time": 0,
        "corp_full_name": "",
        "corp_id": "",
        "corp_name": "",
        "create_clueTime": 0,
        "createtime": 1600154045,
        "createuser": "13",
        "custom_fields": null,
        "description": "",
        "district": 0,
        "duplicate": false,
        "dynamic_time": 0,
        "education": "",
        "email": "",
        "external_userid": "wmMXXWDQAAgTH4QinMwEpqZAFQX_1111",
        "from": 0,
        "gender": 1,
        "gettime": 1600154045,
        "have_sale_chance": false,
        "id": "0a4f8601-f723-11ea-8f15-1111111",
        "id_card": "",
        "is_del": false,
        "log_time": 0,
        "log_type": "",
        "major": "",
        "mergetime": 0,
        "mkScore": 9,
        "mobiles": [{
                "tel": "12500010002",
                "type": "mobile",
                "display": "手机号"
            },
            {
                "tel": "ead12312acxzcasd",
                "type": "11b90rp60zya",
                "display": "微信号"
            }
        ],
        "name": "Air",
        "national": "",
        "nationality": "",
        "owner": "13",
        "pool": "",
        "pool_dynamic": "",
        "position": "",
        "price": 0,
        "prov_city": "",
        "province": 0,
        "qq": "",
        "qwcreatetime": 1600154042,
        "reason": "",
        "recovery_time": "",
        "remark": "Air",
        "remark_corp_name": "",
        "remind_time": "",
        "sourceCode": "01i",
        "status": "uuid0",
        "tags": [

        ],
        "rule_tags": [],
        "type": 1,
        "uids": [
            "13"
        ],
        "unionid": "owx_AwDYE_Y3aq7twzt1111111",
        "updatetime": 1600154042,
        "updateuser": "",
        "wx": "",
        "wx_clue_tags": [
            "d1b78d16-dd2e-11ea-a9ec-1111111"
        ],
        "follow_user": [{
            "uid": "2",
            "external_userid": "woDolHEAAA6rJmSXoNB11111111111",
            "createtime": 1590579533,
            "add_way": 0,
            "is_deleted": false
        }]
    }]
}
错误响应示例
 {
    "success":false,
    "code": 10001,
    "msg": "system unknown error",
    "data": null
}
上一页
获客助手对接场景
下一页
新增联系人
Built with