新增钉钉待办任务
更新于 2024-01-11调用本接口发起一个待办任务。
待办任务1.0接口进行升级,请开发者优先使用待办任务接口。对于待办任务1.0接口文档,已于2021年10月14日移动至历史文档(不推荐),接口暂不会下线。
如果未接入1.0版接口,推荐使用新的创建钉钉待办任务接口。
如果已接入1.0版接口,建议您根据自身实际情况评估是否切换至新接口。
该待办任务会出现在钉钉客户端待办页面,与钉钉审批事项并列。
待办创建后,若两个小时内未处理,则两小时后会被计入已逾期。
待办功能如下图所示:

目前待办任务有防骚扰控制,具体为:
每人每天最多收到一条表单内容相同的待办。触发这个限制,会返回错误码400001。
每人每天最多收到100条待办。触发这个限制,会返回错误码400002。
权限
应用类型 | 是否支持调用 | 权限申请方式 | API Explorer调试 |
企业内部应用 | 是 | 重要 暂不支持新增申请。 | — |
第三方企业应用 | 是 | 重要 暂不支持新增申请。 | — |
第三方个人应用 | 否 | — | — |
基本信息
请求方式:POST
请求地址:https://oapi.dingtalk.com/topapi/workrecord/add
Query参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
access_token | String | 是 | 6d1bxxxx | 调用服务端API的应用凭证。
|
Body参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
userid | String | 是 | manager4220 | 任务的执行人userid。 |
create_time | Number | 是 | 1599580799000 | 待办时间,Unix时间戳。 说明 该参数只影响待办显示的先后顺序。 |
title | String | 是 | 新人学习 | 待办任务的标题,最多50个字符。 |
url | String | 是 | https://oa.dingtalk.com | 待办任务的跳转链接。当链接是某个微应用链接时,希望在PC端工作台打开,可通过消息链接在PC端侧边栏实现。 说明 待办跳转地址不支持跳转进入小程序。 |
pcUrl | String | 否 | https://oa.dingtalk.com | PC端跳转URL,不传则使用URL参数。 |
formItemList | FormItemVo[] | 是 | 表单列表。 | |
title | String | 是 | 标题 | 表单标题。 |
content | String | 是 | 内容 | 表单内容。 |
originator_user_id | String | 否 | manager7078 | 发起人的userid。 |
source_name | String | 否 | 人事 | 待办来源名称。该名称会显示在待办的“来源”位置。 |
pc_open_type | Number | 否 | 2 | 待办的PC打开方式:
|
biz_id | String | 否 | 11 | 外部业务ID,建议带上业务方来源字段,防止与其他业务方冲突。 |
返回参数
名称 | 类型 | 示例值 | 描述 |
errcode | Number | 0 | 返回码。 |
errmsg | String | 不合法的access_token | 调用接口失败时返回的错误信息。创建成功不会返回。 |
request_id | String | 7jtw2fl4kmlm | 请求ID。 |
record_id | String | recordbc83ea0f6aexxxx | 待办任务ID。 |
示例
请求示例(HTTP)
请求正文
请求示例(JAVA SDK)
返回示例
错误码
参数 | 说明 | 排查方法 |
33012 | 无效的userid | 请检查userid参数是否合法。 |
40035 | 参数不合法 |
|
400002 | 参数错误 | 请检查title或者content参数是否为空。 |
854001 | 待办任务重复 | 每人每天最多收到一条表单内容相同的待办,这里的表单内容,包括title和formItemList参数。还有一种情况,当传了biz_id参数时,每个用户的biz_id不能重复。 |
854002 | 待办任务超过每日限额 | 每人每天最多收到100条待办。 |