企业微信 API
企业内部开发第三方应用开发智慧硬件开发
企业内部开发第三方应用开发智慧硬件开发
  1. 应用授权
  • 开发指南
    • 开发前必读
    • 基本概念介绍
    • 回调配置
      • 回调配置
      • 回调配置-支持Http Get请求验证URL有效性
      • 回调配置-支持Http Post请求接收业务数据
      • 回调配置-获取企业微信服务器的ip段
    • 企业微信账号ID安全性全面升级
      • 概述
      • FAQ
      • 一、企业corpid的升级方案
        • 1.1 升级前后对比 - 1.3 历史已授权企业的方案
        • 1.4 corpid转换
      • 二、企业员工userid的升级方案
        • 2.1 升级前后对比 - 2.3历史已授权企业的方案
        • 2.4 userid的转换
      • 三、企业员工external_userid的升级方案
        • 3.1 升级前后对比 - 3.3 历史已授权企业的方案
        • 同意授权转换external_userid事件
        • 转换external_userid
        • 转换客户群成员external_userid
        • 设置迁移完成
      • 四、企业客户微信unionid的升级方案
        • 概述
        • 4.1 升级之后的接口变化
        • 4.2 unionid查询external_userid
    • 代开发应用安全性升级
      • 说明
      • 四、企业客户微信unionid的升级方案
      • 六、成员敏感信息权限升级
      • 七、本次升级对第三方服务商的影响及建议兼容方案
      • FAQ
      • 一、企业corpid的升级方案
        • 1.1 升级前后对比-1.3 历史已授权代开发应用方案
        • 1.4 corpid转换
      • 二、企业员工userid的升级方案
        • 2.1 升级前后对比-2.3 历史已授权代开发应用的方案
        • 2.4 userid的转换
      • 三、企业客户external_userid的升级方案
        • 3.1 升级前后对比-3.2 升级之后的接口变化
        • 3.2.1 转换external_userid
        • 3.2.2 转换客户群成员external_userid
      • 五、代开发应用迁移状态
        • 5.1 代开发应用设置迁移完成
        • 5.2 代开发应用查询迁移状态
    • ID转换接口
      • ID转换接口
      • corpid的转换
      • userid的转换
      • external_userid的转换-转换客户external_userid
      • external_userid的转换-转换客户群成员external_userid
    • unionid与external_userid的关联
      • unionid与external_userid的关联
      • unionid转换为第三方external_userid
      • external_userid查询pending_id
    • 获取服务商凭证
      POST
  • 基础
    • 应用授权
      • 企业授权应用
      • 成员授权应用
      • 自建应用代开发
      • 通讯录权限体系
      • 接口调用
        • 获取应用二维码
        • 明文corpid转换为加密corpid
        • 获取第三方应用凭证
        • 获取预授权码
        • 设置授权配置
        • 获取企业永久授权码
        • 获取企业授权信息
        • 获取企业凭证
        • 获取应用的管理员列表
      • 回调接口
        • 概述
        • 共享应用事件回调
        • 授权组织架构权限通知
        • 推送suite_ticket
        • 授权通知事件-授权成功通知
        • 授权通知事件 变更授权通知
        • 授权通知事件 取消授权通知
        • 成员通知事件 新增成员事件
        • 成员通知事件 更新成员事件
        • 成员通知事件 删除成员事件
        • 部门通知事件 新增部门事件
        • 部门通知事件 更新部门事件
        • 部门通知事件 删除部门事件
        • 标签通知事件 标签成员变更事件
        • 重置永久授权码通知
        • 应用管理员变更通知
    • 接口调用许可
      • 概述与指引
      • 订单管理
        • 下单购买帐号
        • 下单续期帐号-创建续期任务
        • 下单续期帐号-提交续期订单
        • 获取订单列表
        • 获取订单详情
        • 获取订单中的帐号列表
        • 取消订单
      • 账号管理
        • 激活帐号-激活帐号
        • 激活帐号-批量激活帐号
        • 获取激活码详情-获取激活码详情
        • 获取激活码详情-批量获取激活码详情
        • 获取企业的帐号列表
        • 获取成员的激活详情
        • 帐号继承
        • 分配激活码给下游企业
      • 应用管理
        • 获取应用的接口许可状态
      • 回调通知
        • 接口许可失效通知
        • 支付成功通知
        • 退款结果通知
        • 自动激活回调通知
      • 自动激活设置
        • 设置企业的许可自动激活状态
        • 查询企业的许可自动激活状态
      • 民生减免条件查询
    • 收银台
      • 接入指引
      • 功能概述
        • 概述
        • 商户号开通
        • 定价策略配置
        • 企业客户购买
        • 订单收款工具
      • 接口调用
        • 获取订单详情
        • 获取订单列表
        • 获取企业永久授权码
        • 获取企业授权信息
        • 延长试用期
      • 回调通知
        • 应用版本变更通知
        • 下单成功通知
        • 改单通知
        • 支付成功通知
        • 退款通知
    • 推广二维码
      • 接入指引
      • 调用接口
        • 获取注册码
        • 查询注册状态
        • 设置授权应用可见范围
        • 设置通讯录同步完成
      • 回调通知
        • 注册完成回调事件
    • 账号ID
      • 概述
      • 安全性升级说明
        • 代开发应用安全性升级
          • 说明
          • 四、企业客户微信unionid的升级方案
          • 6.1. 升级后的变化
          • 七、本次升级对第三方服务商的影响及建议兼容方案
          • FAQ
          • 一、企业corpid的升级方案
            • 1.1 升级前后对比-1.3 历史已授权代开发应用方案
            • 1.4 corpid转换
          • 二、企业员工userid的升级方案
            • 2.1 升级前后对比-2.3 历史已授权代开发应用的方案
            • 2.4 userid的转换
          • 三、企业客户external_userid的升级方案
            • 3.1 升级前后对比-3.2 升级之后的接口变化
            • 3.2.1 转换external_userid
            • 3.2.2 转换客户群成员external_userid
          • 五、代开发应用迁移状态
            • 5.1 代开发应用设置迁移完成
            • 5.2 代开发应用查询迁移状态
      • 企业微信帐号ID安全性全面升级
        • 一、企业corpid的升级方案
          • 1.1 升级前后对比-1.3 历史已授权企业的方案
          • 1.4 corpid转换
        • 二、企业员工userid的升级方案
          • 2.1 升级前后对比-2.3 历史已授权企业的方案
          • 2.4 userid的转换
        • 三、企业客户external_userid的升级方案
          • 3.1 升级前后对比-3.3 历史已授权企业的方案
          • 同意授权转换external_userid事件
          • 转换external_userid
          • 转换客户群成员external_userid
          • 设置迁移完成
        • 四、企业客户微信unionid的升级方案
          • 4.1 升级之后的接口变化
          • FAQ
          • 4.2 unionid查询external_userid
      • ID转换接口
        • unionid与external_userid的关联
          • unionid与external_userid的关联
          • unionid转换为第三方external_userid
          • external_userid查询pending_id
        • corpid的转换
        • userid的转换
        • external_userid的转换-转换客户external_userid
        • external_userid的转换-转换客户群成员external_userid
        • 客户标签ID的转换
        • 微信客服ID的转换
    • 通讯录管理
      • 概述
      • 通讯录展示组件
      • 第三方通讯录编辑授权
      • 成员管理
        • 创建成员
        • 读取成员
        • 更新成员
        • 删除成员
        • 批量删除成员
        • 获取部门成员
        • 获取部门成员详情
        • userid与openid互换-userid转openid
        • userid与openid互换-openid转userid
        • 二次验证
        • 邀请成员
        • 手机号获取userid
        • 邮箱获取userid
        • 获取成员授权列表
        • 查询成员用户是否已授权
        • 获取选人ticket对应的用户
        • 获取成员ID列表
      • 部门管理
        • 获取单个部门详情
        • 创建部门
        • 更新部门
        • 删除部门
        • 获取部门列表
        • 获取子部门ID列表
      • 标签管理
        • 创建标签
        • 更新标签名字
        • 删除标签
        • 获取标签成员
        • 增加标签成员
        • 删除标签成员
        • 获取标签列表
      • 异步批量接口
        • 概述
        • 增量更新成员
        • 全量覆盖成员
        • 全量覆盖部门
        • 获取异步任务结果
      • 异步导出接口
        • 导出任务完成通知
        • 概述
        • 导出成员
        • 导出成员详情
        • 导出部门
        • 导出标签成员
        • 获取导出结果
      • 通讯录回调通知
        • 异步任务完成通知
        • 成员通知事件-更新成员事件
        • 成员通知事件-删除成员事件
        • 部门通知事件-新增部门事件
        • 部门通知事件-更新部门事件
        • 部门通知事件-删除部门事件
        • 标签通知事件
        • 成员通知事件-新增成员事件
      • 通讯录搜索
        • 通讯录搜索-通讯录单个搜索
        • 通讯录搜索-通讯录批量搜索
      • 通讯录ID转译
        • 概述
        • 上传需要转译的文件
        • 异步通讯录id转译
        • 获取异步任务结果
        • 异步任务回调通知
      • 通讯录userid排序
    • 身份验证
      • 网页授权登录
        • 开始开发
        • 构造网页授权链接
        • 获取访问用户身份
        • 获取访问用户敏感信息
      • 扫码授权登录
        • 接入指引
        • 获取登录用户信息
    • 企业互联
      • 概述
      • 获取下级企业付费版本信息
      • 获取应用共享信息
    • 上下游
      • 获取应用共享信息
    • 消息推送
      • 概述
      • 发送应用模板消息
      • 接收消息与事件
        • 消息格式
        • 事件格式
        • 被动回复消息格式
        • 概述
          • 概述
          • 概述-验证URL有效性
          • 概述-使用接收消息
          • 概述-获取企业微信服务器的ip段
      • 发送应用消息
        • 消息类型
        • 发送应用消息
      • 更新模版卡片消息
      • 撤回应用消息
    • 应用管理
      • 获取应用
        • 获取应用-获取指定的应用详情
        • 获取应用-获取access_token对应的应用列表
      • 设置工作台自定义展示
        • 模版类型数据结构
        • 修改设置工作台自定义开关事件推送
        • 设置工作台自定义展示-设置应用在工作台展示的模版
        • 设置工作台自定义展示-获取应用在工作台展示的模版
        • 设置工作台自定义展示-设置应用在用户工作台展示的数据
    • 素材管理
      • 概述
      • 异步上传临时素材
        • 概述
        • 回调异步任务结果
        • 生成异步上传任务
        • 查询异步任务结果
      • 上传临时素材
      • 上传图片
      • 获取临时素材
      • 获取高清语音素材
    • 电子发票
      • 概述
      • 查询电子发票
      • 更新发票状态
      • 批量更新发票状态
      • 批量查询电子发票
  • 连接微信
    • 客户联系
      • 概述
      • 成员对外信息
      • 企业服务人员管理
        • 获取配置了客户联系功能的成员列表
        • 客户联系「联系我」管理-配置客户联系「联系我」方式
        • 客户联系「联系我」管理-更新企业已配置的「联系我」方式
        • 客户联系「联系我」管理-获取企业已配置的「联系我」方式
        • 客户联系「联系我」管理-获取企业已配置的「联系我」列表
        • 客户联系「联系我」管理-删除企业已配置的「联系我」方式
        • 客户联系「联系我」管理-结束临时会话
      • 客户管理
        • 获取客户列表
        • 获取客户详情
        • 批量获取客户详情
        • 修改客户备注信息
        • 企业主体unionid转换为第三方external_userid
        • 第三方主体unionid转换为第三方external_userid
        • 代开发应用external_userid转换
      • 客户标签管理
        • 管理企业标签
          • 说明
          • 管理企业标签-获取企业标签库
          • 管理企业标签-添加企业客户标签
          • 管理企业标签-编辑企业客户标签
          • 管理企业标签-删除企业客户标签
        • 编辑客户企业标签
      • 在职继承
        • 分配在职成员的客户
        • 查询客户接替状态
        • 分配在职成员的客户群
      • 离职继承
        • 获取待分配的离职成员列表
        • 分配离职成员的客户
        • 查询客户接替状态
        • 分配离职成员的客户群
      • 客户群管理
        • 获取客户群列表
        • 获取客户群详情
        • 客户群opengid转换
      • 联系我与客户入群方式
        • 权限说明
        • 结束语定义
        • 配置客户联系「联系我」方式
        • 获取企业已配置的「联系我」方式
        • 获取企业已配置的「联系我」列表
        • 更新企业已配置的「联系我」方式
        • 删除企业已配置的「联系我」方式
        • 结束临时会话
      • 客户朋友圈
        • 概述
        • 企业发表内容到客户的朋友圈
          • 企业发表内容到客户的朋友圈-创建发表任务
          • 企业发表内容到客户的朋友圈-获取任务创建结果
        • 获取客户朋友圈全部的发表记录
          • 获取客户朋友圈全部的发表记录-获取企业全部的发表列表
          • 获取客户朋友圈全部的发表记录-获取客户朋友圈企业发表的列表
          • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表时选择的可见范围
          • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表后的可见客户列表
          • 获取客户朋友圈全部的发表记录-获取客户朋友圈的互动数据
        • 停止发表企业朋友圈
      • 消息推送
        • 获取企业的全部群发记录
          • 概述
          • 获取企业的全部群发记录-获取群发记录列表
          • 获取企业的全部群发记录-获取群发成员发送任务列表
          • 获取企业的全部群发记录-获取企业群发成员执行结果
        • 创建企业群发
        • 提醒成员群发
        • 停止企业群发
        • 发送新客户欢迎语
        • 入群欢迎语素材管理-添加
        • 入群欢迎语素材管理-编辑
        • 入群欢迎语素材管理-获取
        • 入群欢迎语素材管理-删除
      • 统计管理
        • 获取「联系客户统计」数据
        • 获取「群聊数据统计」数据-按群主聚合的方式
        • 获取「群聊数据统计」数据-按自然日聚合的方式
      • 回调通知
        • 事件格式
      • 管理商品图册
        • 概述
        • 创建商品图册
        • 获取商品图册
        • 删除商品图册
        • 获取商品图册列表
        • 编辑商品图册
      • 管理聊天敏感词
        • 概述
        • 管理聊天敏感词-新建敏感词规则
        • 管理聊天敏感词-获取敏感词规则列表
        • 管理聊天敏感词-获取敏感词规则详情
        • 管理聊天敏感词-修改敏感词规则
        • 管理聊天敏感词 删除敏感词规则
      • 上传附件资源
    • 微信客服
      • 概述
      • 回调通知
      • 客服帐号管理
        • 添加客服帐号
        • 删除客服帐号
        • 修改客服帐号
        • 获取客服帐号列表
        • 获取客服帐号链接
      • 接待人员管理
        • 添加接待人员
        • 删除接待人员
        • 获取接待人员列表
      • 会话分配与消息收发
        • 分配客服会话
          • 概述
          • 分配客服会话-获取会话状态
          • 分配客服会话-变更会话状态
        • 接收消息和事件
          • 概述
          • 消息类型
          • 接收消息和事件-读取消息
        • 发送消息
        • 发送欢迎语等事件响应消息
      • 「升级服务」配置
        • 什么是升级服务
        • 「升级服务」配置-获取配置的专员与客户群
        • 「升级服务」配置-为客户升级为专员服务
        • 「升级服务」配置-为客户升级为客户群服务
        • 「升级服务」配置-为客户取消推荐
      • 其他基础信息获取
        • 获取客户基础信息
        • 获取企业状态信息-获取视频号绑定状态
      • 统计管理
        • 获取「客户数据统计」企业汇总数据
        • 获取「客户数据统计」接待人员明细数据
    • 企业支付
      • 对外收款
        • 概述
        • 获取收款项目的商户单号
        • 获取对外收款记录
    • 家校沟通
      • 概述
      • 接入指引
      • 基础接口
        • 获取「学校通知」二维码
        • 管理「学校通知」的关注模式-设置关注「学校通知」的模式
        • 管理「学校通知」的关注模式-获取关注「学校通知」的模式
        • 发送「学校通知」
        • 获取外部联系人详情
        • 外部联系人openid转换
        • 手机号转外部联系人ID
        • 管理「老师可查看班级」模式-设置「老师可查看班级」的模式
        • 管理「老师可查看班级」模式-获取「老师可查看班级」的模式
        • 获取可使用的家长范围
      • 网页授权登录
        • 开始开发
        • 构造网页授权链接
        • 获取家校访问用户身份
        • 获取访问用户身份
      • 学生与家长管理
        • 创建学生
        • 删除学生
        • 更新学生
        • 批量创建学生
        • 批量删除学生
        • 批量更新学生
        • 创建家长
        • 删除家长
        • 更新家长
        • 批量创建家长
        • 批量删除家长
        • 批量更新家长
        • 读取学生或家长
        • 获取部门成员详情
        • 设置家校通讯录自动同步模式
        • 获取部门家长详情
      • 部门管理
        • 标准年级对照表
        • 创建部门
        • 更新部门
        • 删除部门
        • 获取部门列表
        • 修改自动升年级的配置
      • 家校通讯录变更回调
        • 成员变更事件
        • 部门变更事件
    • 家校应用
      • 上课直播
        • 获取观看直播统计V2
        • 获取未观看直播统计V2
        • 获取老师直播ID列表
        • 获取直播详情
        • 获取观看直播统计
        • 获取未观看直播统计
        • 删除直播回放
      • 班级收款
        • 获取学生付款结果
        • 获取订单详情
  • 办公
    • 邮件
      • 概述
      • 回调通知
      • 发送邮件
        • 发送普通邮件
        • 发送日程邮件
        • 发送会议邮件
      • 获取接收的邮件
        • 获取收件箱邮件列表
        • 获取邮件内容
      • 管理应用邮箱账号
        • 更新应用邮箱帐号
        • 查询应用邮箱帐号
    • 文档
      • 概述
      • 管理文档
        • 新建文档
        • 重命名文档/收集表
        • 删除文档/收集表
        • 获取文档基础信息
        • 分享文档
      • 设置文档权限信息
        • 获取文档权限信息
        • 修改文档查看规则
        • 修改文档通知范围及权限
        • 修改文档安全设置
      • 管理收集表
        • 创建收集表
        • 编辑收集表
        • 收集表的统计信息查询
        • 读取收集表答案
        • 获取收集表信息
      • 回调通知
        • 概述
        • 修改文档成员事件
        • 删除文档事件
        • 收集表完成事件
    • 日程
      • 概述
      • 管理日历
        • 日历接口 创建日历
        • 日历接口 更新日历
        • 日历接口 获取日历详情
        • 日历接口 删除日历
      • 管理日程
        • 更新重复日程
        • 日程接口 创建日程
        • 日程接口更新日程
        • 新增日程参与者
        • 删除日程参与者
        • 日程接口 获取日历下的日程列表
        • 日程接口 获取日程详情
        • 日程接口 取消日程
      • 回调通知
        • 概述
        • 删除日历事件
        • 修改日历事件
        • 修改日程事件
        • 删除日程事件
    • 会议
      • 回调通知
      • 概述
      • 创建预约会议
      • 修改预约会议
      • 取消预约会议
      • 获取成员会议ID列表
      • 获取会议详情
    • 微盘
    • 直播
      • 概述
      • 直播回调事件
      • 创建预约直播
      • 修改预约直播
      • 取消预约直播
      • 删除直播回放
      • 在微信中观看直播或直播回放
      • 获取成员直播ID列表
      • 获取直播详情
      • 获取直播观看明细
      • 获取跳转小程序商城的直播观众信息
    • 打卡
      • 获取员工打卡规则
      • 获取打卡记录数据
      • 获取打卡日报数据
      • 获取打卡月报数据
      • 获取打卡人员排班信息
      • 为打卡人员排班
      • 获取设备打卡数据
    • 审批
      • 审批流程引擎
      • 概述
      • 审批申请状态变化回调通知
      • 复制/更新模板到企业
      • 获取审批模板详情
      • 提交审批申请
      • 批量获取审批单号
      • 获取审批申请详情
      • 获取企业假期管理配置
      • 获取成员假期余额
      • 修改成员假期余额
  • 智慧硬件
    • 概述
    • 接口调用
      • 获取硬件授权结果
      • 获取考勤打卡原始数据
      • 获取温度检测原始数据
      • 获取门禁通行原始数据
      • 读取门禁通行规则
      • 写入门禁通行规则
      • 修改门禁通行规则
      • 删除门禁通行规则
    • 回调通知
      • 设备数据授权变更回调
      • 考勤打卡原始数据回调
      • 门禁通行原始数据回调
      • 体温检测原始数据回调
  1. 应用授权

