Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
企业内部开发智慧硬件开发第三方应用开发
企业内部开发智慧硬件开发第三方应用开发
  1. 其他基础信息获取
  • 通讯录管理
    • 成员管理
      • 手机号获取userid
      • 获取成员授权列表
      • 查询成员用户是否已授权
      • 获取选人ticket对应的用户
    • 异步导出接口
      • 导出成员
      • 导出成员详情
      • 导出部门
      • 导出标签成员
      • 获取导出结果
    • 通讯录搜索
      • 通讯录搜索-通讯录单个搜索
      • 通讯录搜索-通讯录批量搜索
    • 通讯录ID转译
      • 上传需要转译的文件
      • 异步通讯录id转译
      • 获取异步任务结果
    • 通讯录userid排序
      POST
  • 客户联系
    • 企业服务人员管理
      • 获取配置了客户联系功能的成员列表
      • 客户联系「联系我」管理-更新企业已配置的「联系我」方式
      • 客户联系「联系我」管理-获取企业已配置的「联系我」方式
      • 客户联系「联系我」管理-删除企业已配置的「联系我」方式
      • 客户联系「联系我」管理-结束临时会话
    • 客户管理
      • 获取客户列表
      • 修改客户备注信息
      • 批量获取客户详情
      • 外部联系人unionid转换
      • 代开发应用external_userid转换
    • 客户标签管理
      • 管理企业标签
        • 管理企业标签-获取企业标签库
        • 管理企业标签-添加企业客户标签
        • 管理企业标签-编辑企业客户标签
        • 管理企业标签-删除企业客户标签
      • 编辑客户企业标签
    • 在职继承
      • 分配在职成员的客户
      • 查询客户接替状态
    • 离职继承
      • 获取待分配的离职成员列表
      • 分配离职成员的客户
      • 查询客户接替状态
      • 分配离职成员的客户群
    • 客户群管理
      • 获取客户群列表
      • 获取客户群详情
      • 客户群opengid转换
    • 客户朋友圈
      • 企业发表内容到客户的朋友圈
        • 企业发表内容到客户的朋友圈-创建发表任务
        • 企业发表内容到客户的朋友圈-获取任务创建结果
      • 获取客户朋友圈全部的发表记录
        • 获取客户朋友圈全部的发表记录-获取企业全部的发表列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈企业发表的列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表时选择的可见范围
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表后的可见客户列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈的互动数据
    • 消息推送
      • 获取企业的全部群发记录
        • 获取企业的全部群发记录-获取群发记录列表
        • 获取企业的全部群发记录-获取群发成员发送任务列表
        • 获取企业的全部群发记录-获取企业群发成员执行结果
      • 创建企业群发
      • 发送新客户欢迎语
      • 入群欢迎语素材管理-添加
      • 入群欢迎语素材管理-编辑
      • 入群欢迎语素材管理-获取
      • 入群欢迎语素材管理-删除
    • 统计管理
      • 获取「群聊数据统计」数据-按群主聚合的方式
      • 获取「群聊数据统计」数据-按自然日聚合的方式
      • 获取「联系客户统计」数据
    • 管理商品图册
      • 创建商品图册
      • 获取商品图册
      • 删除商品图册
      • 获取商品图册列表
      • 编辑商品图册
    • 管理聊天敏感词
      • 管理聊天敏感词-新建敏感词规则
      • 管理聊天敏感词-获取敏感词规则列表
      • 管理聊天敏感词-获取敏感词规则详情
      • 管理聊天敏感词-修改敏感词规则
      • 管理聊天敏感词 删除敏感词规则
    • 上传附件资源
      POST
  • 家校沟通
    • 基础接口
      • 获取外部联系人详情
      • 发送「学校通知」
      • 获取「学校通知」二维码
      • 管理「学校通知」的关注模式-设置关注「学校通知」的模式
      • 管理「学校通知」的关注模式-获取关注「学校通知」的模式
      • 外部联系人openid转换
      • 获取可使用的家长范围
      • 手机号转外部联系人ID
      • 管理「老师可查看班级」模式-设置「老师可查看班级」的模式
      • 管理「老师可查看班级」模式-获取「老师可查看班级」的模式
    • 学生与家长管理
      • 创建学生
      • 删除学生
      • 更新学生
      • 批量创建学生
      • 批量删除学生
      • 批量更新学生
      • 创建家长
      • 删除家长
      • 更新家长
      • 批量创建家长
      • 批量删除家长
      • 批量更新家长
      • 读取学生或家长
      • 获取部门成员详情
      • 设置家校通讯录自动同步模式
      • 获取部门家长详情
    • 部门管理
      • 创建部门
      • 更新部门
      • 删除部门
      • 获取部门列表
      • 修改自动升年级的配置
  • 微信客服
    • 客服帐号管理
      • 添加客服帐号
      • 删除客服帐号
      • 修改客服帐号
      • 获取客服帐号列表
      • 获取客服帐号链接
    • 接待人员管理
      • 删除接待人员
      • 获取接待人员列表
    • 会话分配与消息收发
      • 分配客服会话
        • 分配客服会话-获取会话状态
        • 分配客服会话-变更会话状态
      • 接收消息和事件-读取消息
      • 发送消息
      • 发送欢迎语等事件响应消息
    • 「升级服务」配置
      • 「升级服务」配置-获取配置的专员与客户群
      • 「升级服务」配置-为客户升级为客户群服务
      • 「升级服务」配置-为客户取消推荐
    • 其他基础信息获取
      • 获取客户基础信息
        POST
      • 获取企业状态信息-获取视频号绑定状态
        GET
  • 应用管理
    • 设置工作台自定义展示
      • 设置工作台自定义展示-设置应用在工作台展示的模版
      • 设置工作台自定义展示-获取应用在工作台展示的模版
      • 设置工作台自定义展示-设置应用在用户工作台展示的数据
  • 消息推送
    • 撤回应用消息
  • OA
    • 打卡
      • 获取员工打卡规则
      • 获取打卡记录数据
      • 获取打卡日报数据
      • 获取打卡月报数据
      • 获取打卡人员排班信息
      • 为打卡人员排班
      • 获取设备打卡数据
    • 审批
      • 获取审批模板详情
      • 提交审批申请
      • 批量获取审批单号
      • 获取审批申请详情
      • 获取企业假期管理配置
      • 获取成员假期余额
      • 修改成员假期余额
      • 复制/更新模板到企业
  • 效率工具
    • 日程
      • 日历接口
        • 日历接口 创建日历
        • 日历接口 更新日历
        • 日历接口 获取日历详情
        • 日历接口 删除日历
      • 日程接口
        • 日程接口 创建日程
        • 日程接口更新日程
        • 日程接口 获取日程详情
        • 日程接口 取消日程
        • 日程接口 获取日历下的日程列表
    • 会议
      • 创建预约会议
      • 修改预约会议
      • 取消预约会议
      • 获取成员会议ID列表
      • 获取会议详情
    • 直播
      • 创建预约直播
      • 修改预约直播
      • 取消预约直播
      • 在微信中观看直播或直播回放
      • 获取直播详情
      • 获取直播观看明细
      • 获取跳转小程序商城的直播观众信息
  • 家校应用
    • 上课直播
      • 删除直播回放
      • 获取老师直播ID列表
      • 获取直播详情
      • 获取观看直播统计
      • 获取未观看直播统计
    • 班级收款
      • 获取学生付款结果
      • 获取订单详情
  • 企业支付
    • 对外收款
      • 获取对外收款记录
  • 企业互联
    • 获取应用共享信息
  • 上下游
    • 获取应用共享信息
  • 开发指南
    • 企业微信账号ID安全性全面升级
      • 一、企业corpid的升级方案
        • 1.4 corpid转换
      • 二、企业员工userid的升级方案
        • 2.4 userid的转换
      • 三、企业员工external_userid的升级方案
        • 转换external_userid
        • 设置迁移完成
      • 四、企业客户微信unionid的升级方案
        • 4.2 unionid查询external_userid
  • 自建应用代开发
    • 获取带参授权链接
  1. 其他基础信息获取

