微伴助手OpenAPI
  1. 客户管理
微伴助手OpenAPI
  • OpenAPI基本介绍
  • 错误码参考表
  • 访问频率和并发限制
  • 消息订阅
    • 订阅消息加解密指南
    • 回调应用配置指南
    • 工单变更消息
      • 工单变更消息回调
      • 创建工单回调
      • 流转工单回调
      • 关闭工单回调
      • 重新打开工单回调
      • 评论工单回调
  • 获取访问凭据
    • 获取访问凭据
      POST
  • 员工管理
    • 获取员工列表
      GET
    • 获取员工详情
      GET
    • 发送员工通知
      POST
  • 自定义订单管理
    • 订单信息删除
    • 获取订单信息列表
    • 批量同步店铺信息
    • 批量同步商品信息
    • 批量同步订单信息v2
    • 批量删除商品信息
    • 删除店铺信息
    • 批量删除订单信息
    • 获取店铺信息详情
    • 获取店铺信息列表
    • 获取商品信息详情
    • 获取商品信息列表
  • 客户管理
    • 获取客户列表
      GET
    • 根据更新时间获取客户列表
      GET
    • 获取客户详情
      GET
    • 获取流失提醒客户列表
      GET
    • 导入客户信息
      POST
    • 添加客户评分
      POST
    • 添加自定义字段
      POST
    • 批量预设客户属性
      POST
    • 批量修改自定义字段的值
      POST
    • 创建批量加好友任务(批量创建添加客户任务)
      POST
    • 批量unionid&openid换external_user_id
      POST
    • external_user_id换unionid
      POST
    • unionid&openid换客户id
      POST
    • 获取客户自定义字段值列表
      GET
    • 批量获取客户详情
      POST
    • 获取批量加好友待添加列表
      GET
  • 客户积分管理
    • 批量增减客户积分
    • 批量获取客户积分
    • 获取单个客户积分明细记录
    • 获取全部客户积分明细记录
  • 客户标签管理
    • 获取标签列表
    • 批量更新客户企业标签
    • 给客户添加企业标签
    • 删除客户的企业标签
    • 给客户添加微伴个人标签
    • 删除客户的微伴个人标签
    • 获取预打标签信息
    • 批量预打企业标签
    • 根据手机号删除预打标签任务
    • 根据unionid删除预打标签任务
    • 获取指定用户预打标签任务详情
    • 获取预打标签任务列表
    • 添加预打标签任务
  • 客户画像管理
    • 获取客户事件列表
    • 创建自定义客户事件
    • 获取自定义客户事件类型列表
    • 获取自定义客户事件类型详情
    • 添加自定义客户事件类型
    • 删除自定义客户事件类型
    • 更新自定义客户事件类型
    • 获取客户阶段状态
  • 标签库管理
    • 获取标签列表V2
    • 获取指定标签信息
    • 新增企业标签组
    • 新增企业标签
    • 删除企业标签
    • 更新企业标签
    • 同步企业微信标签
  • 群聊管理
    • 获取群聊列表
    • 获取群聊成员列表
    • 获取客户所在群聊
    • 查看客户是否在群聊中
    • 获取群聊详情
  • 工单管理
    • 工单模块OpenAPI开发必读
    • 获取工单列表
    • 获取工单详情
    • 获取工单流内处理人
    • 获取工单模板列表
    • 获取工单模板详情
    • 新建工单
    • 修改工单
    • 流转工单
    • 评论工单
    • 关闭工单
  • 销售过程管理
    • 获取商机列表
    • 获取商机详情
    • 修改商机阶段
    • 获取线索公海列表
    • 批量导入线索
    • 修改线索
    • 获取线索列表
    • 员工单条/批量领取线索
    • 获取线索客户列表
  • 聊天记录管理
    • 获取会话消息
    • 获取会话消息2(按照消息时间逆序)
    • 获取员工会话
  • 拉新排行榜
    • 获取拉新排行榜列表
  • 群裂变
    • 获取群裂变活动列表
    • 获取群裂变任务详情
    • 获取群裂变客户详情列表
  • 群打卡
    • 获取群打卡活动列表
    • 获取群打卡任务详情
  • 企微任务宝
    • 获取企微任务宝活动列表
    • 获取企微任务宝任务详情
    • 获取企微任务宝对应的客户数据列表
    • 获取客户对应的企微任务宝数据列表
  • 拉新排行榜
    • 获取拉新排行榜活动列表
  • 自定义表单
    • 获取自定义表单列表
    • 自定义表单用户与表单关系列表
    • 自定义表单提交数据详情列表
    • 获取自定义表单分组列表
  • 客户转化
    • 批量新增手机线索转化
  • 员工个人群发记录管理
    • 获取员工个人群发记录列表
    • 获取员工个人群发记录结果列表
  • 渠道码管理
    • 获取渠道码列表
    • 获取渠道码加人数据
  • 素材库管理
    • 获取素材库列表
    • 获取素材库标签列表
    • 新增素材
    • 更新素材
    • 删除素材
    • 新建素材分组
    • 修改素材分组
    • 添加素材库标签
    • 删除素材库标签
    • 删除素材分组
    • 素材分组列表
  • 互动雷达管理
    • 获取雷达列表
    • 获取雷达详情
    • 添加雷达
    • 修改雷达
    • 删除雷达
    • 上传file
    • 获取雷达分组列表
    • 获取雷达客户访问记录
  • 自定义侧边栏身份校验
    • 侧边栏模块化-自定义卡片功能说明
    • 自定义侧边栏Code校验
  • 有赞订单管理
    • 获取有赞订单
    • 获取有赞订单列表
  • 小鹅通订单管理
    • 获取小鹅通TOKEN
  • 项目管理
    • 项目列表
  • 门店信息
    • 批量导入门店
    • 批量更新门店
    • 门店列表
  • 人群包
    • 人群包列表获取
    • 创建人群包
    • 更新人群包
    • 创建的人群包中添加数据
    • 获取人群包数据详情
  • 客户群发
    • 客户群发创建
    • 群发任务列表
    • 群群发详情获取
    • 员工群发结果
    • 客户群群发创建
    • 员工-群群发结果
    • 获取群发错误unionid/extid
  • 企微朋友圈
    • 企微朋友圈创建
    • 企微朋友圈任务列表
    • 企微朋友圈任务发表详情
  • 个人SOP
    • 个人SOP列表
    • 个人SOP详情-规则列表
    • 个人SOP详情-执行记录
  • 部门管理
    • 获取部门列表
  • 群标签管理
    • 获取群聊标签分组及其子列表
    • 群聊批量打标签
  • 话术库
    • 企业话术分组列表
    • 企业话术列表
  • 企微数据专区
    • 获取会话消息(企微数据专区)
  1. 客户管理