自建应用代开发

概述#

企业微信保持开放的第三方合作策略,致力于和所有的合作伙伴携手为用户提供最优质的企业服务。
为此,企业微信开放自建应用代开发模式,企业可通过扫码授权的方式,授权第三方服务商代开发自建应用,更加安全、高效、便捷。
服务商可通过自建应用代开发模式,为企业提供灵活的、定制的应用服务。通过原第三方标准应用模式,向企业提供标准的、统一的应用服务。
本指引将介绍企业微信服务商,为企业用户提供自建应用代开发的流程。
企业应用代开发暂时只支持网页应用。

企业应用代开发流程图示#

img

创建代开发模版#

1. 概述#

● 代开发应用模版,是服务商向企业提供一类自建应用代开发的载体,与授权二维码一一对应。例如CRM和ERP可以是两个代开发应用模版,对应两个授权二维码,企业可以选择需要的应用能力授权代开发自建应用。
● 一个代开发应用模版,可以被多个企业扫码授权。例如服务商的CRM代开发应用模版,多个企业授权后,服务商可为这些企业代开发CRM自建应用。
● 每个模版仅可以被同一个企业授权安装一个代开发应用。例如企业扫码授权了服务商的CRM代开发模版,服务商可为该企业代开发一个CRM应用,不可以一个模版代开发多个应用。服务商可通过多个代开发模版为企业代开发多个应用。

