提交审批申请
POST
/cgi-bin/oa/applyevent
服务端API第三方应用开发
接口频率限制 60次/分钟
当模板的控件为必填属性时,表单中对应的控件必须有值。
附录:各控件apply_data/contents/value参数介绍
{ "text": "文本填写的内容"}
参数 | 说明 |
---|---|
text | 文本内容,在此填写文本/多行文本控件的输入值 |
{ "new_number": "700"}
参数 | 说明 |
---|---|
new_number | 数字内容,在此填写数字控件的输入值 |
{ "new_money": "700"}
参数 | 说明 |
---|---|
new_money | 金额内容,在此填写金额控件的输入值 |
{ "date": { "type": "day", "s_timestamp": "1569859200" }}
参数 | 说明 |
---|---|
date | 日期/日期+时间内容 |
└ type | 时间展示类型:day-日期;hour-日期+时间 ,和对应模板控件属性一致 |
└ s_timestamp | 时间戳-字符串类型,在此填写日期/日期+时间控件的选择值,以此为准 |
{ "selector": { "type": "multi", "options": [ { "key": "option-15111111111", }, { "key": "option-15222222222", } ] }}
参数 | 说明 |
---|---|
selector | 选择控件内容,即申请人在此控件选择的选项内容 |
└ type | 选择方式:single-单选;multi-多选 |
└ options | 多选选项,多选属性的选择控件允许输入多个 |
└ └ key | 选项key,可通过“获取审批模板详情”接口获得 |
{ "members": [ { "userid": "WuJunJie", "name": "Jackie" }, { "userid": "WangXiaoMing" "name": "Tom" } ]}
参数 | 说明 |
---|---|
members | 所选成员内容,即申请人在此控件选择的成员,多选模式下可以有多个 |
└ userid | 所选成员的userid |
└ name | 成员名 |
{ "departments": [ { "openapi_id": "2", "name": "销售部", }, { "openapi_id": "3", "name": "生产部", } ]}
参数 | 说明 |
---|---|
departments | 所选部门内容,即申请人在此控件选择的部门,多选模式下可能有多个 |
└ openapi_id | 所选部门id |
└ name | 所选部门名 |
此控件不显示在审批详情中,故value为空
{ "files": [ { "file_id": "1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K1aaa" } ]}
参数 | 说明 |
---|---|
files | 附件列表 |
└ file_id | 文件id,该id为临时素材上传接口返回的的media_id,注:提单后将作为单据内容转换为长期文件存储;目前一个审批申请单,全局仅支持上传6个附件,否则将失败。 |
{ "children": [ { "list": [ { "control": "Text", "id": "Text-15111111111", "title": [ { "text": "明细内文本控件", "lang": "zh_CN" } ], "value": { "text": "明细文本" } } ] } ]}
参数 | 说明 |
---|---|
children | 明细内容,一个明细控件可能包含多个子明细 |
└ list | 子明细列表,在此填写子明细的所有子控件的值,子控件的数据结构同一般控件 |
{ "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-加班 |
{ "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 | 通用错误码,提交审批单内部接口失败 |
原文档地址:
https://open.work.weixin.qq.com/api/doc/90001/90143/92632
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://qyapi.weixin.qq.com/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"
}
]
}
]
}'
响应示例响应示例
{}
请求参数
Query 参数
access_token
调用接口凭证
示例值:
{{ACCESS_TOKEN}}
Body 参数application/json
返回响应
修改于 2022-01-14 04:25:48