微伴助手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. 客户管理

导入客户信息

POST
/open-api/external_user/import_info
openapi
通过客户 id 或客户 unionid,导入同步客户的信息,对系统中未存在的自定义字段报错处理,可调用添加自定义字段接口,对于已存在的客户信息字段请按照下文给予的字段进行传输导入。调用此接口需购买基础席位。
错误码说明
20210客户external_user_id错误
20211客户unionid错误
20212请提供客户external_user_id或客户external_user_unionid
20213员工与客户无关联
20214external_user_fields格式有误
20215自定义字段不存在
20216该值内容长度超过500, 请重新修改
20217下拉框的选项值不存在
21801最多允许批量修改10个自定义字段
21802参数option_id,field_value,field_datetime不能同时为空
21803存在无效的员工或外部联系人
21804存在无效的field_id
21805存在无效的option_id
21806存在外部联系人和员工没有好友关系
21807存在字段类型和传入的参数不正确
21808时间格式不正确
21809缺少参数
21810自定义信息更新失败,请重试
21811field_id为${field_id}的自定义字段不存在

请求参数

Query 参数
access_token
string 
调用接口凭证
必需
默认值:
{{access_token}}
Body 参数application/json
staff_id
string 
客服员工id
必需
external_user_id
string 
可选
客户id。external_user_id 和 external_user_unionid 必须选择一个填写
external_user_unionid
string 
可选
客户unionid。external_user_id 和 external_user_unionid 必须选择一个填写
external_user_openid
string 
可选
客户openid。密文企业选择 external_user_unionid 时需填写
phone_number
string 
客户手机号
可选
age
string 
客户年龄
可选
email
string 
客户邮箱
可选
birthday
string 
客户生日
可选
weibo
string 
客户微博
可选
qq
string 
客户qq
可选
address
string 
客户地址
可选
description
string 
客户描述
可选
state
string 
来源渠道
可选
external_user_fields
array [object {6}] 
可选
客户信息自定义字段的列表,非系统基本字段之外的字段。external_user_field的列表。
field_name
string 
自定义字段名称
必需
field_type
string 
可选
自定义字段类型,"text"文本类型,"option_text"选项类型,"datetime"时间类型,"number"数值类型 四选一。默认"text"。
field_datetime
string 
可选
自定义字段对应时间,比如"2021-09-01 16:03:59",格式为YYYY-MM-DD HH:mm:ss;当field_type为"datetime"时,必须传入该字段。
option_name
string 
可选
选项文本,当field_type为"option_text"时,必须传入该字段。
value
string 
可选
自定义字段对应值,当field_type为"text"时必填,最大长度500
number_value
number 
可选
字段类型为数值是对应的值,可以为小数,最多保留两位小数
示例
{
  "staff_id": "zhangsan",
  "external_user_id": "wo8xjUCAAAGfqRyM0CGqryOsaKOYgEZE",
  "external_user_unionid": "oz9xvw_jfkmHMGWVSn5CatKSTOMU",
  "phone_number": "17718167093",
  "age": "18",
  "email": "123@qq.com",
  "birthday": "2000-01-01",
  "weibo": "harchy",
  "qq": "12345",
  "address": "上海浦东区陆家嘴xx大厦11层",
  "description": "活动添加客户,意向很高",
  "state": "测试渠道",
  "external_user_fields": [
    {
      "field_name": "测试时间2",
      "field_type": "datetime",
      "field_datetime": "2021-09-08 20:12:27"
    },
    {
      "field_name": "样例文本7",
      "field_type": "option_text",
      "option_name": "选项文本1"
    },
    {
      "field_name": "测试文本3",
      "field_type": "text",
      "value": "180cm"
    },
    {
      "field_name": "测试数值4",
      "field_type": "number",
      "value": 180.22
    }
  ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.weibanzhushou.com/open-api/external_user/import_info?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
  "staff_id":"zhangsan",
  "external_user_id": "wo8xjUCAAAGfqRyM0CGqryOsaKOYgEZE",
  "external_user_unionid": "oz9xvw_jfkmHMGWVSn5CatKSTOMU",
  "phone_number":"17718167093",
  "age":"18",
  "email":"123@qq.com",
  "birthday":"2000-01-01",
  "weibo":"harchy",
  "qq":"12345",
  "address":"上海浦东区陆家嘴xx大厦11层",
  "description":"活动添加客户,意向很高",
  "state":"测试渠道",
  "external_user_fields":[{
      "field_name":"测试时间2",
      "field_type": "datetime",
      "field_datetime": "2021-09-08 20:12:27"
  },
  {
      "field_name":"样例文本7",
      "field_type": "option_text",
      "option_name": "选项文本1"
  },
  {
      "field_name": "测试文本3",
      "field_type": "text",
      "value": "180cm"
  },
    {
      "field_name": "测试数值4",
      "field_type": "number",
      "value": 180.22
  }
  ]
}'

返回响应

🟢200成功
application/json
Body
object {0}
示例
{
  "errcode": 0,
  "errmsg": "ok"
}
🟢200正常返回
上一页
获取流失提醒客户列表
下一页
添加客户评分
Built with