2. 创建代开发模版#

1) 进入 服务商后台-应用管理-应用代开发 ,点击“创建代开发应用模版”,进行代开发应用模版基础信息和开发信息配置。
img
2) 配置代开发模版信息填写标准:
填写项填写标准
代开发应用模版logo必须为正方形,像素为750﹡750,1M以内的jpg、png图片,不可使用企业微信logo或进行二次修改
代开发应用模版名称2-10个字,建议包含品牌名,不可使用特殊字符及特殊词汇 (如:“微信”、“特卖”、“企业微信”、“企微”、“抽奖”、“免费”等)
代开发应用模版介绍4-20个字,简单清晰描述应用功能和使用场景
分类根据应用的功能及场景进行选择
目标行业根据应用目标用户的行业进行选择
代开发模版回调URL填写带https:// 头的有效URL链接,填写URL时需要正确响应企业微信验证URL的请求。用于接收企业用户授权成功信息

3. 提交代开发模版上线#

代开发模版创建成功后,仅保存了模版信息。需要进入 服务商后台-应用管理-代开发应用上线 提交模版上线审核,审核通过后手动提交上线。模版正式上线后才会生成对应的授权二维码。
1) 点击提交上线按钮,选择需要提交上线审核的代开发模版。
img
2) 提交后可在代开发应用上线列表中,查看模版上线审核单。
img
3) 审核通过后,审核状态将变为“待上线”,进入审核详情页,点击“提交上线”,进行代开发模版上线。
img