获取客户列表

GET
/open-api/external_user/list
openapi
获取客户列表。可以通过调整 query 参数满足不同维度的筛选需求。 列表可根据时间进行筛选。调用此接口需购买基础席位。
错误码说明
20201staff_id 错误,找不到对应员工
20202type 不合法
20202order 不合法

请求参数

Query 参数
staff_id
string 
可选
企业微信员工id。若填写则只会返回该员工对应的客户(被员工删除的客户不展示)
示例值:
zhangsan
type_
string 
可选
客户类型。1为微信客户,2为企业微信客户。若填写则只返回对应类型的客户
示例值:
1
phone_number
string 
可选
客户手机号。若填写则只会返回该手机号对应的客户
示例值:
13322665599
order
string 
可选
排序按照微伴系统收录时间升序或降序增加排序参数 order,可选值是 asc(升序) 和 desc(降序),默认值是 asc
示例值:
asc
start_time
string 
可选
时间筛选开始时间,时间戳格式,例如:1592576435对应2020-06-19 22:20:35
示例值:
1592576435
end_time
string 
可选
时间筛选结束时间,时间戳格式,例如:1592576435对应2020-06-19 22:20:35
示例值:
1592576435
limit
string 
可选
列表返回长度。默认值为30,最大值为100
示例值:
30
offset
string 
可选
列表偏移。用于迭代获取所有数据,默认值为0
示例值:
0
custom_field_filter
string 
可选
自定义字段筛选。query_name:字段名称;query_type:查询类型,目前仅支持:等于: equal, 为空: is_null, 不为空: not_null, 大于: gt, 小于: lt;query_value: 查询值。特殊说明,仅数值和时间字段支持gt、lt查询,选项类型字段仅支持equal查询,多选字段查询时字段值使用英文;拼接。
示例值:
{"query_name":"多选1","query_type":"equal","query_value":"2;4"}
access_token
string 
调用接口凭证
必需
默认值:
{{access_token}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://open.weibanzhushou.com/open-api/external_user/list?staff_id=zhangsan&type_=1&phone_number=13322665599&order=asc&start_time=1592576435&end_time=1592576435&limit=30&offset=0&custom_field_filter={"query_name":"多选1","query_type":"equal","query_value":"2;4"}&access_token='

返回响应

🟢200成功
application/json
Body
errcode
integer 
必需
状态码,0为正常,非0代表错误。业务错误码下述,全局错误码见 全局错误码
errmsg
string 
必需
错误信息,成功时为'ok',错误时会以中文方式显示错误原因
total
integer 
session总量
必需
external_user_list
array [object {15}] 
客户列表
必需
id
string 
外部联系人客户ID
必需
type
integer 
外部联系人的类型,1表示该外部联系人是微信用户,2表示该外部联系人是企业微信用户
必需
unionid
string 
仅当联系人类型是微信用户,且企业绑定了微信开发者ID有此字段
必需
created_at
integer 
数据创建时间(微伴系统内时间)
必需
name
string 
外部联系人昵称
必需
avatar
string 
外部联系人头像
必需
corp_full_name
string 
外部联系人所在企业的主体名称,仅当联系人类型是企业微信用户时有此字段
必需
corp_name
string 
外部联系人所在企业的简称,仅当联系人类型是企业微信用户时有此字段
必需
gender
integer 
外部联系人性别 0-未知 1-男性 2-女性
必需
position
string 
外部联系人的职位,如果外部企业或用户选择隐藏职位,则不返回,仅当联系人类型是企业微信用户时有此字段
必需
organization_correlation_time
integer 
关联企业的时间
必需
organization_id
integer 
关联企业ID
必需
score
integer 
用户评分
必需
tyc_id
integer 
关联企业天眼查ID
必需
external_profile
object 
外部联系人的自定义展示信息,可以有多个字段和多种类型,包括文本,网页和小程序,仅当联系人类型是企业微信用户时/有此字段,字段详情见企业微信对应文档
必需
示例
{
  "errcode": 0,
  "errmsg": "string",
  "total": 0,
  "external_user_list": [
    {
      "id": "string",
      "type": 0,
      "unionid": "string",
      "created_at": 0,
      "name": "string",
      "avatar": "string",
      "corp_full_name": "string",
      "corp_name": "string",
      "gender": 0,
      "position": "string",
      "organization_correlation_time": 0,
      "organization_id": 0,
      "score": 0,
      "tyc_id": 0,
      "external_profile": {}
    }
  ]
}
🟢200正常返回
上一页
获取商品信息列表
下一页
根据更新时间获取客户列表
Built with