产品能力

接口与回调一览

这里是能力目录。每个接口的请求参数和返回示例,在接口文档中查看。

查看接口文档

接口调用

初始化

  • 初始化企业微信
  • 设置消息回调地址
  • 获取运行中的实例
  • 根据 uuid 查看实例详情
  • 关闭链接

代理设置

  • 设置或取消代理

登录

  • 获取登录二维码
  • 验证码设置
  • 自动登录
  • 退出登录
  • 获取二次验证二维码

发送消息

  • 发送文本消息
  • 发送文本表情消息
  • 发送 CDN 图片
  • 发送 CDN 文件
  • 发送 CDN 语音
  • 发送 CDN 视频
  • 发送大视频
  • 发送大文件
  • 发送链接卡片
  • 发送小程序
  • 发送视频号
  • 发送视频号直播
  • 发送 GIF 表情
  • 发送名片
  • 发送位置
  • 发送群 @ 消息
  • 格式化发送 @ 消息
  • 同步消息记录
  • 群发消息
  • 语音转文字
  • 已读消息
  • 发送引用消息
  • 撤回消息

群操作

  • 设置群备注
  • 禁止修改群名
  • 群邀请确认
  • 设置或移除群管理
  • 群防骚扰规则
  • 群聊黑名单
  • 禁止群内添加
  • 获取客户群列表
  • 获取群成员列表
  • 获取会话中的群聊
  • 同意进群
  • 二维码进群
  • 创建内部群
  • 创建外部群
  • 发送群公告
  • 修改群名
  • 链接邀请进群
  • 直接邀请进群
  • 移除群成员
  • 设置群内昵称
  • 转让群主
  • 解散群
  • 获取群二维码
  • 欢迎语的获取与设置
  • 添加群成员为好友
  • 退出群聊
  • 群详情与头像

开放平台

  • 企业用户 id 转开放平台 id
  • 开放平台 id 转企业用户 id
  • 群 id 转 chatid
  • chatid 转群 id

标签

  • 获取标签列表
  • 添加标签
  • 修改标签
  • 删除标签
  • 一个标签多个用户
  • 一个用户多个标签

CDN 与大文件

  • 获取大文件 authkey
  • 大文件网络上传
  • 大文件上传
  • 大文件下载
  • 大文件下载参数
  • CDN 上传网络或本地图片
  • CDN 上传网络或本地视频
  • CDN 上传网络或本地文件
  • CDN 下载文件
  • 外部联系人图片视频文件下载

联系人

  • 按手机号搜索
  • 搜索添加外部联系人
  • 搜索添加企微用户
  • 根据名片添加
  • 直接添加好友
  • 共享联系人
  • 互联企业成员部门
  • 企业互联成员部门
  • 内部联系人列表
  • 外部联系人列表
  • 按用户 id 批量取详情
  • 同意好友
  • 删除联系人
  • 好友申请列表
  • 会话列表
  • 修改备注、手机、简介、企业
  • 置顶、免打扰、折叠、星标
  • 拉黑或取消拉黑

账号

  • 当前账号详情
  • 当前账号二维码
  • 对外名片二维码
  • 设置头像
  • 设置用户信息
  • 设置是否自动同意
  • 按企业 id 获取企业详情
  • 当前账号封禁原因
  • 上传图片到企微

朋友圈

  • 获取朋友圈列表
  • 获取朋友圈详情
  • 发送朋友圈
  • 删除朋友圈
  • 发送评论
  • 删除评论
  • 点赞或取消点赞

控制台群发

  • 确认群发消息
  • 获取未发送群发列表
  • 客户群发送任务
  • 群发任务详情
  • 朋友圈控制台任务
  • 管理员获取成员客户列表

聊天标签

  • 增删改聊天标签
  • 获取聊天标签列表
  • 获取标签下的联系人
  • 把联系人加入或移出标签

客服管理

  • 获取客服列表
  • 获取客服详情
  • 获取客服当前状态
  • 设置客服接待状态
  • 获取咨询排队列表
  • 接入排队中的客户
  • 获取可转接客服
  • 结束会话
  • 会话转接给同事

商户收款

  • 获取商户列表
  • 获取收款二维码
  • 发送收款小程序

消息回调

登录

  • 扫码返回
  • 取消扫码
  • 确认扫码
  • 登录成功
  • 企业切换
  • 需要输入验证码

消息

  • 文本
  • GIF 表情
  • 小程序
  • 链接
  • 视频号与直播
  • 名片
  • 位置
  • 内外部图片、文件、视频
  • 红包
  • 语音
  • 语音或视频通话及未接、取消
  • 撤回
  • 合并消息
  • 系统消息
  • 接龙
  • 大文件
  • 客服排队通知

群

  • 群新增
  • 移除群成员
  • 邀请进群
  • 自己退出群聊
  • 群名变更
  • 群主转让及其他设置
  • 管理员变动
  • 群解散
  • 群变动

联系人

  • 添加申请
  • 联系人变动
  • 内部联系人标签描述变动
  • 已读消息
  • 提示删除
  • 提示拉黑
  • 置顶与免打扰标记

控制台任务

  • 客户群群发任务
  • 客户消息群发任务
  • 朋友圈控制台下发

标签变动

  • 个人标签新增
  • 个人标签删除
  • 企业标签新增
  • 企业标签删除

聊天标签

  • 聊天标签变动
  • 标签中的联系人变动

断开

  • 二次验证通知
  • 手机端结束登录
  • 当前账号在其他设备登录
  • 二维码扫码超时断开
  • 异常断开