4. 获取代开发模版授权二维码#

1) 模版上线提交成功后,回到 服务商后台-应用管理-代开发应用,进入代开发模版详情页,可查看对应的授权二维码。
img
2) 若需要将多个代开发应用模版组合成一个授权二维码,让企业进行批量授权,可在代开发应用首页,点击右上角“批量授权”按钮,选择2-9个已上线的代开发应用模版,生成批量授权二维码。批量授权二维码有效期为10天,超过10天需要重新生成。
img
img
img
3) 将代开发模版对应的授权二维码,提供给企业客户管理员,进行扫码授权。
img

企业应用代开发#

1. 概述#

● 企业扫描服务商代开发二维码,授权成功后,企业侧自动创建由该服务商代开发的自建应用,初始状态为开发中,不可正常使用。待服务商正式上线企业代开发应用,则企业侧该应用状态变成已启用,企业管理员可设置可见范围正常使用。企业侧可以随时取消授权,服务商侧不可删除代开发企业应用。
● 自建应用代开发,应用权限分为基础权限和自定义权限。
基础权限为企业扫码授权服务商进行自建应用代开发,应用即可获取基础权限。
自定义权限,则需要企业再次确认后,代开发应用才可以获取具体自定义权限。
哪些为基础权限,哪些为自定义权限,代开发权限明细可查看:代开发权限说明 。

