微伴助手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/batch_get
只有在企业微信侧完成了微信开发者ID绑定后才可在企业微信用户系统和微伴助手用户系统中通过 unionid 关联到具体客户。绑定方法见 企业微信unionid绑定流程
错误码说明
20205批量查询最多只支持同时查询20个用户详情数据
20206id_list 错误,找不到对应客户
20207unionid_list 错误,找不到对应客户
20208unionid_list 和 id_list 必须至少提供一个
调用此接口需购买基础席位。

请求参数

Query 参数
access_token
string 
调用接口凭证
必需
默认值:
{{access_token}}
Body 参数application/json
id_list
array[string]
必需
客户id列表,最多20个(id和unionid两个选择传入一个)
unionid_list
array[string]
必需
客户unionid列表,最多20个(id和unionid两个选择传入一个)
示例
{
    "id_list": [
        "string"
    ],
    "unionid_list": [
        "string"
    ]
}

示例代码

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/batch_get?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id_list": [
        "string"
    ],
    "unionid_list": [
        "string"
    ]
}'

返回响应

🟢200成功
application/json
Body
errcode
integer 
可选
状态码,0为正常,非0代表错误。业务错误码下述,全局错误码见 全局错误码
errmsg
string 
可选
错误信息,成功时为'ok',错误时会以中文方式显示错误原因
total
integer 
session总量
可选
external_user
array [object {12}] 
客户列表
可选
id
string 
可选
外部联系人id(主键)
type
integer 
可选
外部联系人的类型,1表示该外部联系人是微信用户,2表示该外部联系人是企业微信用户
unionid
string  | null 
可选
仅当联系人类型是微信用户,且企业绑定了微信开发者ID有此字段
created_at
integer 
可选
数据创建时间(微伴系统内时间)
name
string 
外部联系人昵称
可选
avatar
string 
外部联系人头像
可选
corp_full_name
string  | null 
可选
外部联系人所在企业的主体名称,仅当联系人类型是企业微信用户时有此字段
corp_name
string  | null 
可选
外部联系人所在企业的简称,仅当联系人类型是企业微信用户时有此字段
gender
integer 
可选
外部联系人性别 0-未知 1-男性 2-女性
position
string  | null 
可选
外部联系人的职位,如果外部企业或用户选择隐藏职位,则不返回,仅当联系人类型是企业微信用户时有此字段
external_profile
object  | null 
可选
外部联系人的自定义展示信息,可以有多个字段和多种类型,包括文本,网页和小程序,仅当联系人类型是企业微信用户时/有此字段,字段详情见企业微信对应文档
follow_staffs
array [object {26}] 
可选
员工关系数组,为空表示客户当前未添加任何员工
custom_fields
array[object (CustomRemarkField) {9}] 
客户自定义信息列表
可选
corp_id
string 
客户所在公司ID
可选
created_at
integer 
自定义信息创建时间
可选
deleted
boolean 
是否被删除
可选
field_type
string 
可选
自定义信息类型,支持text、option_text、datetime
field_value
string 
自定义信息的值
可选
has_staff_used
boolean 
可选
员工是否使用该自定义信息
id
integer 
自定义信息id
可选
name
string 
自定义信息名称
可选
rank_num
integer 
自定义信息排序
可选
示例
{
    "errcode": 0,
    "errmsg": "ok",
    "external_user": [
        {
            "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM7yFiaRtEAkUefCeyu0XzfOZYrA6gNmghcpdHaGGpicH41g/0",
            "corp_full_name": null,
            "corp_name": null,
            "created_at": 1624518685,
            "external_profile": null,
            "follow_staffs": [
                {
                    "address": "上海浦东区陆家嘴xx大厦11层",
                    "age": "18",
                    "birthday": "2000-01-01",
                    "custom_fields": [
                        {
                            "corp_id": "1703429757388935169",
                            "created_at": 1681468753,
                            "deleted": false,
                            "field_type": "text",
                            "field_value": "",
                            "has_staff_used": true,
                            "id": 3000008661,
                            "name": "如果第三个东方饭店",
                            "rank_num": 32
                        },
                        {
                            "corp_id": "1703429757388935169",
                            "created_at": 1681376042,
                            "deleted": false,
                            "field_type": "text",
                            "field_value": "",
                            "has_staff_used": true,
                            "id": 3000008660,
                            "name": "11",
                            "rank_num": 31
                        },
                        {
                            "corp_id": "1703429757388935169",
                            "created_at": 1681374858,
                            "deleted": false,
                            "field_type": "option_text",
                            "field_value": "",
                            "has_staff_used": true,
                            "id": 3000008658,
                            "name": "234234",
                            "option_list": [
                                {
                                    "corp_id": "1703429757388935169",
                                    "created_at": 1681374858,
                                    "deleted": false,
                                    "field_id": 3000008658,
                                    "id": 3000006345,
                                    "name": "222"
                                }
                            ],
                            "rank_num": 30
                        },
                        {
                            "corp_id": "1703429757388935169",
                            "created_at": 1681374845,
                            "deleted": false,
                            "field_type": "text",
                            "field_value": "",
                            "has_staff_used": true,
                            "id": 3000008657,
                            "name": "123123",
                            "rank_num": 29
                        },
                        {
                            "corp_id": "1703429757388935169",
                            "created_at": 1681373155,
                            "deleted": false,
                            "field_type": "text",
                            "field_value": "",
                            "has_staff_used": true,
                            "id": 3000008656,
                            "name": "时间",
                            "rank_num": 28
                        },
                        {
                            "corp_id": "1703429757388935169",
                            "created_at": 1681201850,
                            "deleted": false,
                            "field_type": "datetime",
                            "field_value": "",
                            "has_staff_used": true,
                            "id": 3000008644,
                            "name": "大家都在发大家都在发大家都在发大家都",
                            "rank_num": 26
                        },
                        {
                            "corp_id": "1703429757388935169",
                            "created_at": 1681201327,
                            "deleted": false,
                            "field_type": "text",
                            "field_value": "",
                            "has_staff_used": true,
                            "id": 3000008643,
                            "name": "封禁端口是否记录卡撒旦放假啦空手道解",
                            "rank_num": 25
                        },
                        {
                            "corp_id": "1703429757388935169",
                            "created_at": 1681201112,
                            "deleted": false,
                            "field_type": "option_text",
                            "field_value": "",
                            "has_staff_used": true,
                            "id": 3000008642,
                            "name": "测试选择",
      
🟢200正常返回
修改于 2024-03-05 06:42:36
上一页
获取客户自定义字段值列表
下一页
获取批量加好友待添加列表
Built with