获取客户基础信息

POST
http://127.0.0.1/cgi-bin/kf/customer/batchget
第三方应用开发/微信客服/其他基础信息获取
最后修改时间:2022-08-30 03:03:37
责任人:未设置
权限说明:
企业需要使用“微信客服”secret所获取的accesstoken来调用(accesstoken如何获取?)
第三方应用需具有“微信客服权限->获取基础信息”权限

如何获取微信客户的unionid#

1.
在企业微信管理后台“应用管理-微信客服-通过API管理微信客服”处,点击“绑定”去到微信公众平台进行授权,支持绑定公众号和小程序(需要同时绑定微信开放平台);绑定的公众号或小程序主体需与企业微信主体一致,暂且支持绑定一个
2.
绑定完成后,即可通过此接口获取微信客服所对应的微信unionid
3.
第三方服务商若需要unionid,则只需要在服务商自身企业微信管理后台的“应用管理-微信客服-通过API管理微信客服”处绑定微信开发者ID;第三方调用接口返回的unionid是该服务商所关联的微信开发者帐号的unionid。也就是说,同一个微信客户,企业自己调用,与第三方服务商调用,所返回的unionid不同;不同的服务商调用,所返回的unionid也不同
img
注:第三方服务商调用上述接口时,获取到的unionid是第三方服务商主体下的unionid。如果第三方服务商已通过其他方式获取到企业主体下的unionid,可调用 外部联系人unionid转换 接口,将对应的unionid换成服务商名下的external_userid,基于external_userid识别同一客户。
文档ID: 31072
原文档地址:
https://open.work.weixin.qq.com/api/doc/90001/90143/95149
https://open.work.weixin.qq.com/api/doc/90000/90135/95159

请求参数

Query 参数
access_token
string 
调用接口凭证
必需
示例值:
{{accesstoken}}
Body 参数application/json
external_userid_list
array[string]
必需
external_userid列表 可填充个数:1 ~ 100。超过100个需分批调用。
示例
{
  "external_userid_list": [
    "wmxxxxxxxxxxxxxxxxxxxxxx",
    "zhangsan"
  ]
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'http://127.0.0.1/cgi-bin/kf/customer/batchget?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "external_userid_list": [
        "wmxxxxxxxxxxxxxxxxxxxxxx",
        "zhangsan"
    ]
}'

返回响应

🟢200成功
application/json
Body
errcode
integer <int32>
可选
customer_list
array [object {5}] 
返回结果
可选
external_userid
string 
可选
微信客户的external_userid
unionid
string 
可选
unionid,需要绑定微信开发者帐号才能获取到,查看绑定方法
gender
integer <int32>
性别
可选
nickname
string 
微信昵称
可选
avatar
string 
可选
微信头像。第三方不可获取
errmsg
string 
错误码描述
可选
invalid_external_userid
array[string]
可选
示例
{
  "errcode": 0,
  "customer_list": [
    {
      "external_userid": "string",
      "unionid": "string",
      "gender": 0,
      "nickname": "string",
      "avatar": "string"
    }
  ],
  "errmsg": "string",
  "invalid_external_userid": [
    "string"
  ]
}
上一页
「升级服务」配置-为客户取消推荐
下一页
获取企业状态信息-获取视频号绑定状态
Built with