2. 开始代开发应用配置#

1) 进入 服务商后台-应用管理-应用代开发 ,点击提供给企业扫码授权的代开发模版,进入模版详情页,可以查看该代开发模版对应的企业授权列表。
2) 点击“开始代开发应用”为该企业代开发应用配置基础信息和开发信息。其中代开发应用logo、名称、介绍,回调URL信息,会默认填写代开发模版的信息,可以进行修改,提升填写效率。
img
填写项填写标准
代开发应用logo必须为正方形,像素为750﹡750,1M以内的jpg、png图片,不可使用企业微信logo或进行二次修改
代开发应用名称2-10个字,建议包含品牌名,不可使用特殊字符及特殊词汇 (如:“微信”、“特卖”、“企业微信”、“企微”、“抽奖”、“免费”等)
代开发应用介绍4-120个字,简单清晰描述应用功能和使用场景
应用主页用户从企业微信工作台进入应用时将直接跳转到对应的主页URL
可信域名填写不带http:// 或https:// 头,可信域名必须通过ICP备案验证,设置可信域名后支持应用的OAuth2授权、JSSDK调用等
IP白名单选填。只有白名单内的IP才能正常调用企业微信API,若后续IP有修改,需要及时进行列表更新
代开发应用回调URL填写带https:// 头的有效URL链接,填写URL时需要正确响应企业微信验证URL的请求。用于接收托管企业微信应用的用户消息、进入应用事件等事件

