Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
企业内部开发智慧硬件开发第三方应用开发
企业内部开发智慧硬件开发第三方应用开发
  1. 审批
  • 通讯录管理
    • 成员管理
      • 手机号获取userid
      • 获取成员授权列表
      • 查询成员用户是否已授权
      • 获取选人ticket对应的用户
    • 异步导出接口
      • 导出成员
      • 导出成员详情
      • 导出部门
      • 导出标签成员
      • 获取导出结果
    • 通讯录搜索
      • 通讯录搜索-通讯录单个搜索
      • 通讯录搜索-通讯录批量搜索
    • 通讯录ID转译
      • 上传需要转译的文件
      • 异步通讯录id转译
      • 获取异步任务结果
    • 通讯录userid排序
      POST
  • 客户联系
    • 企业服务人员管理
      • 获取配置了客户联系功能的成员列表
      • 客户联系「联系我」管理-更新企业已配置的「联系我」方式
      • 客户联系「联系我」管理-获取企业已配置的「联系我」方式
      • 客户联系「联系我」管理-删除企业已配置的「联系我」方式
      • 客户联系「联系我」管理-结束临时会话
    • 客户管理
      • 获取客户列表
      • 修改客户备注信息
      • 批量获取客户详情
      • 外部联系人unionid转换
      • 代开发应用external_userid转换
    • 客户标签管理
      • 管理企业标签
        • 管理企业标签-获取企业标签库
        • 管理企业标签-添加企业客户标签
        • 管理企业标签-编辑企业客户标签
        • 管理企业标签-删除企业客户标签
      • 编辑客户企业标签
    • 在职继承
      • 分配在职成员的客户
      • 查询客户接替状态
    • 离职继承
      • 获取待分配的离职成员列表
      • 分配离职成员的客户
      • 查询客户接替状态
      • 分配离职成员的客户群
    • 客户群管理
      • 获取客户群列表
      • 获取客户群详情
      • 客户群opengid转换
    • 客户朋友圈
      • 企业发表内容到客户的朋友圈
        • 企业发表内容到客户的朋友圈-创建发表任务
        • 企业发表内容到客户的朋友圈-获取任务创建结果
      • 获取客户朋友圈全部的发表记录
        • 获取客户朋友圈全部的发表记录-获取企业全部的发表列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈企业发表的列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表时选择的可见范围
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈发表后的可见客户列表
        • 获取客户朋友圈全部的发表记录-获取客户朋友圈的互动数据
    • 消息推送
      • 获取企业的全部群发记录
        • 获取企业的全部群发记录-获取群发记录列表
        • 获取企业的全部群发记录-获取群发成员发送任务列表
        • 获取企业的全部群发记录-获取企业群发成员执行结果
      • 创建企业群发
      • 发送新客户欢迎语
      • 入群欢迎语素材管理-添加
      • 入群欢迎语素材管理-编辑
      • 入群欢迎语素材管理-获取
      • 入群欢迎语素材管理-删除
    • 统计管理
      • 获取「群聊数据统计」数据-按群主聚合的方式
      • 获取「群聊数据统计」数据-按自然日聚合的方式
      • 获取「联系客户统计」数据
    • 管理商品图册
      • 创建商品图册
      • 获取商品图册
      • 删除商品图册
      • 获取商品图册列表
      • 编辑商品图册
    • 管理聊天敏感词
      • 管理聊天敏感词-新建敏感词规则
      • 管理聊天敏感词-获取敏感词规则列表
      • 管理聊天敏感词-获取敏感词规则详情
      • 管理聊天敏感词-修改敏感词规则
      • 管理聊天敏感词 删除敏感词规则
    • 上传附件资源
      POST
  • 家校沟通
    • 基础接口
      • 获取外部联系人详情
      • 发送「学校通知」
      • 获取「学校通知」二维码
      • 管理「学校通知」的关注模式-设置关注「学校通知」的模式
      • 管理「学校通知」的关注模式-获取关注「学校通知」的模式
      • 外部联系人openid转换
      • 获取可使用的家长范围
      • 手机号转外部联系人ID
      • 管理「老师可查看班级」模式-设置「老师可查看班级」的模式
      • 管理「老师可查看班级」模式-获取「老师可查看班级」的模式
    • 学生与家长管理
      • 创建学生
      • 删除学生
      • 更新学生
      • 批量创建学生
      • 批量删除学生
      • 批量更新学生
      • 创建家长
      • 删除家长
      • 更新家长
      • 批量创建家长
      • 批量删除家长
      • 批量更新家长
      • 读取学生或家长
      • 获取部门成员详情
      • 设置家校通讯录自动同步模式
      • 获取部门家长详情
    • 部门管理
      • 创建部门
      • 更新部门
      • 删除部门
      • 获取部门列表
      • 修改自动升年级的配置
  • 微信客服
    • 客服帐号管理
      • 添加客服帐号
      • 删除客服帐号
      • 修改客服帐号
      • 获取客服帐号列表
      • 获取客服帐号链接
    • 接待人员管理
      • 删除接待人员
      • 获取接待人员列表
    • 会话分配与消息收发
      • 分配客服会话
        • 分配客服会话-获取会话状态
        • 分配客服会话-变更会话状态
      • 接收消息和事件-读取消息
      • 发送消息
      • 发送欢迎语等事件响应消息
    • 「升级服务」配置
      • 「升级服务」配置-获取配置的专员与客户群
      • 「升级服务」配置-为客户升级为客户群服务
      • 「升级服务」配置-为客户取消推荐
    • 其他基础信息获取
      • 获取客户基础信息
      • 获取企业状态信息-获取视频号绑定状态
  • 应用管理
    • 设置工作台自定义展示
      • 设置工作台自定义展示-设置应用在工作台展示的模版
      • 设置工作台自定义展示-获取应用在工作台展示的模版
      • 设置工作台自定义展示-设置应用在用户工作台展示的数据
  • 消息推送
    • 撤回应用消息
  • OA
    • 打卡
      • 获取员工打卡规则
      • 获取打卡记录数据
      • 获取打卡日报数据
      • 获取打卡月报数据
      • 获取打卡人员排班信息
      • 为打卡人员排班
      • 获取设备打卡数据
    • 审批
      • 获取审批模板详情
        POST
      • 提交审批申请
        POST
      • 批量获取审批单号
        POST
      • 获取审批申请详情
        POST
      • 获取企业假期管理配置
        GET
      • 获取成员假期余额
        POST
      • 修改成员假期余额
        POST
      • 复制/更新模板到企业
        POST
  • 效率工具
    • 日程
      • 日历接口
        • 日历接口 创建日历
        • 日历接口 更新日历
        • 日历接口 获取日历详情
        • 日历接口 删除日历
      • 日程接口
        • 日程接口 创建日程
        • 日程接口更新日程
        • 日程接口 获取日程详情
        • 日程接口 取消日程
        • 日程接口 获取日历下的日程列表
    • 会议
      • 创建预约会议
      • 修改预约会议
      • 取消预约会议
      • 获取成员会议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/oa/applyevent