3. 配置自定义权限#

企业完成代开发应用授权后,代开发应用若需要额外的自定义权限,实现相关功能的开发,可以申请获取代开发应用自定义权限。
1) 进入服务商后台,代开发应用详情页,权限设置模块,点击右上角“编辑”按钮,可进行代开发应用自定义权限编辑。
img
2) 进入编辑状态后,可选择代开发应用所需要的自定义权限进行勾选。代开发应用自定义权限可多次编辑,每次编辑保存后将立即向企业客户发送一条代开发应用权限变更推送消息。
img
3) 企业客户管理员收到代开发应用权限变更消息,若企业同意权限则服务商所选择的自定义权限立即生效。若企业选择暂不授权,则本次服务商选择的权限不生效,代开发应用依旧保持之前的自定义权限。
img
4) 代开发应用详情页,权限设置模块,非编辑状态:
● 当前申请的代开发自定义权限待企业侧确认的,会在权限后面展示“待企业客户确认”提示;
● 当企业同意授权后,权限设置模块将更新为企业确认后的权限状态,且没有“待企业客服确认”提示;
● 当企业暂不授权后,权限设置模块将回退为申请之前的权限状态,即服务商申请的没有成功。
img
5) 在权限设置模块,点击右上角的“查看企业已确认权限”,可查看当前代开发应用生效的权限状态。
img
6) 代开发应用自定义权限,与应用上线状态无关,申请自定义权限企业确认后则立即生效,可调用相关接口。自定义权限企业确认后,企业侧不需要到企业管理后台去配置可调用应用(例如客户联系相关权限,服务商勾选企业确认后,代开发应用即可调用,不需要再到企业管理后台客户联系配置可调用应用)。

4. 自行测试#

可通过服务商测试企业,进行代开发应用测试。(若无测试企业可创建一个测试企业,无需注册服务商账号,作为测试企业使用即可)。
● 服务商测试企业,管理员扫描需要代开发应用的同一个代开发模版二维码,授权后为该测试企业配置相同的代开发应用信息。
● 将服务商测试企业的代开发应用提交上线审核,审核通过后提交正式上线。
● 服务商测试企业管理员收到代开发应用上线消息,设置该应用可见范围,可见范围内成员可以进行应用使用和测试相关功能。

5. 代开发应用上线#

1) 自行测试完毕后,进入服务商后台-应用管理-代开发应用上线,点击“提交上线”按钮,选择需要上线的代开发模版,和对应的企业代开发应用,提交上线审核。
img
● 提交上线页,左侧先选择需要上线代开发应用所属代开发模版,然后在右侧选择这个模版下,需要提交上线审核的企业代开发应用,勾选后确定提交。则该企业代开发应用进入上线审核流程。
● 提交代开发应用上线,不需要再次提交所属代开发模版的上线流程。代开发模版仅在修改模版配置信息时需要保存后提交模版上线。
img
2) 审核通过后,进入代开发应用审核详情页,点击提交上线,确认正式上线企业代开发应用。
img
3) 正式上线后,企业管理员将收到代开发应用已完成消息,可引导企业管理员先设置小范围的可见范围,进行应用使用,若无问题再设置更大可见范围。
img