第三方应用开发/OA/审批
最后修改时间:2022-08-30 03:03:37
责任人:未设置
服务商可通过第三方应用Secret调用本接口,代应用可见范围内员工在企业微信“审批应用”内提交由此应用添加的审批类型对应的审批申请。
接口频率限制 60次/分钟
当模板的控件为必填属性时,表单中对应的控件必须有值。

附录:各控件apply_data/contents/value参数介绍#

附1 文本/多行文本控件(control参数为Text或Textarea)
{    "text": "文本填写的内容"}
参数说明
text文本内容,在此填写文本/多行文本控件的输入值
附2 数字控件(control参数为Number)
{    "new_number": "700"}
参数说明
new_number数字内容,在此填写数字控件的输入值
附3 金额控件(control参数为Money)
{    "new_money": "700"}
参数说明
new_money金额内容,在此填写金额控件的输入值
附4 日期/日期+时间控件(control参数为Date)
{    "date": {        "type": "day",        "s_timestamp": "1569859200"    }}
参数说明
date日期/日期+时间内容
└ type时间展示类型:day-日期;hour-日期+时间 ,和对应模板控件属性一致
└ s_timestamp时间戳-字符串类型,在此填写日期/日期+时间控件的选择值,以此为准
附5 单选/多选控件(control参数为Selector)
{    "selector": {        "type": "multi",        "options": [            {                "key": "option-15111111111",            },            {                "key": "option-15222222222",            }        ]    }}
参数说明
selector选择控件内容,即申请人在此控件选择的选项内容
└ type选择方式:single-单选;multi-多选
└ options多选选项,多选属性的选择控件允许输入多个
└ └ key选项key,可通过“获取审批模板详情”接口获得
附6 成员控件(control参数为Contact,且value参数为members)
{    "members": [        {            "userid": "WuJunJie",            "name": "Jackie"        },        {            "userid": "WangXiaoMing"            "name": "Tom"        }    ]}
参数说明
members所选成员内容,即申请人在此控件选择的成员,多选模式下可以有多个
└ userid所选成员的userid
└ name成员名
附7 部门控件(control参数为Contact,且value参数为departments)
{    "departments": [        {            "openapi_id": "2",            "name": "销售部",        },        {            "openapi_id": "3",            "name": "生产部",        }    ]}
参数说明
departments所选部门内容,即申请人在此控件选择的部门,多选模式下可能有多个
└ openapi_id所选部门id
└ name所选部门名
附8 说明文字控件(control参数为Tips)
此控件不显示在审批详情中,故value为空
附9 附件控件(control参数为File,且value参数为files)
{    "files": [        {            "file_id": "1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K1aaa"        }    ]}
参数说明
files附件列表
└ file_id文件id,该id为临时素材上传接口返回的的media_id,注:提单后将作为单据内容转换为长期文件存储;目前一个审批申请单,全局仅支持上传6个附件,否则将失败。
附10 明细控件(control参数为Table)
{    "children": [        {            "list": [                {                    "control": "Text",                    "id": "Text-15111111111",                    "title": [                        {                            "text": "明细内文本控件",                            "lang": "zh_CN"                        }                    ],                    "value": {                        "text": "明细文本"                    }                }            ]        }    ]}
参数说明
children明细内容,一个明细控件可能包含多个子明细
└ list子明细列表,在此填写子明细的所有子控件的值,子控件的数据结构同一般控件
附11 假勤组件-请假组件(control参数为Vacation)
{    "vacation": {        "selector": {            "type": "single",            "options": [                {                    "key": "3",                    "value": [                        {                            "text": "病假",                            "lang": "zh_CN"                        }                    ]                }            ],            "exp_type": 0        },        "attendance": {            "date_range": {                "type": "hour",                "new_begin": 1568077200,                "new_end": 1568368800,                "new_duration": 291600            },            "type": 1        }    }}
参数说明
vacation请假内容,即申请人在此组件内选择的请假信息
└ selector请假类型,所选选项与假期管理关联,为假期管理中的假期类型
└ └ type选择方式:single-单选;multi-多选,在假勤控件中固定为单选
└ └ options用户所选选项
└ └ └ key选项key,选项的唯一id,可通过“获取审批模板详情”接口获得vacation_list中item的id值
└ └ └ value选项值,若配置了多语言则会包含中英文的选项值
└ attendance假勤组件
└ └ date_range假勤组件时间选择范围
└ └ └ type时间展示类型:day-日期;hour-日期+时间
└ └ └ new_begin开始时间戳
└ └ └ new_end结束时间戳
└ └ └ new_duration请假时长,单位秒
└ └ type假勤组件类型:1-请假;3-出差;4-外出;5-加班
附12 假勤组件-出差/外出/加班组件(control参数为Attendance)
{    "attendance": {        "date_range": {            "type": "halfday",            "new_begin": 1570550400,            "new_end": 1570593600,            "new_duration": 86400        },        "type": 4    }}
参数说明
attendance假勤内容,即申请人在此组件内选择的假勤信息
└ date_range假勤组件时间选择范围
└ └ type时间展示类型:day-日期;hour-日期+时间
└ └ new_begin开始时间戳,
└ └ new_end结束时间戳
└ └ new_duration请假时长,单位秒
└ type假勤组件类型:1-请假;3-出差;4-外出;5-加班