与自建应用接口的差异#

代开发自建应用跟“企业内部开发”自建应用的接口调用方式大部分一致,主要以下几个差异点:

1.secret的获取#

不同于自建应用开发模式,secret由企业管理员登录管理端获取,代开发的自建应用secret获取方式如下:
(1)企业管理员扫代开发模版授权码时,授权完成后会推送授权成功通知到应用代开发模版回调url。
(2)收到回调后,开发者通过获取企业永久授权码接口获取到的permanent_code,即为代开发应用的secret。(注意:此种情况获取企业永久授权码接口会多返回is_customized_app字段,且值为true,表示是代开发模版授权,另外接口不返回access_token字段)。
注:
a. 应用代开发模版id即为suite_id。企业微信后台也会定期向应用代开发模版回调url推送suite_ticket
b. 可通过获取第三方应用凭证接口获取suite_access_token。
c. suite_access_token可用于获取企业永久授权码
d. 可调用获取企业授权信息(注意:此种情况接口会多返回is_customized_app字段,且值为true,表示是代开发模版授权)

2.secret的重置#

服务商可在服务商管理端的代开发应用详情页点击“重新获取”(见下图)来重置应用secret。点击“重新获取”后,企业微信后台会回调重置永久授权码通知。开发者收到回调事件后,可使用AuthCode通过获取企业永久授权码接口获取代开发应用最新的secret(即permanent_code字段)。
img

3.获取应用access_token#

有了代开发应用的secret之后,接口调用凭证access_token的获取方式就与自建应用完全一样了,调用的是获取access_token接口。注意,这与第三方应用的access_token获取方式不一样。

4.接口权限#

自建应用代开发的接口权限分为基础权限和自定义权限,具体可查看:代开发权限说明。
其中自定义权限,由服务商申请企业确认,或者企业在应用管理中主动配置后,企业侧不需要到企业管理后台去配置可调用应用。(例如客户联系相关权限,服务商勾选企业确认后,代开发应用即可调用,不需要再到企业管理后台客户联系配置可调用应用)。

5.设置应用#

针对代开发自建应用,不允许调用设置应用接口设置应用。

6.接口调用ip白名单#

针对代开发自建应用,若服务商在服务商管理端为应用配置了ip白名单,则接口只允许ip白名单内的ip发起请求。如果未配置ip白名单,则跟自建应用一致,允许任何ip发起请求。

7.通讯录变更回调#

企业通讯录变更时,企业微信后台会回调通讯录回调通知到代开发应用回调URL上。

8.授权变更回调#

修改代开发应用可见范围时,企业微信后台会回调变更授权通知到代开发模板回调URL上。

【企业微信】API开发者 微信交流群

用微信扫右侧二维码,加入【企业微信】API开发者 交流群,互助沟通

扫码加入交流群
上一页
成员授权应用
下一页
通讯录权限体系
Built with