错误说明#

错误码说明
301055无审批应用权限,或者提单者不在审批应用/自建应用的可见范围
301056审批应用已停用
301025提交审批单请求参数错误
301057通用错误码,提交审批单内部接口失败
文档ID: 20912
原文档地址:
https://open.work.weixin.qq.com/api/doc/90001/90143/92632

请求参数

Query 参数
access_token
string 
调用接口凭证
必需
示例值:
{{ACCESS_TOKEN}}
Body 参数application/json
approver
array [object {2}] 
必需
审批流程信息,用于指定审批申请的审批流程,支持单人审批、多人会签、多人或签,可能有多个审批节点,仅use_template_approver为0时生效。
attr
integer 
必需
节点审批方式:1-或签;2-会签,仅在节点为多人审批时有效
userid
array[string]
必需
审批节点审批人userid列表,若为多人会签、多人或签,需填写每个人的userid
notify_type
integer <int32>
可选
抄送方式:1-提单时抄送(默认值); 2-单据通过后抄送;3-提单和单据通过后抄送。仅use_template_approver为0时生效。
apply_data
object 
必需
审批申请数据,可定义审批申请中各个控件的值,其中必填项必须有值,选填项可为空,数据结构同“获取审批申请详情”接口返回值中同名参数“apply_data”
contents
array [object {4}] 
必需
审批申请详情,由多个表单控件及其内容组成,其中包含需要对控件赋值的信息
notifyer
array[string]
可选
抄送人节点userid列表,仅use_template_approver为0时生效。
creator_userid
string 
必需
申请人userid,此审批申请将以此员工身份提交,申请人需在应用可见范围内
template_id
string 
必需
模板的唯一标识id。可在“获取审批单据详情”、“审批状态变化回调通知”中获得,也可在使用“复制/更新模板到企业”接口回调中获得。注:此id为企业内模板的实例id,非服务商后台对应模板的id。暂不支持通过接口提交[打卡补卡][调班]模板审批单。
summary_list
array [object {1}] 
必需
摘要信息,用于显示在审批通知卡片、审批列表的摘要信息,最多3行
summary_info
array [object {2}] 
必需
摘要行信息,用于定义某一行摘要显示的内容
use_template_approver
integer <int32>
必需
审批人模式:0-通过接口指定审批人、抄送人(此时approver、notifyer等参数可用); 1-使用此模板在管理后台设置的审批流程,支持条件审批。
示例
{
  "creator_userid": "WangXiaoMing",
  "template_id": "3Tka1eD6v6JfzhDMqPd3aMkFdxqtJMc2ZRioeFXkaaa",
  "use_template_approver": 0,
  "approver": [
    {
      "attr": 2,
      "userid": [
        "WuJunJie",
        "WangXiaoMing"
      ]
    },
    {
      "attr": 1,
      "userid": [
        "LiuXiaoGang"
      ]
    }
  ],
  "notifyer": [
    "WuJunJie",
    "WangXiaoMing"
  ],
  "notify_type": 1,
  "apply_data": {
    "contents": [
      {
        "control": "Text",
        "id": "Text-15111111111",
        "title": [
          {
            "text": "文本控件",
            "lang": "zh_CN"
          }
        ],
        "value": {
          "text": "文本填写的内容"
        }
      }
    ]
  },
  "summary_list": [
    {
      "summary_info": [
        {
          "text": "摘要第1行",
          "lang": "zh_CN"
        }
      ]
    },
    {
      "summary_info": [
        {
          "text": "摘要第2行",
          "lang": "zh_CN"
        }
      ]
    },
    {
      "summary_info": [
        {
          "text": "摘要第3行",
          "lang": "zh_CN"
        }
      ]
    }
  ]
}

示例代码

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/oa/applyevent?access_token={{ACCESS_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "creator_userid": "WangXiaoMing",
    "template_id": "3Tka1eD6v6JfzhDMqPd3aMkFdxqtJMc2ZRioeFXkaaa",
    "use_template_approver": 0,
    "approver": [
        {
            "attr": 2,
            "userid": [
                "WuJunJie",
                "WangXiaoMing"
            ]
        },
        {
            "attr": 1,
            "userid": [
                "LiuXiaoGang"
            ]
        }
    ],
    "notifyer": [
        "WuJunJie",
        "WangXiaoMing"
    ],
    "notify_type": 1,
    "apply_data": {
        "contents": [
            {
                "control": "Text",
                "id": "Text-15111111111",
                "title": [
                    {
                        "text": "文本控件",
                        "lang": "zh_CN"
                    }
                ],
                "value": {
                    "text": "文本填写的内容"
                }
            }
        ]
    },
    "summary_list": [
        {
            "summary_info": [
                {
                    "text": "摘要第1行",
                    "lang": "zh_CN"
                }
            ]
        },
        {
            "summary_info": [
                {
                    "text": "摘要第2行",
                    "lang": "zh_CN"
                }
            ]
        },
        {
            "summary_info": [
                {
                    "text": "摘要第3行",
                    "lang": "zh_CN"
                }
            ]
        }
    ]
}'

返回响应

🟢200成功
application/json
Body
object {0}
示例
{}
上一页
获取审批模板详情
下一页
批量获取审批单号
Built with